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. This documentation is intended for software developers and covers the Boss Insights API endpoints.

📚 Looking for an API overview? You'll find that at our Developer Documentation site.

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 x-api-status-urls: false x-konfig-ignore: object-with-no-properties: true potential-incorrect-type: true servers: - description: Example API Domain url: https://example.myintranetapps.com/api tags: - name: Account - name: BillPayment - name: Bill - name: CreditNote - name: Customer - name: Deal - name: Employee - name: Expense - name: Inventory - name: InvoiceItem - name: Lead - name: Location - name: Order - name: PaymentMethod - name: Payment - name: Payout - name: Product - name: Quote - name: RecurringCharge - name: RecurringExpense - name: Refund - name: RepeatingInvoice - name: Subscription - name: VendorCredit - name: VendorPayment - name: Vendor - name: Conversion - name: AccountingTransaction - name: Activity - name: ApplicationCharge - name: ApplicationCredit - name: Asset - name: BalanceHistory - name: BankAccount - name: BankOpeningBalance - name: BankReconciliation - name: BankSummary - name: BankTransaction - name: BankTransfer - name: BatchPayment - name: BlogPosting - name: Blog - name: BudgetSummary - name: Call - name: CampaignReport - name: Campaign - name: Charge - name: Client - name: Company - name: ContactGroup - name: Contract - name: CustomerOpeningBalance - name: Department - name: Engagement - name: Estimate - name: Event - name: ExecutiveSummary - name: FinancialMapping - name: FinancialPeriod - name: Form - name: GrowthHistory - name: Invoice - name: Item - name: JournalLine - name: Journal - name: LedgerAccountOpeningBalance - name: LedgerAccountType - name: LedgerAccounts - name: LedgerEntry - name: LinkedTransaction - name: ManualJournal - name: OrderReturn - name: Organization - name: OtherIncome - name: Owner - name: PaymentIntent - name: PaymentService - name: Plan - name: Project - name: ProxyRequest - name: PublishingChannel - name: PurchaseCreditNote - name: PurchaseOrder - name: Purchase - name: Report - name: Reservation - name: RevenueStat - name: SalesOrder - name: SiteEvent - name: Statement - name: SubscriberLocation - name: SupportTicket - name: Task - name: TaxAgency - name: TaxRate - name: Term - name: TrackingCategory - name: Transaction - name: UnbilledCharge - name: User - name: Workflow - name: AgedPayablesExcel - name: AgedPayablesReport - name: AgedReceivablesExcel - name: AgedReceivablesReport - name: BalanceSheetExcel - name: BalanceSheetReport - name: BalanceSheet - name: DataSync - name: FormData - name: IntegrationsList - name: Metrics - name: Payroll - name: ProfitAndLoss - name: ProfitAndLossExcel - name: ProfitAndLossReport - name: TransactionMatchReport - name: TransactionMatchSeries - name: TrialBalance paths: /accounting_transactions: parameters: [] get: tags: - AccountingTransaction summary: Retrieves a Collection of accounting transaction resources operationId: AccountingTransaction_getCollection description: Retrieves a Collection of accounting transaction resources parameters: - description: YYYY-MM-DD name: start in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-07-01' - description: YYYY-MM-DD name: end in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-08-31' - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: AccountingTransaction collection content: application/json: schema: $ref: >- #/components/schemas/AccountingTransactionGetCollectionResponse application/xml: schema: $ref: >- #/components/schemas/AccountingTransactionGetCollection200Response text/xml: schema: $ref: >- #/components/schemas/AccountingTransactionGetCollection200Response text/csv: schema: $ref: >- #/components/schemas/AccountingTransactionGetCollection200Response text/html: schema: $ref: >- #/components/schemas/AccountingTransactionGetCollection200Response deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/accounting_transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/accounting_transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/accounting_transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/accounting_transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/accounting_transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/accounting_transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/accounting_transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/accounting_transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/accounting_transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /accounting_transactions/{id}: parameters: [] get: tags: - AccountingTransaction summary: Retrieves a AccountingTransaction resource. operationId: AccountingTransaction_getResource description: Retrieves a AccountingTransaction resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: AccountingTransaction resource content: application/json: schema: $ref: '#/components/schemas/AccountingTransactionGetResourceResponse' application/xml: schema: $ref: >- #/components/schemas/AccountingTransactionGetResource200Response text/xml: schema: $ref: >- #/components/schemas/AccountingTransactionGetResource200Response text/csv: schema: $ref: >- #/components/schemas/AccountingTransactionGetResource200Response text/html: schema: $ref: >- #/components/schemas/AccountingTransactionGetResource200Response '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/accounting_transactions/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/accounting_transactions/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/accounting_transactions/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/accounting_transactions/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/accounting_transactions/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/accounting_transactions/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/accounting_transactions/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/accounting_transactions/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/accounting_transactions/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /accounts: parameters: [] get: tags: - Account summary: Retrieves the collection of Account resources. operationId: Account_getCollection description: Retrieves the collection of Account resources. parameters: [] responses: '200': description: Account collection content: application/json: schema: $ref: '#/components/schemas/AccountGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/AccountGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/AccountGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/AccountGetCollection200Response' text/html: schema: $ref: '#/components/schemas/AccountGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/accounts") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/accounts"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/accounts \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/accounts", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/accounts") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/accounts", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/accounts\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/accounts", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/accounts", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - Account summary: Creates a Account resource. operationId: Account_createResource description: Creates a Account resource. parameters: [] requestBody: description: The new Account resource content: application/json: schema: $ref: '#/components/schemas/AccountCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/AccountCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/AccountCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/AccountCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/AccountCreateResourceRequest4' required: true responses: '201': description: Account resource created content: application/json: schema: $ref: '#/components/schemas/AccountCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/AccountCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/AccountCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/AccountCreateResource201Response' text/html: schema: $ref: '#/components/schemas/AccountCreateResource201Response' links: GetAccountItem: operationId: getAccountItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /accounts/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"code\":\"400\",\"taxType\":\"TAX001\",\"bankAccountNumber\":\"823772-2828773-09826\",\"bankAccountType\":\"CREDITCARD\",\"currencyCode\":\"USD\",\"fullyQualifiedName\":\"Short Term Cash\",\"name\":\"Sandra's Bank Account\",\"classification\":\"Asset\",\"accountSubType\":\"BANK\",\"currentBalanceWithSubAccounts\":\"387687\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"accountType\":\"ASSET\",\"currentBalance\":\"29872\",\"active\":true,\"subAccount\":false,\"description\":\"This is the main company account for income and expenses\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"parentAccountId\":\"JS882-67283H-YW82KHX-2883KK-DJ3SK\",\"deleted\":false}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/accounts") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/accounts"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"code\":\"400\",\"taxType\":\"TAX001\",\"bankAccountNumber\":\"823772-2828773-09826\",\"bankAccountType\":\"CREDITCARD\",\"currencyCode\":\"USD\",\"fullyQualifiedName\":\"Short Term Cash\",\"name\":\"Sandra's Bank Account\",\"classification\":\"Asset\",\"accountSubType\":\"BANK\",\"currentBalanceWithSubAccounts\":\"387687\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"accountType\":\"ASSET\",\"currentBalance\":\"29872\",\"active\":true,\"subAccount\":false,\"description\":\"This is the main company account for income and expenses\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"parentAccountId\":\"JS882-67283H-YW82KHX-2883KK-DJ3SK\",\"deleted\":false}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/accounts \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","code":"400","taxType":"TAX001","bankAccountNumber":"823772-2828773-09826","bankAccountType":"CREDITCARD","currencyCode":"USD","fullyQualifiedName":"Short Term Cash","name":"Sandra'\''s Bank Account","classification":"Asset","accountSubType":"BANK","currentBalanceWithSubAccounts":"387687","created":"2021-06-24 22:35:07","modified":"2021-06-24 22:35:07","accountType":"ASSET","currentBalance":"29872","active":true,"subAccount":false,"description":"This is the main company account for income and expenses","srcId":"GH2JK-67283H-YW82KHX-2883KK-KS78S","parentAccountId":"JS882-67283H-YW82KHX-2883KK-DJ3SK","deleted":false}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/accounts", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"code\":\"400\",\"taxType\":\"TAX001\",\"bankAccountNumber\":\"823772-2828773-09826\",\"bankAccountType\":\"CREDITCARD\",\"currencyCode\":\"USD\",\"fullyQualifiedName\":\"Short Term Cash\",\"name\":\"Sandra's Bank Account\",\"classification\":\"Asset\",\"accountSubType\":\"BANK\",\"currentBalanceWithSubAccounts\":\"387687\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"accountType\":\"ASSET\",\"currentBalance\":\"29872\",\"active\":true,\"subAccount\":false,\"description\":\"This is the main company account for income and expenses\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"parentAccountId\":\"JS882-67283H-YW82KHX-2883KK-DJ3SK\",\"deleted\":false}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/accounts") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"code\":\"400\",\"taxType\":\"TAX001\",\"bankAccountNumber\":\"823772-2828773-09826\",\"bankAccountType\":\"CREDITCARD\",\"currencyCode\":\"USD\",\"fullyQualifiedName\":\"Short Term Cash\",\"name\":\"Sandra's Bank Account\",\"classification\":\"Asset\",\"accountSubType\":\"BANK\",\"currentBalanceWithSubAccounts\":\"387687\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"accountType\":\"ASSET\",\"currentBalance\":\"29872\",\"active\":true,\"subAccount\":false,\"description\":\"This is the main company account for income and expenses\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"parentAccountId\":\"JS882-67283H-YW82KHX-2883KK-DJ3SK\",\"deleted\":false}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"code\":\"400\",\"taxType\":\"TAX001\",\"bankAccountNumber\":\"823772-2828773-09826\",\"bankAccountType\":\"CREDITCARD\",\"currencyCode\":\"USD\",\"fullyQualifiedName\":\"Short Term Cash\",\"name\":\"Sandra's Bank Account\",\"classification\":\"Asset\",\"accountSubType\":\"BANK\",\"currentBalanceWithSubAccounts\":\"387687\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"accountType\":\"ASSET\",\"currentBalance\":\"29872\",\"active\":true,\"subAccount\":false,\"description\":\"This is the main company account for income and expenses\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"parentAccountId\":\"JS882-67283H-YW82KHX-2883KK-DJ3SK\",\"deleted\":false}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/accounts", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/accounts\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"code\\\":\\\"400\\\",\\\"taxType\\\":\\\"TAX001\\\",\\\"bankAccountNumber\\\":\\\"823772-2828773-09826\\\",\\\"bankAccountType\\\":\\\"CREDITCARD\\\",\\\"currencyCode\\\":\\\"USD\\\",\\\"fullyQualifiedName\\\":\\\"Short Term Cash\\\",\\\"name\\\":\\\"Sandra's Bank Account\\\",\\\"classification\\\":\\\"Asset\\\",\\\"accountSubType\\\":\\\"BANK\\\",\\\"currentBalanceWithSubAccounts\\\":\\\"387687\\\",\\\"created\\\":\\\"2021-06-24 22:35:07\\\",\\\"modified\\\":\\\"2021-06-24 22:35:07\\\",\\\"accountType\\\":\\\"ASSET\\\",\\\"currentBalance\\\":\\\"29872\\\",\\\"active\\\":true,\\\"subAccount\\\":false,\\\"description\\\":\\\"This is the main company account for income and expenses\\\",\\\"srcId\\\":\\\"GH2JK-67283H-YW82KHX-2883KK-KS78S\\\",\\\"parentAccountId\\\":\\\"JS882-67283H-YW82KHX-2883KK-DJ3SK\\\",\\\"deleted\\\":false}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/accounts", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"code\":\"400\",\"taxType\":\"TAX001\",\"bankAccountNumber\":\"823772-2828773-09826\",\"bankAccountType\":\"CREDITCARD\",\"currencyCode\":\"USD\",\"fullyQualifiedName\":\"Short Term Cash\",\"name\":\"Sandra's Bank Account\",\"classification\":\"Asset\",\"accountSubType\":\"BANK\",\"currentBalanceWithSubAccounts\":\"387687\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"accountType\":\"ASSET\",\"currentBalance\":\"29872\",\"active\":true,\"subAccount\":false,\"description\":\"This is the main company account for income and expenses\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"parentAccountId\":\"JS882-67283H-YW82KHX-2883KK-DJ3SK\",\"deleted\":false}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/accounts", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', code: '400', taxType: 'TAX001', bankAccountNumber: '823772-2828773-09826', bankAccountType: 'CREDITCARD', currencyCode: 'USD', fullyQualifiedName: 'Short Term Cash', name: 'Sandra\'s Bank Account', classification: 'Asset', accountSubType: 'BANK', currentBalanceWithSubAccounts: '387687', created: '2021-06-24 22:35:07', modified: '2021-06-24 22:35:07', accountType: 'ASSET', currentBalance: '29872', active: true, subAccount: false, description: 'This is the main company account for income and expenses', srcId: 'GH2JK-67283H-YW82KHX-2883KK-KS78S', parentAccountId: 'JS882-67283H-YW82KHX-2883KK-DJ3SK', deleted: false })); req.end(); /accounts/{id}: parameters: [] get: tags: - Account summary: Retrieves a Account resource. operationId: Account_getResource description: Retrieves a Account resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Account resource content: application/json: schema: $ref: '#/components/schemas/AccountGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/AccountGetResource200Response' text/xml: schema: $ref: '#/components/schemas/AccountGetResource200Response' text/csv: schema: $ref: '#/components/schemas/AccountGetResource200Response' text/html: schema: $ref: '#/components/schemas/AccountGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/accounts/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/accounts/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/accounts/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/accounts/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/accounts/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/accounts/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/accounts/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/accounts/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/accounts/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - Account summary: Replaces the Account resource. operationId: Account_replaceResource description: Replaces the Account resource. parameters: - description: Resource identifier name: id in: path 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/AccountReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/AccountReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/AccountReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/AccountReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/AccountReplaceResourceRequest4' required: true responses: '200': description: Account resource updated content: application/json: schema: $ref: '#/components/schemas/AccountReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/AccountReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/AccountReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/AccountReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/AccountReplaceResource200Response' links: GetAccountItem: operationId: getAccountItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /accounts/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"code\":\"400\",\"taxType\":\"TAX001\",\"bankAccountNumber\":\"823772-2828773-09826\",\"bankAccountType\":\"CREDITCARD\",\"currencyCode\":\"USD\",\"fullyQualifiedName\":\"Short Term Cash\",\"name\":\"Sandra's Bank Account\",\"classification\":\"Asset\",\"accountSubType\":\"BANK\",\"currentBalanceWithSubAccounts\":\"387687\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"accountType\":\"ASSET\",\"currentBalance\":\"29872\",\"active\":true,\"subAccount\":false,\"description\":\"This is the main company account for income and expenses\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"parentAccountId\":\"JS882-67283H-YW82KHX-2883KK-DJ3SK\",\"deleted\":false}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/accounts/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/accounts/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"code\":\"400\",\"taxType\":\"TAX001\",\"bankAccountNumber\":\"823772-2828773-09826\",\"bankAccountType\":\"CREDITCARD\",\"currencyCode\":\"USD\",\"fullyQualifiedName\":\"Short Term Cash\",\"name\":\"Sandra's Bank Account\",\"classification\":\"Asset\",\"accountSubType\":\"BANK\",\"currentBalanceWithSubAccounts\":\"387687\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"accountType\":\"ASSET\",\"currentBalance\":\"29872\",\"active\":true,\"subAccount\":false,\"description\":\"This is the main company account for income and expenses\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"parentAccountId\":\"JS882-67283H-YW82KHX-2883KK-DJ3SK\",\"deleted\":false}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/accounts/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","code":"400","taxType":"TAX001","bankAccountNumber":"823772-2828773-09826","bankAccountType":"CREDITCARD","currencyCode":"USD","fullyQualifiedName":"Short Term Cash","name":"Sandra'\''s Bank Account","classification":"Asset","accountSubType":"BANK","currentBalanceWithSubAccounts":"387687","created":"2021-06-24 22:35:07","modified":"2021-06-24 22:35:07","accountType":"ASSET","currentBalance":"29872","active":true,"subAccount":false,"description":"This is the main company account for income and expenses","srcId":"GH2JK-67283H-YW82KHX-2883KK-KS78S","parentAccountId":"JS882-67283H-YW82KHX-2883KK-DJ3SK","deleted":false}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/accounts/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"code\":\"400\",\"taxType\":\"TAX001\",\"bankAccountNumber\":\"823772-2828773-09826\",\"bankAccountType\":\"CREDITCARD\",\"currencyCode\":\"USD\",\"fullyQualifiedName\":\"Short Term Cash\",\"name\":\"Sandra's Bank Account\",\"classification\":\"Asset\",\"accountSubType\":\"BANK\",\"currentBalanceWithSubAccounts\":\"387687\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"accountType\":\"ASSET\",\"currentBalance\":\"29872\",\"active\":true,\"subAccount\":false,\"description\":\"This is the main company account for income and expenses\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"parentAccountId\":\"JS882-67283H-YW82KHX-2883KK-DJ3SK\",\"deleted\":false}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/accounts/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"code\":\"400\",\"taxType\":\"TAX001\",\"bankAccountNumber\":\"823772-2828773-09826\",\"bankAccountType\":\"CREDITCARD\",\"currencyCode\":\"USD\",\"fullyQualifiedName\":\"Short Term Cash\",\"name\":\"Sandra's Bank Account\",\"classification\":\"Asset\",\"accountSubType\":\"BANK\",\"currentBalanceWithSubAccounts\":\"387687\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"accountType\":\"ASSET\",\"currentBalance\":\"29872\",\"active\":true,\"subAccount\":false,\"description\":\"This is the main company account for income and expenses\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"parentAccountId\":\"JS882-67283H-YW82KHX-2883KK-DJ3SK\",\"deleted\":false}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"code\":\"400\",\"taxType\":\"TAX001\",\"bankAccountNumber\":\"823772-2828773-09826\",\"bankAccountType\":\"CREDITCARD\",\"currencyCode\":\"USD\",\"fullyQualifiedName\":\"Short Term Cash\",\"name\":\"Sandra's Bank Account\",\"classification\":\"Asset\",\"accountSubType\":\"BANK\",\"currentBalanceWithSubAccounts\":\"387687\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"accountType\":\"ASSET\",\"currentBalance\":\"29872\",\"active\":true,\"subAccount\":false,\"description\":\"This is the main company account for income and expenses\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"parentAccountId\":\"JS882-67283H-YW82KHX-2883KK-DJ3SK\",\"deleted\":false}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/accounts/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/accounts/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"code\\\":\\\"400\\\",\\\"taxType\\\":\\\"TAX001\\\",\\\"bankAccountNumber\\\":\\\"823772-2828773-09826\\\",\\\"bankAccountType\\\":\\\"CREDITCARD\\\",\\\"currencyCode\\\":\\\"USD\\\",\\\"fullyQualifiedName\\\":\\\"Short Term Cash\\\",\\\"name\\\":\\\"Sandra's Bank Account\\\",\\\"classification\\\":\\\"Asset\\\",\\\"accountSubType\\\":\\\"BANK\\\",\\\"currentBalanceWithSubAccounts\\\":\\\"387687\\\",\\\"created\\\":\\\"2021-06-24 22:35:07\\\",\\\"modified\\\":\\\"2021-06-24 22:35:07\\\",\\\"accountType\\\":\\\"ASSET\\\",\\\"currentBalance\\\":\\\"29872\\\",\\\"active\\\":true,\\\"subAccount\\\":false,\\\"description\\\":\\\"This is the main company account for income and expenses\\\",\\\"srcId\\\":\\\"GH2JK-67283H-YW82KHX-2883KK-KS78S\\\",\\\"parentAccountId\\\":\\\"JS882-67283H-YW82KHX-2883KK-DJ3SK\\\",\\\"deleted\\\":false}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/accounts/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"code\":\"400\",\"taxType\":\"TAX001\",\"bankAccountNumber\":\"823772-2828773-09826\",\"bankAccountType\":\"CREDITCARD\",\"currencyCode\":\"USD\",\"fullyQualifiedName\":\"Short Term Cash\",\"name\":\"Sandra's Bank Account\",\"classification\":\"Asset\",\"accountSubType\":\"BANK\",\"currentBalanceWithSubAccounts\":\"387687\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"accountType\":\"ASSET\",\"currentBalance\":\"29872\",\"active\":true,\"subAccount\":false,\"description\":\"This is the main company account for income and expenses\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"parentAccountId\":\"JS882-67283H-YW82KHX-2883KK-DJ3SK\",\"deleted\":false}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/accounts/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', code: '400', taxType: 'TAX001', bankAccountNumber: '823772-2828773-09826', bankAccountType: 'CREDITCARD', currencyCode: 'USD', fullyQualifiedName: 'Short Term Cash', name: 'Sandra\'s Bank Account', classification: 'Asset', accountSubType: 'BANK', currentBalanceWithSubAccounts: '387687', created: '2021-06-24 22:35:07', modified: '2021-06-24 22:35:07', accountType: 'ASSET', currentBalance: '29872', active: true, subAccount: false, description: 'This is the main company account for income and expenses', srcId: 'GH2JK-67283H-YW82KHX-2883KK-KS78S', parentAccountId: 'JS882-67283H-YW82KHX-2883KK-DJ3SK', deleted: false })); req.end(); delete: tags: - Account summary: Removes the Account resource. operationId: Account_removeResource description: Removes the Account resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: Account resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/accounts/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/accounts/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/accounts/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/accounts/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/accounts/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/accounts/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/accounts/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/accounts/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/accounts/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /activities: parameters: [] get: tags: - Activity summary: Retrieves the collection of Activity resources. operationId: Activity_getCollection description: Retrieves the collection of Activity resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Activity collection content: application/json: schema: $ref: '#/components/schemas/ActivityGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/ActivityGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/ActivityGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/ActivityGetCollection200Response' text/html: schema: $ref: '#/components/schemas/ActivityGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/activities?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/activities?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/activities?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/activities?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/activities?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/activities?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/activities?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/activities?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/activities?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /activities/{id}: parameters: [] get: tags: - Activity summary: Retrieves a Activity resource. operationId: Activity_getResource description: Retrieves a Activity resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Activity resource content: application/json: schema: $ref: '#/components/schemas/ActivityGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/ActivityGetResource200Response' text/xml: schema: $ref: '#/components/schemas/ActivityGetResource200Response' text/csv: schema: $ref: '#/components/schemas/ActivityGetResource200Response' text/html: schema: $ref: '#/components/schemas/ActivityGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/activities/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/activities/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/activities/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/activities/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/activities/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/activities/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/activities/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/activities/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/activities/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /aged_payables_excel: parameters: [] get: tags: - AgedPayablesExcel summary: Retrieves an excel workbook of an aged payables report operationId: AgedPayablesExcel_getWorkbook description: Retrieves a AgedPayablesExcel resource. parameters: - description: YYYY-MM-DD name: asOf in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-08-31' - description: >- If refresh is set, data will be fetched from the source application even when cached data is available name: refresh in: query required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false example: 'true' - description: >- Vendors can be sorted by total amount in ascending or descending order, or alphabetically. Default is alphabetical. name: sort in: query required: false deprecated: false allowEmptyValue: false schema: type: string enum: - descending - ascending - alphabetical style: form explode: false allowReserved: false example: descending responses: '200': description: AgedPayablesExcel resource content: application/json: schema: $ref: '#/components/schemas/AgedPayablesExcelGetWorkbookResponse' application/xml: schema: $ref: '#/components/schemas/AgedPayablesExcelGetWorkbook200Response' text/xml: schema: $ref: '#/components/schemas/AgedPayablesExcelGetWorkbook200Response' text/csv: schema: $ref: '#/components/schemas/AgedPayablesExcelGetWorkbook200Response' text/html: schema: $ref: '#/components/schemas/AgedPayablesExcelGetWorkbook200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/aged_payables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/aged_payables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/aged_payables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/aged_payables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/aged_payables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/aged_payables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/aged_payables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/aged_payables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/aged_payables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /aged_payables_report: parameters: [] get: tags: - AgedPayablesReport summary: Retrieves an aged payables report operationId: AgedPayablesReport_getReport description: Retrieves a AgedPayablesReport resource. parameters: - description: YYYY-MM-DD name: asOf in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-08-31' - description: >- If refresh is set, data will be fetched from the source application even when cached data is available name: refresh in: query required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false example: 'true' - description: >- Vendors can be sorted by total amount in ascending or descending order, or alphabetically. Default is alphabetical. name: sort in: query required: false deprecated: false allowEmptyValue: false schema: type: string enum: - descending - ascending - alphabetical style: form explode: false allowReserved: false example: descending responses: '200': description: AgedPayablesReport resource content: application/json: schema: $ref: '#/components/schemas/AgedPayablesReportGetReportResponse' application/xml: schema: $ref: '#/components/schemas/AgedPayablesReportGetReport200Response' text/xml: schema: $ref: '#/components/schemas/AgedPayablesReportGetReport200Response' text/csv: schema: $ref: '#/components/schemas/AgedPayablesReportGetReport200Response' text/html: schema: $ref: '#/components/schemas/AgedPayablesReportGetReport200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/aged_payables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/aged_payables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/aged_payables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/aged_payables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/aged_payables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/aged_payables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/aged_payables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/aged_payables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/aged_payables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /aged_receivables_excel: parameters: [] get: tags: - AgedReceivablesExcel summary: Retrieves an excel workbook of an aged receivables report operationId: AgedReceivablesExcel_getWorkbook description: Retrieves a AgedReceivablesExcel resource. parameters: - description: YYYY-MM-DD name: asOf in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-08-31' - description: >- If refresh is set, data will be fetched from the source application even when cached data is available name: refresh in: query required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false example: 'true' - description: >- Customers can be sorted by total amount in ascending or descending order, or alphabetically. Default is alphabetical. name: sort in: query required: false deprecated: false allowEmptyValue: false schema: type: string enum: - descending - ascending - alphabetical style: form explode: false allowReserved: false example: descending responses: '200': description: AgedReceivablesExcel resource content: application/json: schema: $ref: '#/components/schemas/AgedReceivablesExcelGetWorkbookResponse' application/xml: schema: $ref: >- #/components/schemas/AgedReceivablesExcelGetWorkbook200Response text/xml: schema: $ref: >- #/components/schemas/AgedReceivablesExcelGetWorkbook200Response text/csv: schema: $ref: >- #/components/schemas/AgedReceivablesExcelGetWorkbook200Response text/html: schema: $ref: >- #/components/schemas/AgedReceivablesExcelGetWorkbook200Response '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/aged_receivables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/aged_receivables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/aged_receivables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/aged_receivables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/aged_receivables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/aged_receivables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/aged_receivables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/aged_receivables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/aged_receivables_excel?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /aged_receivables_report: parameters: [] get: tags: - AgedReceivablesReport summary: Retrieves an aged receivables report operationId: AgedReceivablesReport_getResource description: Retrieves a AgedReceivablesReport resource. parameters: - description: YYYY-MM-DD name: asOf in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-08-31' - description: >- If refresh is set, data will be fetched from the source application even when cached data is available name: refresh in: query required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false example: 'true' - description: >- Can be sorted by total amount in ascending or descending order, or alphabetically. Default is alphabetical. name: sort in: query required: false deprecated: false allowEmptyValue: false schema: type: string enum: - descending - ascending - alphabetical style: form explode: false allowReserved: false example: descending responses: '200': description: AgedReceivablesReport resource content: application/json: schema: $ref: '#/components/schemas/AgedReceivablesReportGetResourceResponse' application/xml: schema: $ref: >- #/components/schemas/AgedReceivablesReportGetResource200Response text/xml: schema: $ref: >- #/components/schemas/AgedReceivablesReportGetResource200Response text/csv: schema: $ref: >- #/components/schemas/AgedReceivablesReportGetResource200Response text/html: schema: $ref: >- #/components/schemas/AgedReceivablesReportGetResource200Response '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/aged_receivables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/aged_receivables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/aged_receivables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/aged_receivables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/aged_receivables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/aged_receivables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/aged_receivables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/aged_receivables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/aged_receivables_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE&sort=SOME_STRING_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /application_charges: parameters: [] get: tags: - ApplicationCharge summary: Retrieves the collection of ApplicationCharge resources. operationId: ApplicationCharge_getCollection description: Retrieves the collection of ApplicationCharge resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: ApplicationCharge collection content: application/json: schema: $ref: '#/components/schemas/ApplicationChargeGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/ApplicationChargeGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/ApplicationChargeGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/ApplicationChargeGetCollection200Response' text/html: schema: $ref: '#/components/schemas/ApplicationChargeGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/application_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/application_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/application_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/application_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/application_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/application_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/application_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/application_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/application_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /application_charges/{id}: parameters: [] get: tags: - ApplicationCharge summary: Retrieves a ApplicationCharge resource. operationId: ApplicationCharge_getResource description: Retrieves a ApplicationCharge resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: ApplicationCharge resource content: application/json: schema: $ref: '#/components/schemas/ApplicationChargeGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/ApplicationChargeGetResource200Response' text/xml: schema: $ref: '#/components/schemas/ApplicationChargeGetResource200Response' text/csv: schema: $ref: '#/components/schemas/ApplicationChargeGetResource200Response' text/html: schema: $ref: '#/components/schemas/ApplicationChargeGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/application_charges/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/application_charges/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/application_charges/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/application_charges/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/application_charges/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/application_charges/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/application_charges/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/application_charges/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/application_charges/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /application_credits: parameters: [] get: tags: - ApplicationCredit summary: Retrieves the collection of ApplicationCredit resources. operationId: ApplicationCredit_getCollection description: Retrieves the collection of ApplicationCredit resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: ApplicationCredit collection content: application/json: schema: $ref: '#/components/schemas/ApplicationCreditGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/ApplicationCreditGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/ApplicationCreditGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/ApplicationCreditGetCollection200Response' text/html: schema: $ref: '#/components/schemas/ApplicationCreditGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/application_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/application_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/application_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/application_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/application_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/application_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/application_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/application_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/application_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /application_credits/{id}: parameters: [] get: tags: - ApplicationCredit summary: Retrieves a ApplicationCredit resource. operationId: ApplicationCredit_getResource description: Retrieves a ApplicationCredit resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: ApplicationCredit resource content: application/json: schema: $ref: '#/components/schemas/ApplicationCreditGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/ApplicationCreditGetResource200Response' text/xml: schema: $ref: '#/components/schemas/ApplicationCreditGetResource200Response' text/csv: schema: $ref: '#/components/schemas/ApplicationCreditGetResource200Response' text/html: schema: $ref: '#/components/schemas/ApplicationCreditGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/application_credits/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/application_credits/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/application_credits/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/application_credits/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/application_credits/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/application_credits/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/application_credits/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/application_credits/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/application_credits/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /assets: parameters: [] get: tags: - Asset summary: Retrieves the collection of Asset resources. operationId: Asset_getCollection description: Retrieves the collection of Asset resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Asset collection content: application/json: schema: $ref: '#/components/schemas/AssetGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/AssetGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/AssetGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/AssetGetCollection200Response' text/html: schema: $ref: '#/components/schemas/AssetGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/assets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/assets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/assets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/assets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/assets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/assets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/assets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/assets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/assets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /assets/{id}: parameters: [] get: tags: - Asset summary: Retrieves a Asset resource. operationId: Asset_getResource description: Retrieves a Asset resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Asset resource content: application/json: schema: $ref: '#/components/schemas/AssetGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/AssetGetResource200Response' text/xml: schema: $ref: '#/components/schemas/AssetGetResource200Response' text/csv: schema: $ref: '#/components/schemas/AssetGetResource200Response' text/html: schema: $ref: '#/components/schemas/AssetGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/assets/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/assets/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/assets/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/assets/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/assets/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/assets/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/assets/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/assets/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/assets/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /balance_histories: parameters: [] get: tags: - BalanceHistory summary: Retrieves the collection of BalanceHistory resources. operationId: BalanceHistory_getCollection description: Retrieves the collection of BalanceHistory resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: BalanceHistory collection content: application/json: schema: $ref: '#/components/schemas/BalanceHistoryGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/BalanceHistoryGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/BalanceHistoryGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/BalanceHistoryGetCollection200Response' text/html: schema: $ref: '#/components/schemas/BalanceHistoryGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/balance_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/balance_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/balance_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/balance_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/balance_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/balance_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/balance_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/balance_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/balance_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /balance_histories/{id}: parameters: [] get: tags: - BalanceHistory summary: Retrieves a BalanceHistory resource. operationId: BalanceHistory_getResource description: Retrieves a BalanceHistory resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: BalanceHistory resource content: application/json: schema: $ref: '#/components/schemas/BalanceHistoryGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/BalanceHistoryGetResource200Response' text/xml: schema: $ref: '#/components/schemas/BalanceHistoryGetResource200Response' text/csv: schema: $ref: '#/components/schemas/BalanceHistoryGetResource200Response' text/html: schema: $ref: '#/components/schemas/BalanceHistoryGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/balance_histories/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/balance_histories/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/balance_histories/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/balance_histories/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/balance_histories/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/balance_histories/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/balance_histories/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/balance_histories/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/balance_histories/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /balance_sheet_excel: parameters: [] get: tags: - BalanceSheetExcel summary: Retrieves an excel workbook of a series of mapped balance sheets operationId: BalanceSheetExcel_getWorkbook description: Retrieves an excel workbook of a series of mapped balance sheets parameters: - description: YYYY-MM-DD name: start in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-07-01' - description: YYYY-MM-DD name: end in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-08-31' - description: >- If refresh is set, data will be fetched from the source application even when cached data is available name: refresh in: query required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false example: 'true' responses: '200': description: BalanceSheetExcel resource content: application/json: schema: $ref: '#/components/schemas/BalanceSheetExcelGetWorkbookResponse' application/xml: schema: $ref: '#/components/schemas/BalanceSheetExcelGetWorkbook200Response' text/xml: schema: $ref: '#/components/schemas/BalanceSheetExcelGetWorkbook200Response' text/csv: schema: $ref: '#/components/schemas/BalanceSheetExcelGetWorkbook200Response' text/html: schema: $ref: '#/components/schemas/BalanceSheetExcelGetWorkbook200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/balance_sheet_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/balance_sheet_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/balance_sheet_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/balance_sheet_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/balance_sheet_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/balance_sheet_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/balance_sheet_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/balance_sheet_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/balance_sheet_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /balance_sheet_report: parameters: [] get: tags: - BalanceSheetReport summary: Retrieves a mapped balance sheet operationId: BalanceSheetReport_getMappedReport description: Retrieves a mapped balance sheet parameters: - description: YYYY-MM-DD name: asOf in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-08-31' - description: >- If refresh is set, data will be fetched from the source application even when cached data is available name: refresh in: query required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false example: 'true' responses: '200': description: BalanceSheetReport resource content: application/json: schema: $ref: '#/components/schemas/BalanceSheetReportGetMappedReportResponse' application/xml: schema: $ref: >- #/components/schemas/BalanceSheetReportGetMappedReport200Response text/xml: schema: $ref: >- #/components/schemas/BalanceSheetReportGetMappedReport200Response text/csv: schema: $ref: >- #/components/schemas/BalanceSheetReportGetMappedReport200Response text/html: schema: $ref: >- #/components/schemas/BalanceSheetReportGetMappedReport200Response '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/balance_sheet_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/balance_sheet_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/balance_sheet_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/balance_sheet_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/balance_sheet_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/balance_sheet_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/balance_sheet_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/balance_sheet_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/balance_sheet_report?asOf=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /balance_sheets: parameters: [] get: tags: - BalanceSheet summary: Retrieves a BalanceSheet resource. operationId: BalanceSheet_getResource description: Retrieves a BalanceSheet resource. parameters: - description: YYYY-MM-DD name: end in: query required: true deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-11-30' - description: The Accounting Method name: accounting_method in: query required: true deprecated: false allowEmptyValue: false schema: type: string enum: - cash - accrual style: form explode: false allowReserved: false example: accrual responses: '200': description: BalanceSheet resource content: application/json: schema: $ref: '#/components/schemas/BalanceSheetGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/BalanceSheetGetResource200Response' text/xml: schema: $ref: '#/components/schemas/BalanceSheetGetResource200Response' text/csv: schema: $ref: '#/components/schemas/BalanceSheetGetResource200Response' text/html: schema: $ref: '#/components/schemas/BalanceSheetGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/balance_sheets?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/balance_sheets?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/balance_sheets?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/balance_sheets?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/balance_sheets?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/balance_sheets?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/balance_sheets?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/balance_sheets?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/balance_sheets?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /bank_accounts: parameters: [] get: tags: - BankAccount summary: Retrieves the collection of BankAccount resources. operationId: BankAccount_listResources description: Retrieves the collection of BankAccount resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: BankAccount collection content: application/json: schema: $ref: '#/components/schemas/BankAccountListResourcesResponse' application/xml: schema: $ref: '#/components/schemas/BankAccountListResources200Response' text/xml: schema: $ref: '#/components/schemas/BankAccountListResources200Response' text/csv: schema: $ref: '#/components/schemas/BankAccountListResources200Response' text/html: schema: $ref: '#/components/schemas/BankAccountListResources200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bank_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bank_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/bank_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bank_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bank_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/bank_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bank_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bank_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bank_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /bank_accounts/{id}: parameters: [] get: tags: - BankAccount summary: Retrieves a BankAccount resource. operationId: BankAccount_getResource description: Retrieves a BankAccount resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: BankAccount resource content: application/json: schema: $ref: '#/components/schemas/BankAccountGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/BankAccountGetResource200Response' text/xml: schema: $ref: '#/components/schemas/BankAccountGetResource200Response' text/csv: schema: $ref: '#/components/schemas/BankAccountGetResource200Response' text/html: schema: $ref: '#/components/schemas/BankAccountGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bank_accounts/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bank_accounts/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/bank_accounts/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bank_accounts/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bank_accounts/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/bank_accounts/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bank_accounts/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bank_accounts/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bank_accounts/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /bank_opening_balances: parameters: [] get: tags: - BankOpeningBalance summary: Retrieves the collection of BankOpeningBalance resources. operationId: BankOpeningBalance_getCollection description: Retrieves the collection of BankOpeningBalance resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: BankOpeningBalance collection content: application/json: schema: $ref: '#/components/schemas/BankOpeningBalanceGetCollectionResponse' application/xml: schema: $ref: >- #/components/schemas/BankOpeningBalanceGetCollection200Response text/xml: schema: $ref: >- #/components/schemas/BankOpeningBalanceGetCollection200Response text/csv: schema: $ref: >- #/components/schemas/BankOpeningBalanceGetCollection200Response text/html: schema: $ref: >- #/components/schemas/BankOpeningBalanceGetCollection200Response deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bank_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bank_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/bank_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bank_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bank_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/bank_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bank_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bank_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bank_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /bank_opening_balances/{id}: parameters: [] get: tags: - BankOpeningBalance summary: Retrieves a BankOpeningBalance resource. operationId: BankOpeningBalance_getResource description: Retrieves a BankOpeningBalance resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: BankOpeningBalance resource content: application/json: schema: $ref: '#/components/schemas/BankOpeningBalanceGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/BankOpeningBalanceGetResource200Response' text/xml: schema: $ref: '#/components/schemas/BankOpeningBalanceGetResource200Response' text/csv: schema: $ref: '#/components/schemas/BankOpeningBalanceGetResource200Response' text/html: schema: $ref: '#/components/schemas/BankOpeningBalanceGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bank_opening_balances/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bank_opening_balances/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/bank_opening_balances/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bank_opening_balances/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bank_opening_balances/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/bank_opening_balances/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bank_opening_balances/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bank_opening_balances/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bank_opening_balances/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /bank_reconciliations: parameters: [] get: tags: - BankReconciliation summary: Retrieves the collection of BankReconciliation resources. operationId: BankReconciliation_getCollection description: Retrieves the collection of BankReconciliation resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: BankReconciliation collection content: application/json: schema: $ref: '#/components/schemas/BankReconciliationGetCollectionResponse' application/xml: schema: $ref: >- #/components/schemas/BankReconciliationGetCollection200Response text/xml: schema: $ref: >- #/components/schemas/BankReconciliationGetCollection200Response text/csv: schema: $ref: >- #/components/schemas/BankReconciliationGetCollection200Response text/html: schema: $ref: >- #/components/schemas/BankReconciliationGetCollection200Response deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bank_reconciliations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bank_reconciliations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/bank_reconciliations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bank_reconciliations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bank_reconciliations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/bank_reconciliations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bank_reconciliations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bank_reconciliations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bank_reconciliations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /bank_reconciliations/{id}: parameters: [] get: tags: - BankReconciliation summary: Retrieves a BankReconciliation resource. operationId: BankReconciliation_getResource description: Retrieves a BankReconciliation resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: BankReconciliation resource content: application/json: schema: $ref: '#/components/schemas/BankReconciliationGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/BankReconciliationGetResource200Response' text/xml: schema: $ref: '#/components/schemas/BankReconciliationGetResource200Response' text/csv: schema: $ref: '#/components/schemas/BankReconciliationGetResource200Response' text/html: schema: $ref: '#/components/schemas/BankReconciliationGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bank_reconciliations/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bank_reconciliations/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/bank_reconciliations/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bank_reconciliations/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bank_reconciliations/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/bank_reconciliations/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bank_reconciliations/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bank_reconciliations/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bank_reconciliations/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /bank_summaries: parameters: [] get: tags: - BankSummary summary: Retrieves the collection of BankSummary resources. operationId: BankSummary_getCollection description: Retrieves the collection of BankSummary resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: BankSummary collection content: application/json: schema: $ref: '#/components/schemas/BankSummaryGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/BankSummaryGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/BankSummaryGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/BankSummaryGetCollection200Response' text/html: schema: $ref: '#/components/schemas/BankSummaryGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bank_summaries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bank_summaries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/bank_summaries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bank_summaries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bank_summaries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/bank_summaries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bank_summaries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bank_summaries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bank_summaries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /bank_summaries/{id}: parameters: [] get: tags: - BankSummary summary: Retrieves a BankSummary resource. operationId: BankSummary_getResource description: Retrieves a BankSummary resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: BankSummary resource content: application/json: schema: $ref: '#/components/schemas/BankSummaryGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/BankSummaryGetResource200Response' text/xml: schema: $ref: '#/components/schemas/BankSummaryGetResource200Response' text/csv: schema: $ref: '#/components/schemas/BankSummaryGetResource200Response' text/html: schema: $ref: '#/components/schemas/BankSummaryGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bank_summaries/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bank_summaries/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/bank_summaries/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bank_summaries/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bank_summaries/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/bank_summaries/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bank_summaries/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bank_summaries/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bank_summaries/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /bank_transactions: parameters: [] get: tags: - BankTransaction summary: Retrieves the collection of BankTransaction resources. operationId: BankTransaction_listResources description: Retrieves the collection of BankTransaction resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: BankTransaction collection content: application/json: schema: $ref: '#/components/schemas/BankTransactionListResourcesResponse' application/xml: schema: $ref: '#/components/schemas/BankTransactionListResources200Response' text/xml: schema: $ref: '#/components/schemas/BankTransactionListResources200Response' text/csv: schema: $ref: '#/components/schemas/BankTransactionListResources200Response' text/html: schema: $ref: '#/components/schemas/BankTransactionListResources200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bank_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bank_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/bank_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bank_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bank_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/bank_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bank_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bank_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bank_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /bank_transactions/{id}: parameters: [] get: tags: - BankTransaction summary: Retrieves a BankTransaction resource. operationId: BankTransaction_getById description: Retrieves a BankTransaction resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: BankTransaction resource content: application/json: schema: $ref: '#/components/schemas/BankTransactionGetByIdResponse' application/xml: schema: $ref: '#/components/schemas/BankTransactionGetById200Response' text/xml: schema: $ref: '#/components/schemas/BankTransactionGetById200Response' text/csv: schema: $ref: '#/components/schemas/BankTransactionGetById200Response' text/html: schema: $ref: '#/components/schemas/BankTransactionGetById200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bank_transactions/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bank_transactions/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/bank_transactions/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bank_transactions/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bank_transactions/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/bank_transactions/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bank_transactions/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bank_transactions/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bank_transactions/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /bank_transfers: parameters: [] get: tags: - BankTransfer summary: Retrieves the collection of BankTransfer resources. operationId: BankTransfer_getCollection description: Retrieves the collection of BankTransfer resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: BankTransfer collection content: application/json: schema: $ref: '#/components/schemas/BankTransferGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/BankTransferGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/BankTransferGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/BankTransferGetCollection200Response' text/html: schema: $ref: '#/components/schemas/BankTransferGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bank_transfers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bank_transfers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/bank_transfers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bank_transfers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bank_transfers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/bank_transfers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bank_transfers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bank_transfers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bank_transfers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /bank_transfers/{id}: parameters: [] get: tags: - BankTransfer summary: Retrieves a BankTransfer resource. operationId: BankTransfer_getResource description: Retrieves a BankTransfer resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: BankTransfer resource content: application/json: schema: $ref: '#/components/schemas/BankTransferGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/BankTransferGetResource200Response' text/xml: schema: $ref: '#/components/schemas/BankTransferGetResource200Response' text/csv: schema: $ref: '#/components/schemas/BankTransferGetResource200Response' text/html: schema: $ref: '#/components/schemas/BankTransferGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bank_transfers/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bank_transfers/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/bank_transfers/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bank_transfers/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bank_transfers/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/bank_transfers/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bank_transfers/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bank_transfers/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bank_transfers/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /batch_payments: parameters: [] get: tags: - BatchPayment summary: Retrieves the collection of BatchPayment resources. operationId: BatchPayment_listResources description: Retrieves the collection of BatchPayment resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: BatchPayment collection content: application/json: schema: $ref: '#/components/schemas/BatchPaymentListResourcesResponse' application/xml: schema: $ref: '#/components/schemas/BatchPaymentListResources200Response' text/xml: schema: $ref: '#/components/schemas/BatchPaymentListResources200Response' text/csv: schema: $ref: '#/components/schemas/BatchPaymentListResources200Response' text/html: schema: $ref: '#/components/schemas/BatchPaymentListResources200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/batch_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/batch_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/batch_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/batch_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/batch_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/batch_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/batch_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/batch_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/batch_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /batch_payments/{id}: parameters: [] get: tags: - BatchPayment summary: Retrieves a BatchPayment resource. operationId: BatchPayment_getResource description: Retrieves a BatchPayment resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: BatchPayment resource content: application/json: schema: $ref: '#/components/schemas/BatchPaymentGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/BatchPaymentGetResource200Response' text/xml: schema: $ref: '#/components/schemas/BatchPaymentGetResource200Response' text/csv: schema: $ref: '#/components/schemas/BatchPaymentGetResource200Response' text/html: schema: $ref: '#/components/schemas/BatchPaymentGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/batch_payments/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/batch_payments/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/batch_payments/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/batch_payments/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/batch_payments/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/batch_payments/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/batch_payments/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/batch_payments/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/batch_payments/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /bill_payments: parameters: [] get: tags: - BillPayment summary: Retrieves the collection of BillPayment resources. operationId: BillPayment_getCollection description: Retrieves the collection of BillPayment resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: BillPayment collection content: application/json: schema: $ref: '#/components/schemas/BillPaymentGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/BillPaymentGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/BillPaymentGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/BillPaymentGetCollection200Response' text/html: schema: $ref: '#/components/schemas/BillPaymentGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bill_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bill_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/bill_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bill_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bill_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/bill_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bill_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bill_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bill_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - BillPayment summary: Creates a BillPayment resource. operationId: BillPayment_createResource description: Creates a BillPayment resource. parameters: [] requestBody: description: The new BillPayment resource content: application/json: schema: $ref: '#/components/schemas/BillPaymentCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/BillPaymentCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/BillPaymentCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/BillPaymentCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/BillPaymentCreateResourceRequest4' required: true responses: '201': description: BillPayment resource created content: application/json: schema: $ref: '#/components/schemas/BillPaymentCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/BillPaymentCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/BillPaymentCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/BillPaymentCreateResource201Response' text/html: schema: $ref: '#/components/schemas/BillPaymentCreateResource201Response' links: GetBillPaymentItem: operationId: getBillPaymentItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /bill_payments/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"billId\":\"34\",\"vendorPaymentId\":\"quickbooks-34\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bill_payments") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bill_payments"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"billId\":\"34\",\"vendorPaymentId\":\"quickbooks-34\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/bill_payments \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"460000000053219","billId":"34","vendorPaymentId":"quickbooks-34","vendorId":"460000000026049","vendorName":"Bowman and Co","paymentMode":"Stripe","txnDate":"2013-10-07","referenceNumber":"REF#912300","amount":12500,"currency":"USD","created":"2016-12-16T00:18:42-0500","modified":"2016-12-16T00:18:42-0500"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bill_payments", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"billId\":\"34\",\"vendorPaymentId\":\"quickbooks-34\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bill_payments") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"billId\":\"34\",\"vendorPaymentId\":\"quickbooks-34\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"billId\":\"34\",\"vendorPaymentId\":\"quickbooks-34\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/bill_payments", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bill_payments\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"460000000053219\\\",\\\"billId\\\":\\\"34\\\",\\\"vendorPaymentId\\\":\\\"quickbooks-34\\\",\\\"vendorId\\\":\\\"460000000026049\\\",\\\"vendorName\\\":\\\"Bowman and Co\\\",\\\"paymentMode\\\":\\\"Stripe\\\",\\\"txnDate\\\":\\\"2013-10-07\\\",\\\"referenceNumber\\\":\\\"REF#912300\\\",\\\"amount\\\":12500,\\\"currency\\\":\\\"USD\\\",\\\"created\\\":\\\"2016-12-16T00:18:42-0500\\\",\\\"modified\\\":\\\"2016-12-16T00:18:42-0500\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bill_payments", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"billId\":\"34\",\"vendorPaymentId\":\"quickbooks-34\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bill_payments", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '460000000053219', billId: '34', vendorPaymentId: 'quickbooks-34', vendorId: '460000000026049', vendorName: 'Bowman and Co', paymentMode: 'Stripe', txnDate: '2013-10-07', referenceNumber: 'REF#912300', amount: 12500, currency: 'USD', created: '2016-12-16T00:18:42-0500', modified: '2016-12-16T00:18:42-0500' })); req.end(); /bill_payments/{id}: parameters: [] get: tags: - BillPayment summary: Retrieves a BillPayment resource. operationId: BillPayment_getResource description: Retrieves a BillPayment resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: BillPayment resource content: application/json: schema: $ref: '#/components/schemas/BillPaymentGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/BillPaymentGetResource200Response' text/xml: schema: $ref: '#/components/schemas/BillPaymentGetResource200Response' text/csv: schema: $ref: '#/components/schemas/BillPaymentGetResource200Response' text/html: schema: $ref: '#/components/schemas/BillPaymentGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bill_payments/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bill_payments/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/bill_payments/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bill_payments/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bill_payments/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/bill_payments/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bill_payments/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bill_payments/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bill_payments/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - BillPayment summary: Replaces the BillPayment resource. operationId: BillPayment_replaceResource description: Replaces the BillPayment resource. parameters: - description: Resource identifier name: id in: path 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/BillPaymentReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/BillPaymentReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/BillPaymentReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/BillPaymentReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/BillPaymentReplaceResourceRequest4' required: true responses: '200': description: BillPayment resource updated content: application/json: schema: $ref: '#/components/schemas/BillPaymentReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/BillPaymentReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/BillPaymentReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/BillPaymentReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/BillPaymentReplaceResource200Response' links: GetBillPaymentItem: operationId: getBillPaymentItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /bill_payments/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"billId\":\"34\",\"vendorPaymentId\":\"quickbooks-34\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bill_payments/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bill_payments/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"billId\":\"34\",\"vendorPaymentId\":\"quickbooks-34\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/bill_payments/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"460000000053219","billId":"34","vendorPaymentId":"quickbooks-34","vendorId":"460000000026049","vendorName":"Bowman and Co","paymentMode":"Stripe","txnDate":"2013-10-07","referenceNumber":"REF#912300","amount":12500,"currency":"USD","created":"2016-12-16T00:18:42-0500","modified":"2016-12-16T00:18:42-0500"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bill_payments/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"billId\":\"34\",\"vendorPaymentId\":\"quickbooks-34\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bill_payments/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"billId\":\"34\",\"vendorPaymentId\":\"quickbooks-34\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"billId\":\"34\",\"vendorPaymentId\":\"quickbooks-34\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/bill_payments/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bill_payments/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"460000000053219\\\",\\\"billId\\\":\\\"34\\\",\\\"vendorPaymentId\\\":\\\"quickbooks-34\\\",\\\"vendorId\\\":\\\"460000000026049\\\",\\\"vendorName\\\":\\\"Bowman and Co\\\",\\\"paymentMode\\\":\\\"Stripe\\\",\\\"txnDate\\\":\\\"2013-10-07\\\",\\\"referenceNumber\\\":\\\"REF#912300\\\",\\\"amount\\\":12500,\\\"currency\\\":\\\"USD\\\",\\\"created\\\":\\\"2016-12-16T00:18:42-0500\\\",\\\"modified\\\":\\\"2016-12-16T00:18:42-0500\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bill_payments/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"billId\":\"34\",\"vendorPaymentId\":\"quickbooks-34\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bill_payments/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '460000000053219', billId: '34', vendorPaymentId: 'quickbooks-34', vendorId: '460000000026049', vendorName: 'Bowman and Co', paymentMode: 'Stripe', txnDate: '2013-10-07', referenceNumber: 'REF#912300', amount: 12500, currency: 'USD', created: '2016-12-16T00:18:42-0500', modified: '2016-12-16T00:18:42-0500' })); req.end(); delete: tags: - BillPayment summary: Removes the BillPayment resource. operationId: BillPayment_removeResource description: Removes the BillPayment resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: BillPayment resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bill_payments/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bill_payments/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/bill_payments/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bill_payments/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bill_payments/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/bill_payments/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bill_payments/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bill_payments/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bill_payments/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /bills: parameters: [] get: tags: - Bill summary: Retrieves the collection of Bill resources. operationId: Bill_getCollection description: Retrieves the collection of Bill resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Bill collection content: application/json: schema: $ref: '#/components/schemas/BillGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/BillGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/BillGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/BillGetCollection200Response' text/html: schema: $ref: '#/components/schemas/BillGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bills?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bills?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/bills?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bills?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bills?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/bills?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bills?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bills?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bills?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - Bill summary: Creates a Bill resource. operationId: Bill_createResource description: Creates a Bill resource. parameters: [] requestBody: description: The new Bill resource content: application/json: schema: $ref: '#/components/schemas/BillCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/BillCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/BillCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/BillCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/BillCreateResourceRequest4' required: true responses: '201': description: Bill resource created content: application/json: schema: $ref: '#/components/schemas/BillCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/BillCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/BillCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/BillCreateResource201Response' text/html: schema: $ref: '#/components/schemas/BillCreateResource201Response' links: GetBillItem: operationId: getBillItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /bills/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"vendorId\":\"15\",\"vendorName\":\"Acme Corp\",\"currency\":\"USD\",\"balance\":70000,\"txnDate\":\"2021-05-12\",\"totalAmount\":550000,\"apAccountId\":\"15\",\"apAccountName\":\"Accounts Payable\",\"modified\":\"2013-12-18T02:17:40.080Z\",\"created\":\"2013-11-18T02:17:40.080Z\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":\"Paid\",\"identifier\":\"4560\",\"referenceNumber\":\"1234\",\"dueDate\":\"2021-05-30\",\"subtotal\":65000,\"taxAmount\":12000}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bills") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bills"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"vendorId\":\"15\",\"vendorName\":\"Acme Corp\",\"currency\":\"USD\",\"balance\":70000,\"txnDate\":\"2021-05-12\",\"totalAmount\":550000,\"apAccountId\":\"15\",\"apAccountName\":\"Accounts Payable\",\"modified\":\"2013-12-18T02:17:40.080Z\",\"created\":\"2013-11-18T02:17:40.080Z\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":\"Paid\",\"identifier\":\"4560\",\"referenceNumber\":\"1234\",\"dueDate\":\"2021-05-30\",\"subtotal\":65000,\"taxAmount\":12000}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/bills \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","vendorId":"15","vendorName":"Acme Corp","currency":"USD","balance":70000,"txnDate":"2021-05-12","totalAmount":550000,"apAccountId":"15","apAccountName":"Accounts Payable","modified":"2013-12-18T02:17:40.080Z","created":"2013-11-18T02:17:40.080Z","srcId":"GH2JK-67283H-YW82KHX-2883KK-KS78S","status":"Paid","identifier":"4560","referenceNumber":"1234","dueDate":"2021-05-30","subtotal":65000,"taxAmount":12000}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bills", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"vendorId\":\"15\",\"vendorName\":\"Acme Corp\",\"currency\":\"USD\",\"balance\":70000,\"txnDate\":\"2021-05-12\",\"totalAmount\":550000,\"apAccountId\":\"15\",\"apAccountName\":\"Accounts Payable\",\"modified\":\"2013-12-18T02:17:40.080Z\",\"created\":\"2013-11-18T02:17:40.080Z\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":\"Paid\",\"identifier\":\"4560\",\"referenceNumber\":\"1234\",\"dueDate\":\"2021-05-30\",\"subtotal\":65000,\"taxAmount\":12000}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bills") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"vendorId\":\"15\",\"vendorName\":\"Acme Corp\",\"currency\":\"USD\",\"balance\":70000,\"txnDate\":\"2021-05-12\",\"totalAmount\":550000,\"apAccountId\":\"15\",\"apAccountName\":\"Accounts Payable\",\"modified\":\"2013-12-18T02:17:40.080Z\",\"created\":\"2013-11-18T02:17:40.080Z\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":\"Paid\",\"identifier\":\"4560\",\"referenceNumber\":\"1234\",\"dueDate\":\"2021-05-30\",\"subtotal\":65000,\"taxAmount\":12000}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"vendorId\":\"15\",\"vendorName\":\"Acme Corp\",\"currency\":\"USD\",\"balance\":70000,\"txnDate\":\"2021-05-12\",\"totalAmount\":550000,\"apAccountId\":\"15\",\"apAccountName\":\"Accounts Payable\",\"modified\":\"2013-12-18T02:17:40.080Z\",\"created\":\"2013-11-18T02:17:40.080Z\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":\"Paid\",\"identifier\":\"4560\",\"referenceNumber\":\"1234\",\"dueDate\":\"2021-05-30\",\"subtotal\":65000,\"taxAmount\":12000}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/bills", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bills\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"vendorId\\\":\\\"15\\\",\\\"vendorName\\\":\\\"Acme Corp\\\",\\\"currency\\\":\\\"USD\\\",\\\"balance\\\":70000,\\\"txnDate\\\":\\\"2021-05-12\\\",\\\"totalAmount\\\":550000,\\\"apAccountId\\\":\\\"15\\\",\\\"apAccountName\\\":\\\"Accounts Payable\\\",\\\"modified\\\":\\\"2013-12-18T02:17:40.080Z\\\",\\\"created\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"srcId\\\":\\\"GH2JK-67283H-YW82KHX-2883KK-KS78S\\\",\\\"status\\\":\\\"Paid\\\",\\\"identifier\\\":\\\"4560\\\",\\\"referenceNumber\\\":\\\"1234\\\",\\\"dueDate\\\":\\\"2021-05-30\\\",\\\"subtotal\\\":65000,\\\"taxAmount\\\":12000}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bills", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"vendorId\":\"15\",\"vendorName\":\"Acme Corp\",\"currency\":\"USD\",\"balance\":70000,\"txnDate\":\"2021-05-12\",\"totalAmount\":550000,\"apAccountId\":\"15\",\"apAccountName\":\"Accounts Payable\",\"modified\":\"2013-12-18T02:17:40.080Z\",\"created\":\"2013-11-18T02:17:40.080Z\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":\"Paid\",\"identifier\":\"4560\",\"referenceNumber\":\"1234\",\"dueDate\":\"2021-05-30\",\"subtotal\":65000,\"taxAmount\":12000}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bills", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', vendorId: '15', vendorName: 'Acme Corp', currency: 'USD', balance: 70000, txnDate: '2021-05-12', totalAmount: 550000, apAccountId: '15', apAccountName: 'Accounts Payable', modified: '2013-12-18T02:17:40.080Z', created: '2013-11-18T02:17:40.080Z', srcId: 'GH2JK-67283H-YW82KHX-2883KK-KS78S', status: 'Paid', identifier: '4560', referenceNumber: '1234', dueDate: '2021-05-30', subtotal: 65000, taxAmount: 12000 })); req.end(); /bills/{id}: parameters: [] get: tags: - Bill summary: Retrieves a Bill resource. operationId: Bill_getResource description: Retrieves a Bill resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Bill resource content: application/json: schema: $ref: '#/components/schemas/BillGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/BillGetResource200Response' text/xml: schema: $ref: '#/components/schemas/BillGetResource200Response' text/csv: schema: $ref: '#/components/schemas/BillGetResource200Response' text/html: schema: $ref: '#/components/schemas/BillGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bills/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bills/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/bills/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bills/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bills/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/bills/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bills/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bills/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bills/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - Bill summary: Replaces the Bill resource. operationId: Bill_updateResource description: Replaces the Bill resource. parameters: - description: Resource identifier name: id in: path 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/BillUpdateResourceRequest' application/xml: schema: $ref: '#/components/schemas/BillUpdateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/BillUpdateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/BillUpdateResourceRequest3' text/html: schema: $ref: '#/components/schemas/BillUpdateResourceRequest4' required: true responses: '200': description: Bill resource updated content: application/json: schema: $ref: '#/components/schemas/BillUpdateResourceResponse' application/xml: schema: $ref: '#/components/schemas/BillUpdateResource200Response' text/xml: schema: $ref: '#/components/schemas/BillUpdateResource200Response' text/csv: schema: $ref: '#/components/schemas/BillUpdateResource200Response' text/html: schema: $ref: '#/components/schemas/BillUpdateResource200Response' links: GetBillItem: operationId: getBillItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /bills/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"vendorId\":\"15\",\"vendorName\":\"Acme Corp\",\"currency\":\"USD\",\"balance\":70000,\"txnDate\":\"2021-05-12\",\"totalAmount\":550000,\"apAccountId\":\"15\",\"apAccountName\":\"Accounts Payable\",\"modified\":\"2013-12-18T02:17:40.080Z\",\"created\":\"2013-11-18T02:17:40.080Z\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":\"Paid\",\"identifier\":\"4560\",\"referenceNumber\":\"1234\",\"dueDate\":\"2021-05-30\",\"subtotal\":65000,\"taxAmount\":12000}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bills/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bills/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"vendorId\":\"15\",\"vendorName\":\"Acme Corp\",\"currency\":\"USD\",\"balance\":70000,\"txnDate\":\"2021-05-12\",\"totalAmount\":550000,\"apAccountId\":\"15\",\"apAccountName\":\"Accounts Payable\",\"modified\":\"2013-12-18T02:17:40.080Z\",\"created\":\"2013-11-18T02:17:40.080Z\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":\"Paid\",\"identifier\":\"4560\",\"referenceNumber\":\"1234\",\"dueDate\":\"2021-05-30\",\"subtotal\":65000,\"taxAmount\":12000}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/bills/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","vendorId":"15","vendorName":"Acme Corp","currency":"USD","balance":70000,"txnDate":"2021-05-12","totalAmount":550000,"apAccountId":"15","apAccountName":"Accounts Payable","modified":"2013-12-18T02:17:40.080Z","created":"2013-11-18T02:17:40.080Z","srcId":"GH2JK-67283H-YW82KHX-2883KK-KS78S","status":"Paid","identifier":"4560","referenceNumber":"1234","dueDate":"2021-05-30","subtotal":65000,"taxAmount":12000}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bills/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"vendorId\":\"15\",\"vendorName\":\"Acme Corp\",\"currency\":\"USD\",\"balance\":70000,\"txnDate\":\"2021-05-12\",\"totalAmount\":550000,\"apAccountId\":\"15\",\"apAccountName\":\"Accounts Payable\",\"modified\":\"2013-12-18T02:17:40.080Z\",\"created\":\"2013-11-18T02:17:40.080Z\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":\"Paid\",\"identifier\":\"4560\",\"referenceNumber\":\"1234\",\"dueDate\":\"2021-05-30\",\"subtotal\":65000,\"taxAmount\":12000}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bills/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"vendorId\":\"15\",\"vendorName\":\"Acme Corp\",\"currency\":\"USD\",\"balance\":70000,\"txnDate\":\"2021-05-12\",\"totalAmount\":550000,\"apAccountId\":\"15\",\"apAccountName\":\"Accounts Payable\",\"modified\":\"2013-12-18T02:17:40.080Z\",\"created\":\"2013-11-18T02:17:40.080Z\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":\"Paid\",\"identifier\":\"4560\",\"referenceNumber\":\"1234\",\"dueDate\":\"2021-05-30\",\"subtotal\":65000,\"taxAmount\":12000}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"vendorId\":\"15\",\"vendorName\":\"Acme Corp\",\"currency\":\"USD\",\"balance\":70000,\"txnDate\":\"2021-05-12\",\"totalAmount\":550000,\"apAccountId\":\"15\",\"apAccountName\":\"Accounts Payable\",\"modified\":\"2013-12-18T02:17:40.080Z\",\"created\":\"2013-11-18T02:17:40.080Z\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":\"Paid\",\"identifier\":\"4560\",\"referenceNumber\":\"1234\",\"dueDate\":\"2021-05-30\",\"subtotal\":65000,\"taxAmount\":12000}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/bills/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bills/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"vendorId\\\":\\\"15\\\",\\\"vendorName\\\":\\\"Acme Corp\\\",\\\"currency\\\":\\\"USD\\\",\\\"balance\\\":70000,\\\"txnDate\\\":\\\"2021-05-12\\\",\\\"totalAmount\\\":550000,\\\"apAccountId\\\":\\\"15\\\",\\\"apAccountName\\\":\\\"Accounts Payable\\\",\\\"modified\\\":\\\"2013-12-18T02:17:40.080Z\\\",\\\"created\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"srcId\\\":\\\"GH2JK-67283H-YW82KHX-2883KK-KS78S\\\",\\\"status\\\":\\\"Paid\\\",\\\"identifier\\\":\\\"4560\\\",\\\"referenceNumber\\\":\\\"1234\\\",\\\"dueDate\\\":\\\"2021-05-30\\\",\\\"subtotal\\\":65000,\\\"taxAmount\\\":12000}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bills/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"vendorId\":\"15\",\"vendorName\":\"Acme Corp\",\"currency\":\"USD\",\"balance\":70000,\"txnDate\":\"2021-05-12\",\"totalAmount\":550000,\"apAccountId\":\"15\",\"apAccountName\":\"Accounts Payable\",\"modified\":\"2013-12-18T02:17:40.080Z\",\"created\":\"2013-11-18T02:17:40.080Z\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":\"Paid\",\"identifier\":\"4560\",\"referenceNumber\":\"1234\",\"dueDate\":\"2021-05-30\",\"subtotal\":65000,\"taxAmount\":12000}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bills/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', vendorId: '15', vendorName: 'Acme Corp', currency: 'USD', balance: 70000, txnDate: '2021-05-12', totalAmount: 550000, apAccountId: '15', apAccountName: 'Accounts Payable', modified: '2013-12-18T02:17:40.080Z', created: '2013-11-18T02:17:40.080Z', srcId: 'GH2JK-67283H-YW82KHX-2883KK-KS78S', status: 'Paid', identifier: '4560', referenceNumber: '1234', dueDate: '2021-05-30', subtotal: 65000, taxAmount: 12000 })); req.end(); delete: tags: - Bill summary: Removes the Bill resource. operationId: Bill_removeResource description: Removes the Bill resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: Bill resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/bills/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/bills/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/bills/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/bills/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/bills/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/bills/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/bills/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/bills/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/bills/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /blog_postings: parameters: [] get: tags: - BlogPosting summary: Retrieves the collection of BlogPosting resources. operationId: BlogPosting_getCollection description: Retrieves the collection of BlogPosting resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: BlogPosting collection content: application/json: schema: $ref: '#/components/schemas/BlogPostingGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/BlogPostingGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/BlogPostingGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/BlogPostingGetCollection200Response' text/html: schema: $ref: '#/components/schemas/BlogPostingGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/blog_postings?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/blog_postings?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/blog_postings?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/blog_postings?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/blog_postings?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/blog_postings?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/blog_postings?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/blog_postings?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/blog_postings?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /blog_postings/{id}: parameters: [] get: tags: - BlogPosting summary: Retrieves a BlogPosting resource. operationId: BlogPosting_getResource description: Retrieves a BlogPosting resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: BlogPosting resource content: application/json: schema: $ref: '#/components/schemas/BlogPostingGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/BlogPostingGetResource200Response' text/xml: schema: $ref: '#/components/schemas/BlogPostingGetResource200Response' text/csv: schema: $ref: '#/components/schemas/BlogPostingGetResource200Response' text/html: schema: $ref: '#/components/schemas/BlogPostingGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/blog_postings/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/blog_postings/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/blog_postings/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/blog_postings/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/blog_postings/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/blog_postings/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/blog_postings/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/blog_postings/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/blog_postings/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /blogs: parameters: [] get: tags: - Blog summary: Retrieves the collection of Blog resources. operationId: Blog_getCollection description: Retrieves the collection of Blog resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Blog collection content: application/json: schema: $ref: '#/components/schemas/BlogGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/BlogGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/BlogGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/BlogGetCollection200Response' text/html: schema: $ref: '#/components/schemas/BlogGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/blogs?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/blogs?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/blogs?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/blogs?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/blogs?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/blogs?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/blogs?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/blogs?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/blogs?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /blogs/{id}: parameters: [] get: tags: - Blog summary: Retrieves a Blog resource. operationId: Blog_getResource description: Retrieves a Blog resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Blog resource content: application/json: schema: $ref: '#/components/schemas/BlogGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/BlogGetResource200Response' text/xml: schema: $ref: '#/components/schemas/BlogGetResource200Response' text/csv: schema: $ref: '#/components/schemas/BlogGetResource200Response' text/html: schema: $ref: '#/components/schemas/BlogGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/blogs/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/blogs/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/blogs/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/blogs/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/blogs/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/blogs/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/blogs/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/blogs/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/blogs/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /budget_summaries/{id}: parameters: [] get: tags: - BudgetSummary summary: Retrieves a BudgetSummary resource. operationId: BudgetSummary_getResource description: Retrieves a BudgetSummary resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: BudgetSummary resource content: application/json: schema: $ref: '#/components/schemas/BudgetSummaryGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/BudgetSummaryGetResource200Response' text/xml: schema: $ref: '#/components/schemas/BudgetSummaryGetResource200Response' text/csv: schema: $ref: '#/components/schemas/BudgetSummaryGetResource200Response' text/html: schema: $ref: '#/components/schemas/BudgetSummaryGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/budget_summaries/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/budget_summaries/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/budget_summaries/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/budget_summaries/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/budget_summaries/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/budget_summaries/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/budget_summaries/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/budget_summaries/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/budget_summaries/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /budget_summary: parameters: [] get: tags: - BudgetSummary summary: Retrieves the collection of BudgetSummary resources. operationId: BudgetSummary_getCollection description: Retrieves the collection of BudgetSummary resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: BudgetSummary collection content: application/json: schema: $ref: '#/components/schemas/BudgetSummaryGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/BudgetSummaryGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/BudgetSummaryGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/BudgetSummaryGetCollection200Response' text/html: schema: $ref: '#/components/schemas/BudgetSummaryGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/budget_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/budget_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/budget_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/budget_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/budget_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/budget_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/budget_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/budget_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/budget_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /calls: parameters: [] get: tags: - Call summary: Retrieves the collection of Call resources. operationId: Call_getCollection description: Retrieves the collection of Call resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Call collection content: application/json: schema: $ref: '#/components/schemas/CallGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/CallGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/CallGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/CallGetCollection200Response' text/html: schema: $ref: '#/components/schemas/CallGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/calls?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/calls?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/calls?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/calls?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/calls?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/calls?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/calls?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/calls?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/calls?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /calls/{id}: parameters: [] get: tags: - Call summary: Retrieves a Call resource. operationId: Call_getResource description: Retrieves a Call resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Call resource content: application/json: schema: $ref: '#/components/schemas/CallGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/CallGetResource200Response' text/xml: schema: $ref: '#/components/schemas/CallGetResource200Response' text/csv: schema: $ref: '#/components/schemas/CallGetResource200Response' text/html: schema: $ref: '#/components/schemas/CallGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/calls/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/calls/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/calls/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/calls/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/calls/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/calls/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/calls/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/calls/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/calls/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /campaign_reports: parameters: [] get: tags: - CampaignReport summary: Retrieves the collection of CampaignReport resources. operationId: CampaignReport_getCollection description: Retrieves the collection of CampaignReport resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: CampaignReport collection content: application/json: schema: $ref: '#/components/schemas/CampaignReportGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/CampaignReportGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/CampaignReportGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/CampaignReportGetCollection200Response' text/html: schema: $ref: '#/components/schemas/CampaignReportGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/campaign_reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/campaign_reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/campaign_reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/campaign_reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/campaign_reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/campaign_reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/campaign_reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/campaign_reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/campaign_reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /campaign_reports/{id}: parameters: [] get: tags: - CampaignReport summary: Retrieves a CampaignReport resource. operationId: CampaignReport_getResource description: Retrieves a CampaignReport resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: CampaignReport resource content: application/json: schema: $ref: '#/components/schemas/CampaignReportGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/CampaignReportGetResource200Response' text/xml: schema: $ref: '#/components/schemas/CampaignReportGetResource200Response' text/csv: schema: $ref: '#/components/schemas/CampaignReportGetResource200Response' text/html: schema: $ref: '#/components/schemas/CampaignReportGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/campaign_reports/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/campaign_reports/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/campaign_reports/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/campaign_reports/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/campaign_reports/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/campaign_reports/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/campaign_reports/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/campaign_reports/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/campaign_reports/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /campaigns: parameters: [] get: tags: - Campaign summary: Retrieves the collection of Campaign resources. operationId: Campaign_getCollection description: Retrieves the collection of Campaign resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Campaign collection content: application/json: schema: $ref: '#/components/schemas/CampaignGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/CampaignGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/CampaignGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/CampaignGetCollection200Response' text/html: schema: $ref: '#/components/schemas/CampaignGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/campaigns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/campaigns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/campaigns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/campaigns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/campaigns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/campaigns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/campaigns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/campaigns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/campaigns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /campaigns/{id}: parameters: [] get: tags: - Campaign summary: Retrieves a Campaign resource. operationId: Campaign_getResource description: Retrieves a Campaign resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Campaign resource content: application/json: schema: $ref: '#/components/schemas/CampaignGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/CampaignGetResource200Response' text/xml: schema: $ref: '#/components/schemas/CampaignGetResource200Response' text/csv: schema: $ref: '#/components/schemas/CampaignGetResource200Response' text/html: schema: $ref: '#/components/schemas/CampaignGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/campaigns/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/campaigns/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/campaigns/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/campaigns/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/campaigns/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/campaigns/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/campaigns/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/campaigns/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/campaigns/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /charges: parameters: [] get: tags: - Charge summary: Retrieves the collection of Charge resources. operationId: Charge_getCollection description: Retrieves the collection of Charge resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Charge collection content: application/json: schema: $ref: '#/components/schemas/ChargeGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/ChargeGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/ChargeGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/ChargeGetCollection200Response' text/html: schema: $ref: '#/components/schemas/ChargeGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /charges/{id}: parameters: [] get: tags: - Charge summary: Retrieves a Charge resource. operationId: Charge_getResource description: Retrieves a Charge resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Charge resource content: application/json: schema: $ref: '#/components/schemas/ChargeGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/ChargeGetResource200Response' text/xml: schema: $ref: '#/components/schemas/ChargeGetResource200Response' text/csv: schema: $ref: '#/components/schemas/ChargeGetResource200Response' text/html: schema: $ref: '#/components/schemas/ChargeGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/charges/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/charges/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/charges/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/charges/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/charges/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/charges/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/charges/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/charges/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/charges/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /clients: parameters: [] get: tags: - Client summary: Retrieves the collection of Client resources. operationId: Client_getCollection description: Retrieves the collection of Client resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Client collection content: application/json: schema: $ref: '#/components/schemas/ClientGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/ClientGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/ClientGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/ClientGetCollection200Response' text/html: schema: $ref: '#/components/schemas/ClientGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/clients?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/clients?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/clients?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/clients?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/clients?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/clients?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/clients?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/clients?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/clients?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /clients/{id}: parameters: [] get: tags: - Client summary: Retrieves a Client resource. operationId: Client_getResource description: Retrieves a Client resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Client resource content: application/json: schema: $ref: '#/components/schemas/ClientGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/ClientGetResource200Response' text/xml: schema: $ref: '#/components/schemas/ClientGetResource200Response' text/csv: schema: $ref: '#/components/schemas/ClientGetResource200Response' text/html: schema: $ref: '#/components/schemas/ClientGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/clients/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/clients/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/clients/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/clients/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/clients/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/clients/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/clients/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/clients/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/clients/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /companies: parameters: [] get: tags: - Company summary: Retrieves the collection of Company resources. operationId: Company_getCollection description: Retrieves the collection of Company resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Company collection content: application/json: schema: $ref: '#/components/schemas/CompanyGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/CompanyGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/CompanyGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/CompanyGetCollection200Response' text/html: schema: $ref: '#/components/schemas/CompanyGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/companies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/companies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/companies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/companies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/companies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/companies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/companies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/companies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/companies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /companies/{id}: parameters: [] get: tags: - Company summary: Retrieves a Company resource. operationId: Company_getResource description: Retrieves a Company resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Company resource content: application/json: schema: $ref: '#/components/schemas/CompanyGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/CompanyGetResource200Response' text/xml: schema: $ref: '#/components/schemas/CompanyGetResource200Response' text/csv: schema: $ref: '#/components/schemas/CompanyGetResource200Response' text/html: schema: $ref: '#/components/schemas/CompanyGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/companies/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/companies/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/companies/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/companies/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/companies/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/companies/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/companies/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/companies/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/companies/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /contact_groups: parameters: [] get: tags: - ContactGroup summary: Retrieves the collection of ContactGroup resources. operationId: ContactGroup_getCollection description: Retrieves the collection of ContactGroup resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: ContactGroup collection content: application/json: schema: $ref: '#/components/schemas/ContactGroupGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/ContactGroupGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/ContactGroupGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/ContactGroupGetCollection200Response' text/html: schema: $ref: '#/components/schemas/ContactGroupGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/contact_groups?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/contact_groups?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/contact_groups?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/contact_groups?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/contact_groups?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/contact_groups?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/contact_groups?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/contact_groups?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/contact_groups?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /contact_groups/{id}: parameters: [] get: tags: - ContactGroup summary: Retrieves a ContactGroup resource. operationId: ContactGroup_getResource description: Retrieves a ContactGroup resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: ContactGroup resource content: application/json: schema: $ref: '#/components/schemas/ContactGroupGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/ContactGroupGetResource200Response' text/xml: schema: $ref: '#/components/schemas/ContactGroupGetResource200Response' text/csv: schema: $ref: '#/components/schemas/ContactGroupGetResource200Response' text/html: schema: $ref: '#/components/schemas/ContactGroupGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/contact_groups/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/contact_groups/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/contact_groups/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/contact_groups/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/contact_groups/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/contact_groups/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/contact_groups/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/contact_groups/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/contact_groups/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /contracts: parameters: [] get: tags: - Contract summary: Retrieves the collection of Contract resources. operationId: Contract_getCollection description: Retrieves the collection of Contract resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Contract collection content: application/json: schema: $ref: '#/components/schemas/ContractGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/ContractGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/ContractGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/ContractGetCollection200Response' text/html: schema: $ref: '#/components/schemas/ContractGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/contracts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/contracts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/contracts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/contracts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/contracts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/contracts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/contracts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/contracts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/contracts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /contracts/{id}: parameters: [] get: tags: - Contract summary: Retrieves a Contract resource. operationId: Contract_getResource description: Retrieves a Contract resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Contract resource content: application/json: schema: $ref: '#/components/schemas/ContractGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/ContractGetResource200Response' text/xml: schema: $ref: '#/components/schemas/ContractGetResource200Response' text/csv: schema: $ref: '#/components/schemas/ContractGetResource200Response' text/html: schema: $ref: '#/components/schemas/ContractGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/contracts/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/contracts/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/contracts/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/contracts/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/contracts/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/contracts/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/contracts/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/contracts/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/contracts/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /conversion: parameters: [] get: tags: - Conversion summary: list converted documents operationId: Conversion_listDocuments description: Retrieves the collection of Conversion resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Conversion collection content: application/json: schema: $ref: '#/components/schemas/ConversionListDocumentsResponse' application/xml: schema: $ref: '#/components/schemas/ConversionListDocuments200Response' text/xml: schema: $ref: '#/components/schemas/ConversionListDocuments200Response' text/csv: schema: $ref: '#/components/schemas/ConversionListDocuments200Response' text/html: schema: $ref: '#/components/schemas/ConversionListDocuments200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/conversion?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/conversion?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/conversion?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/conversion?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/conversion?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/conversion?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/conversion?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/conversion?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/conversion?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - Conversion summary: Converts a document from one format to another operationId: Conversion_documentFormat description: Creates a Conversion resource. parameters: [] requestBody: description: The new Conversion resource content: application/json: schema: $ref: '#/components/schemas/ConversionDocumentFormatRequest' application/xml: schema: $ref: '#/components/schemas/ConversionDocumentFormatRequest1' text/xml: schema: $ref: '#/components/schemas/ConversionDocumentFormatRequest2' text/csv: schema: $ref: '#/components/schemas/ConversionDocumentFormatRequest3' text/html: schema: $ref: '#/components/schemas/ConversionDocumentFormatRequest4' required: true responses: '201': description: Conversion resource created content: application/json: schema: $ref: '#/components/schemas/ConversionDocumentFormatResponse' application/xml: schema: $ref: '#/components/schemas/ConversionDocumentFormat201Response' text/xml: schema: $ref: '#/components/schemas/ConversionDocumentFormat201Response' text/csv: schema: $ref: '#/components/schemas/ConversionDocumentFormat201Response' text/html: schema: $ref: '#/components/schemas/ConversionDocumentFormat201Response' links: GetConversionItem: operationId: getConversionItem description: >- The values returned in the response can be used in `GET /conversion/{id}`. parameters: {} '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"type\":\"string\",\"url\":\"string\",\"file\":\"string\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/conversion") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/conversion"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"type\":\"string\",\"url\":\"string\",\"file\":\"string\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/conversion \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"type":"string","url":"string","file":"string"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/conversion", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"type\":\"string\",\"url\":\"string\",\"file\":\"string\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/conversion") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"type\":\"string\",\"url\":\"string\",\"file\":\"string\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"type\":\"string\",\"url\":\"string\",\"file\":\"string\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/conversion", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/conversion\"\n\n\tpayload := strings.NewReader(\"{\\\"type\\\":\\\"string\\\",\\\"url\\\":\\\"string\\\",\\\"file\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/conversion", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"type\":\"string\",\"url\":\"string\",\"file\":\"string\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: >- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/conversion", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({type: 'string', url: 'string', file: 'string'})); req.end(); /conversion/{id}: parameters: [] get: tags: - Conversion summary: Retrieves conversion results operationId: Conversion_getResult description: Retrieves a Conversion resource. parameters: - description: conversion job identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: integer style: simple explode: false allowReserved: false example: 42 - description: document format name: format in: query required: true deprecated: false allowEmptyValue: false schema: type: string enum: - data - pages - source style: form explode: false allowReserved: false example: data responses: '200': description: Conversion resource content: application/json: schema: $ref: '#/components/schemas/ConversionGetResultResponse' application/xml: schema: $ref: '#/components/schemas/ConversionGetResult200Response' text/xml: schema: $ref: '#/components/schemas/ConversionGetResult200Response' text/csv: schema: $ref: '#/components/schemas/ConversionGetResult200Response' text/html: schema: $ref: '#/components/schemas/ConversionGetResult200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/conversion/%7Bid%7D?format=SOME_STRING_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/conversion/%7Bid%7D?format=SOME_STRING_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/conversion/%7Bid%7D?format=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/conversion/%7Bid%7D?format=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/conversion/%7Bid%7D?format=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/conversion/%7Bid%7D?format=SOME_STRING_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/conversion/%7Bid%7D?format=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/conversion/%7Bid%7D?format=SOME_STRING_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/conversion/%7Bid%7D?format=SOME_STRING_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /credit_notes: parameters: [] get: tags: - CreditNote summary: Retrieves the collection of CreditNote resources. operationId: CreditNote_getCollection description: Retrieves the collection of CreditNote resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: CreditNote collection content: application/json: schema: $ref: '#/components/schemas/CreditNoteGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/CreditNoteGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/CreditNoteGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/CreditNoteGetCollection200Response' text/html: schema: $ref: '#/components/schemas/CreditNoteGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - CreditNote summary: Creates a CreditNote resource. operationId: CreditNote_createResource description: Creates a CreditNote resource. parameters: [] requestBody: description: The new CreditNote resource content: application/json: schema: $ref: '#/components/schemas/CreditNoteCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/CreditNoteCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/CreditNoteCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/CreditNoteCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/CreditNoteCreateResourceRequest4' required: true responses: '201': description: CreditNote resource created content: application/json: schema: $ref: '#/components/schemas/CreditNoteCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/CreditNoteCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/CreditNoteCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/CreditNoteCreateResource201Response' text/html: schema: $ref: '#/components/schemas/CreditNoteCreateResource201Response' links: GetCreditNoteItem: operationId: getCreditNoteItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /credit_notes/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"creditnoteNumber\":\"CN-29\",\"date\":\"2016-06-05\",\"status\":\"open\",\"customerId\":\"903000000000099\",\"customerName\":\"Bowman Furniture\",\"referenceNumber\":\"INV-384\",\"totalAmount\":\"400\",\"balance\":10,\"currency\":\"USD\",\"notes\":\"Offer for the referral\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/credit_notes") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/credit_notes"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"creditnoteNumber\":\"CN-29\",\"date\":\"2016-06-05\",\"status\":\"open\",\"customerId\":\"903000000000099\",\"customerName\":\"Bowman Furniture\",\"referenceNumber\":\"INV-384\",\"totalAmount\":\"400\",\"balance\":10,\"currency\":\"USD\",\"notes\":\"Offer for the referral\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/credit_notes \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"90300000072369","creditnoteNumber":"CN-29","date":"2016-06-05","status":"open","customerId":"903000000000099","customerName":"Bowman Furniture","referenceNumber":"INV-384","totalAmount":"400","balance":10,"currency":"USD","notes":"Offer for the referral","created":"2013-11-18T02:17:40.080Z","modified":"2013-11-18T02:17:40.080Z"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/credit_notes", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"creditnoteNumber\":\"CN-29\",\"date\":\"2016-06-05\",\"status\":\"open\",\"customerId\":\"903000000000099\",\"customerName\":\"Bowman Furniture\",\"referenceNumber\":\"INV-384\",\"totalAmount\":\"400\",\"balance\":10,\"currency\":\"USD\",\"notes\":\"Offer for the referral\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/credit_notes") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"creditnoteNumber\":\"CN-29\",\"date\":\"2016-06-05\",\"status\":\"open\",\"customerId\":\"903000000000099\",\"customerName\":\"Bowman Furniture\",\"referenceNumber\":\"INV-384\",\"totalAmount\":\"400\",\"balance\":10,\"currency\":\"USD\",\"notes\":\"Offer for the referral\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"creditnoteNumber\":\"CN-29\",\"date\":\"2016-06-05\",\"status\":\"open\",\"customerId\":\"903000000000099\",\"customerName\":\"Bowman Furniture\",\"referenceNumber\":\"INV-384\",\"totalAmount\":\"400\",\"balance\":10,\"currency\":\"USD\",\"notes\":\"Offer for the referral\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/credit_notes", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/credit_notes\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"90300000072369\\\",\\\"creditnoteNumber\\\":\\\"CN-29\\\",\\\"date\\\":\\\"2016-06-05\\\",\\\"status\\\":\\\"open\\\",\\\"customerId\\\":\\\"903000000000099\\\",\\\"customerName\\\":\\\"Bowman Furniture\\\",\\\"referenceNumber\\\":\\\"INV-384\\\",\\\"totalAmount\\\":\\\"400\\\",\\\"balance\\\":10,\\\"currency\\\":\\\"USD\\\",\\\"notes\\\":\\\"Offer for the referral\\\",\\\"created\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"modified\\\":\\\"2013-11-18T02:17:40.080Z\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/credit_notes", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"creditnoteNumber\":\"CN-29\",\"date\":\"2016-06-05\",\"status\":\"open\",\"customerId\":\"903000000000099\",\"customerName\":\"Bowman Furniture\",\"referenceNumber\":\"INV-384\",\"totalAmount\":\"400\",\"balance\":10,\"currency\":\"USD\",\"notes\":\"Offer for the referral\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/credit_notes", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '90300000072369', creditnoteNumber: 'CN-29', date: '2016-06-05', status: 'open', customerId: '903000000000099', customerName: 'Bowman Furniture', referenceNumber: 'INV-384', totalAmount: '400', balance: 10, currency: 'USD', notes: 'Offer for the referral', created: '2013-11-18T02:17:40.080Z', modified: '2013-11-18T02:17:40.080Z' })); req.end(); /credit_notes/{id}: parameters: [] get: tags: - CreditNote summary: Retrieves a CreditNote resource. operationId: CreditNote_getResource description: Retrieves a CreditNote resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: CreditNote resource content: application/json: schema: $ref: '#/components/schemas/CreditNoteGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/CreditNoteGetResource200Response' text/xml: schema: $ref: '#/components/schemas/CreditNoteGetResource200Response' text/csv: schema: $ref: '#/components/schemas/CreditNoteGetResource200Response' text/html: schema: $ref: '#/components/schemas/CreditNoteGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/credit_notes/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/credit_notes/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/credit_notes/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/credit_notes/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/credit_notes/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/credit_notes/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/credit_notes/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/credit_notes/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/credit_notes/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - CreditNote summary: Replaces the CreditNote resource. operationId: CreditNote_replaceResource description: Replaces the CreditNote resource. parameters: - description: Resource identifier name: id in: path 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/CreditNoteReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/CreditNoteReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/CreditNoteReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/CreditNoteReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/CreditNoteReplaceResourceRequest4' required: true responses: '200': description: CreditNote resource updated content: application/json: schema: $ref: '#/components/schemas/CreditNoteReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/CreditNoteReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/CreditNoteReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/CreditNoteReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/CreditNoteReplaceResource200Response' links: GetCreditNoteItem: operationId: getCreditNoteItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /credit_notes/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"creditnoteNumber\":\"CN-29\",\"date\":\"2016-06-05\",\"status\":\"open\",\"customerId\":\"903000000000099\",\"customerName\":\"Bowman Furniture\",\"referenceNumber\":\"INV-384\",\"totalAmount\":\"400\",\"balance\":10,\"currency\":\"USD\",\"notes\":\"Offer for the referral\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/credit_notes/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/credit_notes/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"creditnoteNumber\":\"CN-29\",\"date\":\"2016-06-05\",\"status\":\"open\",\"customerId\":\"903000000000099\",\"customerName\":\"Bowman Furniture\",\"referenceNumber\":\"INV-384\",\"totalAmount\":\"400\",\"balance\":10,\"currency\":\"USD\",\"notes\":\"Offer for the referral\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/credit_notes/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"90300000072369","creditnoteNumber":"CN-29","date":"2016-06-05","status":"open","customerId":"903000000000099","customerName":"Bowman Furniture","referenceNumber":"INV-384","totalAmount":"400","balance":10,"currency":"USD","notes":"Offer for the referral","created":"2013-11-18T02:17:40.080Z","modified":"2013-11-18T02:17:40.080Z"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/credit_notes/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"creditnoteNumber\":\"CN-29\",\"date\":\"2016-06-05\",\"status\":\"open\",\"customerId\":\"903000000000099\",\"customerName\":\"Bowman Furniture\",\"referenceNumber\":\"INV-384\",\"totalAmount\":\"400\",\"balance\":10,\"currency\":\"USD\",\"notes\":\"Offer for the referral\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/credit_notes/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"creditnoteNumber\":\"CN-29\",\"date\":\"2016-06-05\",\"status\":\"open\",\"customerId\":\"903000000000099\",\"customerName\":\"Bowman Furniture\",\"referenceNumber\":\"INV-384\",\"totalAmount\":\"400\",\"balance\":10,\"currency\":\"USD\",\"notes\":\"Offer for the referral\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"creditnoteNumber\":\"CN-29\",\"date\":\"2016-06-05\",\"status\":\"open\",\"customerId\":\"903000000000099\",\"customerName\":\"Bowman Furniture\",\"referenceNumber\":\"INV-384\",\"totalAmount\":\"400\",\"balance\":10,\"currency\":\"USD\",\"notes\":\"Offer for the referral\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/credit_notes/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/credit_notes/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"90300000072369\\\",\\\"creditnoteNumber\\\":\\\"CN-29\\\",\\\"date\\\":\\\"2016-06-05\\\",\\\"status\\\":\\\"open\\\",\\\"customerId\\\":\\\"903000000000099\\\",\\\"customerName\\\":\\\"Bowman Furniture\\\",\\\"referenceNumber\\\":\\\"INV-384\\\",\\\"totalAmount\\\":\\\"400\\\",\\\"balance\\\":10,\\\"currency\\\":\\\"USD\\\",\\\"notes\\\":\\\"Offer for the referral\\\",\\\"created\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"modified\\\":\\\"2013-11-18T02:17:40.080Z\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/credit_notes/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"creditnoteNumber\":\"CN-29\",\"date\":\"2016-06-05\",\"status\":\"open\",\"customerId\":\"903000000000099\",\"customerName\":\"Bowman Furniture\",\"referenceNumber\":\"INV-384\",\"totalAmount\":\"400\",\"balance\":10,\"currency\":\"USD\",\"notes\":\"Offer for the referral\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/credit_notes/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '90300000072369', creditnoteNumber: 'CN-29', date: '2016-06-05', status: 'open', customerId: '903000000000099', customerName: 'Bowman Furniture', referenceNumber: 'INV-384', totalAmount: '400', balance: 10, currency: 'USD', notes: 'Offer for the referral', created: '2013-11-18T02:17:40.080Z', modified: '2013-11-18T02:17:40.080Z' })); req.end(); delete: tags: - CreditNote summary: Removes the CreditNote resource. operationId: CreditNote_removeResource description: Removes the CreditNote resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: CreditNote resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/credit_notes/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/credit_notes/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/credit_notes/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/credit_notes/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/credit_notes/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/credit_notes/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/credit_notes/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/credit_notes/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/credit_notes/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /customer_opening_balances: parameters: [] get: tags: - CustomerOpeningBalance summary: Retrieves the collection of CustomerOpeningBalance resources. operationId: CustomerOpeningBalance_getCollection description: Retrieves the collection of CustomerOpeningBalance resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: CustomerOpeningBalance collection content: application/json: schema: $ref: >- #/components/schemas/CustomerOpeningBalanceGetCollectionResponse application/xml: schema: $ref: >- #/components/schemas/CustomerOpeningBalanceGetCollection200Response text/xml: schema: $ref: >- #/components/schemas/CustomerOpeningBalanceGetCollection200Response text/csv: schema: $ref: >- #/components/schemas/CustomerOpeningBalanceGetCollection200Response text/html: schema: $ref: >- #/components/schemas/CustomerOpeningBalanceGetCollection200Response deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/customer_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/customer_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/customer_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/customer_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/customer_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/customer_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/customer_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/customer_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/customer_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /customer_opening_balances/{id}: parameters: [] get: tags: - CustomerOpeningBalance summary: Retrieves a CustomerOpeningBalance resource. operationId: CustomerOpeningBalance_getResource description: Retrieves a CustomerOpeningBalance resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: CustomerOpeningBalance resource content: application/json: schema: $ref: '#/components/schemas/CustomerOpeningBalanceGetResourceResponse' application/xml: schema: $ref: >- #/components/schemas/CustomerOpeningBalanceGetResource200Response text/xml: schema: $ref: >- #/components/schemas/CustomerOpeningBalanceGetResource200Response text/csv: schema: $ref: >- #/components/schemas/CustomerOpeningBalanceGetResource200Response text/html: schema: $ref: >- #/components/schemas/CustomerOpeningBalanceGetResource200Response '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/customer_opening_balances/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/customer_opening_balances/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/customer_opening_balances/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/customer_opening_balances/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/customer_opening_balances/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/customer_opening_balances/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/customer_opening_balances/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/customer_opening_balances/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/customer_opening_balances/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /customers: parameters: [] get: tags: - Customer summary: Retrieves the collection of Customer resources. operationId: Customer_getCollection description: Retrieves the collection of Customer resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Customer collection content: application/json: schema: $ref: '#/components/schemas/CustomerGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/CustomerGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/CustomerGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/CustomerGetCollection200Response' text/html: schema: $ref: '#/components/schemas/CustomerGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/customers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/customers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/customers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/customers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/customers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/customers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/customers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/customers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/customers?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - Customer summary: Creates a Customer resource. operationId: Customer_createResource description: Creates a Customer resource. parameters: [] requestBody: description: The new Customer resource content: application/json: schema: $ref: '#/components/schemas/CustomerCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/CustomerCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/CustomerCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/CustomerCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/CustomerCreateResourceRequest4' required: true responses: '201': description: Customer resource created content: application/json: schema: $ref: '#/components/schemas/CustomerCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/CustomerCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/CustomerCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/CustomerCreateResource201Response' text/html: schema: $ref: '#/components/schemas/CustomerCreateResource201Response' links: GetCustomerItem: operationId: getCustomerItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /customers/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"50\",\"email\":\"janedoe@email.com\",\"name\":\"Jane Doe\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Acme Corp.\",\"fullyQualifiedName\":\"Acme Corporation\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"postalCode\":\"99660\",\"country\":\"United States\",\"billingAddress\":\"4348 Candlelight Drive\",\"billingAddressLine2\":\"Apartment 78\",\"billingCity\":\"Panama City\",\"billingState\":\"Florida\",\"billingPostalCode\":\"32417\",\"billingCountry\":\"United States\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"ddi\":\"5050\",\"balance\":19999,\"currency\":\"USD\",\"taxable\":true,\"customerAccountStatus\":\"Enabled\",\"monthlyRecurringRevenue\":4500000,\"netMonthlyRecurringRevenue\":2500000,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"title\":\"Manager\",\"department\":\"Administrative office\",\"customerOwner\":\"josh_jameson\",\"description\":\"Great customer\",\"totalSpent\":76000,\"acceptsMarketing\":true,\"username\":\"jane_doe123\",\"taxType\":\"Global\",\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/customers") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/customers"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"50\",\"email\":\"janedoe@email.com\",\"name\":\"Jane Doe\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Acme Corp.\",\"fullyQualifiedName\":\"Acme Corporation\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"postalCode\":\"99660\",\"country\":\"United States\",\"billingAddress\":\"4348 Candlelight Drive\",\"billingAddressLine2\":\"Apartment 78\",\"billingCity\":\"Panama City\",\"billingState\":\"Florida\",\"billingPostalCode\":\"32417\",\"billingCountry\":\"United States\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"ddi\":\"5050\",\"balance\":19999,\"currency\":\"USD\",\"taxable\":true,\"customerAccountStatus\":\"Enabled\",\"monthlyRecurringRevenue\":4500000,\"netMonthlyRecurringRevenue\":2500000,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"title\":\"Manager\",\"department\":\"Administrative office\",\"customerOwner\":\"josh_jameson\",\"description\":\"Great customer\",\"totalSpent\":76000,\"acceptsMarketing\":true,\"username\":\"jane_doe123\",\"taxType\":\"Global\",\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/customers \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"50","email":"janedoe@email.com","name":"Jane Doe","givenName":"Jane","familyName":"Doe","companyName":"Acme Corp.","fullyQualifiedName":"Acme Corporation","address":"708 Woodland Avenue","addressLine2":"Unit 105","city":"St Paul","postalCode":"99660","country":"United States","billingAddress":"4348 Candlelight Drive","billingAddressLine2":"Apartment 78","billingCity":"Panama City","billingState":"Florida","billingPostalCode":"32417","billingCountry":"United States","phone":"281-381-4241","mobile":"786-258-0182","fax":"281-381-4255","ddi":"5050","balance":19999,"currency":"USD","taxable":true,"customerAccountStatus":"Enabled","monthlyRecurringRevenue":4500000,"netMonthlyRecurringRevenue":2500000,"created":"2013-11-18T02:17:40.080Z","modified":"2013-11-22T02:17:40.080Z","title":"Manager","department":"Administrative office","customerOwner":"josh_jameson","description":"Great customer","totalSpent":76000,"acceptsMarketing":true,"username":"jane_doe123","taxType":"Global","bankAccountName":"Business Bank Account","bankAccountNumber":"123654","termId":"1d80716b-427e-4cad-80c6-c4b3a18eb23d","termDays":"15","termType":"DAYSAFTERBILLDATE"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/customers", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"50\",\"email\":\"janedoe@email.com\",\"name\":\"Jane Doe\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Acme Corp.\",\"fullyQualifiedName\":\"Acme Corporation\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"postalCode\":\"99660\",\"country\":\"United States\",\"billingAddress\":\"4348 Candlelight Drive\",\"billingAddressLine2\":\"Apartment 78\",\"billingCity\":\"Panama City\",\"billingState\":\"Florida\",\"billingPostalCode\":\"32417\",\"billingCountry\":\"United States\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"ddi\":\"5050\",\"balance\":19999,\"currency\":\"USD\",\"taxable\":true,\"customerAccountStatus\":\"Enabled\",\"monthlyRecurringRevenue\":4500000,\"netMonthlyRecurringRevenue\":2500000,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"title\":\"Manager\",\"department\":\"Administrative office\",\"customerOwner\":\"josh_jameson\",\"description\":\"Great customer\",\"totalSpent\":76000,\"acceptsMarketing\":true,\"username\":\"jane_doe123\",\"taxType\":\"Global\",\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/customers") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"50\",\"email\":\"janedoe@email.com\",\"name\":\"Jane Doe\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Acme Corp.\",\"fullyQualifiedName\":\"Acme Corporation\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"postalCode\":\"99660\",\"country\":\"United States\",\"billingAddress\":\"4348 Candlelight Drive\",\"billingAddressLine2\":\"Apartment 78\",\"billingCity\":\"Panama City\",\"billingState\":\"Florida\",\"billingPostalCode\":\"32417\",\"billingCountry\":\"United States\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"ddi\":\"5050\",\"balance\":19999,\"currency\":\"USD\",\"taxable\":true,\"customerAccountStatus\":\"Enabled\",\"monthlyRecurringRevenue\":4500000,\"netMonthlyRecurringRevenue\":2500000,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"title\":\"Manager\",\"department\":\"Administrative office\",\"customerOwner\":\"josh_jameson\",\"description\":\"Great customer\",\"totalSpent\":76000,\"acceptsMarketing\":true,\"username\":\"jane_doe123\",\"taxType\":\"Global\",\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"50\",\"email\":\"janedoe@email.com\",\"name\":\"Jane Doe\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Acme Corp.\",\"fullyQualifiedName\":\"Acme Corporation\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"postalCode\":\"99660\",\"country\":\"United States\",\"billingAddress\":\"4348 Candlelight Drive\",\"billingAddressLine2\":\"Apartment 78\",\"billingCity\":\"Panama City\",\"billingState\":\"Florida\",\"billingPostalCode\":\"32417\",\"billingCountry\":\"United States\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"ddi\":\"5050\",\"balance\":19999,\"currency\":\"USD\",\"taxable\":true,\"customerAccountStatus\":\"Enabled\",\"monthlyRecurringRevenue\":4500000,\"netMonthlyRecurringRevenue\":2500000,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"title\":\"Manager\",\"department\":\"Administrative office\",\"customerOwner\":\"josh_jameson\",\"description\":\"Great customer\",\"totalSpent\":76000,\"acceptsMarketing\":true,\"username\":\"jane_doe123\",\"taxType\":\"Global\",\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/customers", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/customers\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"50\\\",\\\"email\\\":\\\"janedoe@email.com\\\",\\\"name\\\":\\\"Jane Doe\\\",\\\"givenName\\\":\\\"Jane\\\",\\\"familyName\\\":\\\"Doe\\\",\\\"companyName\\\":\\\"Acme Corp.\\\",\\\"fullyQualifiedName\\\":\\\"Acme Corporation\\\",\\\"address\\\":\\\"708 Woodland Avenue\\\",\\\"addressLine2\\\":\\\"Unit 105\\\",\\\"city\\\":\\\"St Paul\\\",\\\"postalCode\\\":\\\"99660\\\",\\\"country\\\":\\\"United States\\\",\\\"billingAddress\\\":\\\"4348 Candlelight Drive\\\",\\\"billingAddressLine2\\\":\\\"Apartment 78\\\",\\\"billingCity\\\":\\\"Panama City\\\",\\\"billingState\\\":\\\"Florida\\\",\\\"billingPostalCode\\\":\\\"32417\\\",\\\"billingCountry\\\":\\\"United States\\\",\\\"phone\\\":\\\"281-381-4241\\\",\\\"mobile\\\":\\\"786-258-0182\\\",\\\"fax\\\":\\\"281-381-4255\\\",\\\"ddi\\\":\\\"5050\\\",\\\"balance\\\":19999,\\\"currency\\\":\\\"USD\\\",\\\"taxable\\\":true,\\\"customerAccountStatus\\\":\\\"Enabled\\\",\\\"monthlyRecurringRevenue\\\":4500000,\\\"netMonthlyRecurringRevenue\\\":2500000,\\\"created\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"modified\\\":\\\"2013-11-22T02:17:40.080Z\\\",\\\"title\\\":\\\"Manager\\\",\\\"department\\\":\\\"Administrative office\\\",\\\"customerOwner\\\":\\\"josh_jameson\\\",\\\"description\\\":\\\"Great customer\\\",\\\"totalSpent\\\":76000,\\\"acceptsMarketing\\\":true,\\\"username\\\":\\\"jane_doe123\\\",\\\"taxType\\\":\\\"Global\\\",\\\"bankAccountName\\\":\\\"Business Bank Account\\\",\\\"bankAccountNumber\\\":\\\"123654\\\",\\\"termId\\\":\\\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\\\",\\\"termDays\\\":\\\"15\\\",\\\"termType\\\":\\\"DAYSAFTERBILLDATE\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/customers", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"50\",\"email\":\"janedoe@email.com\",\"name\":\"Jane Doe\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Acme Corp.\",\"fullyQualifiedName\":\"Acme Corporation\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"postalCode\":\"99660\",\"country\":\"United States\",\"billingAddress\":\"4348 Candlelight Drive\",\"billingAddressLine2\":\"Apartment 78\",\"billingCity\":\"Panama City\",\"billingState\":\"Florida\",\"billingPostalCode\":\"32417\",\"billingCountry\":\"United States\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"ddi\":\"5050\",\"balance\":19999,\"currency\":\"USD\",\"taxable\":true,\"customerAccountStatus\":\"Enabled\",\"monthlyRecurringRevenue\":4500000,\"netMonthlyRecurringRevenue\":2500000,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"title\":\"Manager\",\"department\":\"Administrative office\",\"customerOwner\":\"josh_jameson\",\"description\":\"Great customer\",\"totalSpent\":76000,\"acceptsMarketing\":true,\"username\":\"jane_doe123\",\"taxType\":\"Global\",\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/customers", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '50', email: 'janedoe@email.com', name: 'Jane Doe', givenName: 'Jane', familyName: 'Doe', companyName: 'Acme Corp.', fullyQualifiedName: 'Acme Corporation', address: '708 Woodland Avenue', addressLine2: 'Unit 105', city: 'St Paul', postalCode: '99660', country: 'United States', billingAddress: '4348 Candlelight Drive', billingAddressLine2: 'Apartment 78', billingCity: 'Panama City', billingState: 'Florida', billingPostalCode: '32417', billingCountry: 'United States', phone: '281-381-4241', mobile: '786-258-0182', fax: '281-381-4255', ddi: '5050', balance: 19999, currency: 'USD', taxable: true, customerAccountStatus: 'Enabled', monthlyRecurringRevenue: 4500000, netMonthlyRecurringRevenue: 2500000, created: '2013-11-18T02:17:40.080Z', modified: '2013-11-22T02:17:40.080Z', title: 'Manager', department: 'Administrative office', customerOwner: 'josh_jameson', description: 'Great customer', totalSpent: 76000, acceptsMarketing: true, username: 'jane_doe123', taxType: 'Global', bankAccountName: 'Business Bank Account', bankAccountNumber: '123654', termId: '1d80716b-427e-4cad-80c6-c4b3a18eb23d', termDays: '15', termType: 'DAYSAFTERBILLDATE' })); req.end(); /customers/{id}: parameters: [] get: tags: - Customer summary: Retrieves a Customer resource. operationId: Customer_getResource description: Retrieves a Customer resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Customer resource content: application/json: schema: $ref: '#/components/schemas/CustomerGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/CustomerGetResource200Response' text/xml: schema: $ref: '#/components/schemas/CustomerGetResource200Response' text/csv: schema: $ref: '#/components/schemas/CustomerGetResource200Response' text/html: schema: $ref: '#/components/schemas/CustomerGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/customers/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/customers/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/customers/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/customers/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/customers/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/customers/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/customers/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/customers/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/customers/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - Customer summary: Replaces the Customer resource. operationId: Customer_replaceResource description: Replaces the Customer resource. parameters: - description: Resource identifier name: id in: path 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/CustomerReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/CustomerReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/CustomerReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/CustomerReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/CustomerReplaceResourceRequest4' required: true responses: '200': description: Customer resource updated content: application/json: schema: $ref: '#/components/schemas/CustomerReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/CustomerReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/CustomerReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/CustomerReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/CustomerReplaceResource200Response' links: GetCustomerItem: operationId: getCustomerItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /customers/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"50\",\"email\":\"janedoe@email.com\",\"name\":\"Jane Doe\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Acme Corp.\",\"fullyQualifiedName\":\"Acme Corporation\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"postalCode\":\"99660\",\"country\":\"United States\",\"billingAddress\":\"4348 Candlelight Drive\",\"billingAddressLine2\":\"Apartment 78\",\"billingCity\":\"Panama City\",\"billingState\":\"Florida\",\"billingPostalCode\":\"32417\",\"billingCountry\":\"United States\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"ddi\":\"5050\",\"balance\":19999,\"currency\":\"USD\",\"taxable\":true,\"customerAccountStatus\":\"Enabled\",\"monthlyRecurringRevenue\":4500000,\"netMonthlyRecurringRevenue\":2500000,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"title\":\"Manager\",\"department\":\"Administrative office\",\"customerOwner\":\"josh_jameson\",\"description\":\"Great customer\",\"totalSpent\":76000,\"acceptsMarketing\":true,\"username\":\"jane_doe123\",\"taxType\":\"Global\",\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/customers/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/customers/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"50\",\"email\":\"janedoe@email.com\",\"name\":\"Jane Doe\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Acme Corp.\",\"fullyQualifiedName\":\"Acme Corporation\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"postalCode\":\"99660\",\"country\":\"United States\",\"billingAddress\":\"4348 Candlelight Drive\",\"billingAddressLine2\":\"Apartment 78\",\"billingCity\":\"Panama City\",\"billingState\":\"Florida\",\"billingPostalCode\":\"32417\",\"billingCountry\":\"United States\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"ddi\":\"5050\",\"balance\":19999,\"currency\":\"USD\",\"taxable\":true,\"customerAccountStatus\":\"Enabled\",\"monthlyRecurringRevenue\":4500000,\"netMonthlyRecurringRevenue\":2500000,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"title\":\"Manager\",\"department\":\"Administrative office\",\"customerOwner\":\"josh_jameson\",\"description\":\"Great customer\",\"totalSpent\":76000,\"acceptsMarketing\":true,\"username\":\"jane_doe123\",\"taxType\":\"Global\",\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/customers/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"50","email":"janedoe@email.com","name":"Jane Doe","givenName":"Jane","familyName":"Doe","companyName":"Acme Corp.","fullyQualifiedName":"Acme Corporation","address":"708 Woodland Avenue","addressLine2":"Unit 105","city":"St Paul","postalCode":"99660","country":"United States","billingAddress":"4348 Candlelight Drive","billingAddressLine2":"Apartment 78","billingCity":"Panama City","billingState":"Florida","billingPostalCode":"32417","billingCountry":"United States","phone":"281-381-4241","mobile":"786-258-0182","fax":"281-381-4255","ddi":"5050","balance":19999,"currency":"USD","taxable":true,"customerAccountStatus":"Enabled","monthlyRecurringRevenue":4500000,"netMonthlyRecurringRevenue":2500000,"created":"2013-11-18T02:17:40.080Z","modified":"2013-11-22T02:17:40.080Z","title":"Manager","department":"Administrative office","customerOwner":"josh_jameson","description":"Great customer","totalSpent":76000,"acceptsMarketing":true,"username":"jane_doe123","taxType":"Global","bankAccountName":"Business Bank Account","bankAccountNumber":"123654","termId":"1d80716b-427e-4cad-80c6-c4b3a18eb23d","termDays":"15","termType":"DAYSAFTERBILLDATE"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/customers/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"50\",\"email\":\"janedoe@email.com\",\"name\":\"Jane Doe\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Acme Corp.\",\"fullyQualifiedName\":\"Acme Corporation\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"postalCode\":\"99660\",\"country\":\"United States\",\"billingAddress\":\"4348 Candlelight Drive\",\"billingAddressLine2\":\"Apartment 78\",\"billingCity\":\"Panama City\",\"billingState\":\"Florida\",\"billingPostalCode\":\"32417\",\"billingCountry\":\"United States\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"ddi\":\"5050\",\"balance\":19999,\"currency\":\"USD\",\"taxable\":true,\"customerAccountStatus\":\"Enabled\",\"monthlyRecurringRevenue\":4500000,\"netMonthlyRecurringRevenue\":2500000,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"title\":\"Manager\",\"department\":\"Administrative office\",\"customerOwner\":\"josh_jameson\",\"description\":\"Great customer\",\"totalSpent\":76000,\"acceptsMarketing\":true,\"username\":\"jane_doe123\",\"taxType\":\"Global\",\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/customers/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"50\",\"email\":\"janedoe@email.com\",\"name\":\"Jane Doe\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Acme Corp.\",\"fullyQualifiedName\":\"Acme Corporation\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"postalCode\":\"99660\",\"country\":\"United States\",\"billingAddress\":\"4348 Candlelight Drive\",\"billingAddressLine2\":\"Apartment 78\",\"billingCity\":\"Panama City\",\"billingState\":\"Florida\",\"billingPostalCode\":\"32417\",\"billingCountry\":\"United States\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"ddi\":\"5050\",\"balance\":19999,\"currency\":\"USD\",\"taxable\":true,\"customerAccountStatus\":\"Enabled\",\"monthlyRecurringRevenue\":4500000,\"netMonthlyRecurringRevenue\":2500000,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"title\":\"Manager\",\"department\":\"Administrative office\",\"customerOwner\":\"josh_jameson\",\"description\":\"Great customer\",\"totalSpent\":76000,\"acceptsMarketing\":true,\"username\":\"jane_doe123\",\"taxType\":\"Global\",\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"50\",\"email\":\"janedoe@email.com\",\"name\":\"Jane Doe\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Acme Corp.\",\"fullyQualifiedName\":\"Acme Corporation\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"postalCode\":\"99660\",\"country\":\"United States\",\"billingAddress\":\"4348 Candlelight Drive\",\"billingAddressLine2\":\"Apartment 78\",\"billingCity\":\"Panama City\",\"billingState\":\"Florida\",\"billingPostalCode\":\"32417\",\"billingCountry\":\"United States\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"ddi\":\"5050\",\"balance\":19999,\"currency\":\"USD\",\"taxable\":true,\"customerAccountStatus\":\"Enabled\",\"monthlyRecurringRevenue\":4500000,\"netMonthlyRecurringRevenue\":2500000,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"title\":\"Manager\",\"department\":\"Administrative office\",\"customerOwner\":\"josh_jameson\",\"description\":\"Great customer\",\"totalSpent\":76000,\"acceptsMarketing\":true,\"username\":\"jane_doe123\",\"taxType\":\"Global\",\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/customers/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/customers/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"50\\\",\\\"email\\\":\\\"janedoe@email.com\\\",\\\"name\\\":\\\"Jane Doe\\\",\\\"givenName\\\":\\\"Jane\\\",\\\"familyName\\\":\\\"Doe\\\",\\\"companyName\\\":\\\"Acme Corp.\\\",\\\"fullyQualifiedName\\\":\\\"Acme Corporation\\\",\\\"address\\\":\\\"708 Woodland Avenue\\\",\\\"addressLine2\\\":\\\"Unit 105\\\",\\\"city\\\":\\\"St Paul\\\",\\\"postalCode\\\":\\\"99660\\\",\\\"country\\\":\\\"United States\\\",\\\"billingAddress\\\":\\\"4348 Candlelight Drive\\\",\\\"billingAddressLine2\\\":\\\"Apartment 78\\\",\\\"billingCity\\\":\\\"Panama City\\\",\\\"billingState\\\":\\\"Florida\\\",\\\"billingPostalCode\\\":\\\"32417\\\",\\\"billingCountry\\\":\\\"United States\\\",\\\"phone\\\":\\\"281-381-4241\\\",\\\"mobile\\\":\\\"786-258-0182\\\",\\\"fax\\\":\\\"281-381-4255\\\",\\\"ddi\\\":\\\"5050\\\",\\\"balance\\\":19999,\\\"currency\\\":\\\"USD\\\",\\\"taxable\\\":true,\\\"customerAccountStatus\\\":\\\"Enabled\\\",\\\"monthlyRecurringRevenue\\\":4500000,\\\"netMonthlyRecurringRevenue\\\":2500000,\\\"created\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"modified\\\":\\\"2013-11-22T02:17:40.080Z\\\",\\\"title\\\":\\\"Manager\\\",\\\"department\\\":\\\"Administrative office\\\",\\\"customerOwner\\\":\\\"josh_jameson\\\",\\\"description\\\":\\\"Great customer\\\",\\\"totalSpent\\\":76000,\\\"acceptsMarketing\\\":true,\\\"username\\\":\\\"jane_doe123\\\",\\\"taxType\\\":\\\"Global\\\",\\\"bankAccountName\\\":\\\"Business Bank Account\\\",\\\"bankAccountNumber\\\":\\\"123654\\\",\\\"termId\\\":\\\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\\\",\\\"termDays\\\":\\\"15\\\",\\\"termType\\\":\\\"DAYSAFTERBILLDATE\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/customers/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"50\",\"email\":\"janedoe@email.com\",\"name\":\"Jane Doe\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Acme Corp.\",\"fullyQualifiedName\":\"Acme Corporation\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"postalCode\":\"99660\",\"country\":\"United States\",\"billingAddress\":\"4348 Candlelight Drive\",\"billingAddressLine2\":\"Apartment 78\",\"billingCity\":\"Panama City\",\"billingState\":\"Florida\",\"billingPostalCode\":\"32417\",\"billingCountry\":\"United States\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"ddi\":\"5050\",\"balance\":19999,\"currency\":\"USD\",\"taxable\":true,\"customerAccountStatus\":\"Enabled\",\"monthlyRecurringRevenue\":4500000,\"netMonthlyRecurringRevenue\":2500000,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"title\":\"Manager\",\"department\":\"Administrative office\",\"customerOwner\":\"josh_jameson\",\"description\":\"Great customer\",\"totalSpent\":76000,\"acceptsMarketing\":true,\"username\":\"jane_doe123\",\"taxType\":\"Global\",\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/customers/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '50', email: 'janedoe@email.com', name: 'Jane Doe', givenName: 'Jane', familyName: 'Doe', companyName: 'Acme Corp.', fullyQualifiedName: 'Acme Corporation', address: '708 Woodland Avenue', addressLine2: 'Unit 105', city: 'St Paul', postalCode: '99660', country: 'United States', billingAddress: '4348 Candlelight Drive', billingAddressLine2: 'Apartment 78', billingCity: 'Panama City', billingState: 'Florida', billingPostalCode: '32417', billingCountry: 'United States', phone: '281-381-4241', mobile: '786-258-0182', fax: '281-381-4255', ddi: '5050', balance: 19999, currency: 'USD', taxable: true, customerAccountStatus: 'Enabled', monthlyRecurringRevenue: 4500000, netMonthlyRecurringRevenue: 2500000, created: '2013-11-18T02:17:40.080Z', modified: '2013-11-22T02:17:40.080Z', title: 'Manager', department: 'Administrative office', customerOwner: 'josh_jameson', description: 'Great customer', totalSpent: 76000, acceptsMarketing: true, username: 'jane_doe123', taxType: 'Global', bankAccountName: 'Business Bank Account', bankAccountNumber: '123654', termId: '1d80716b-427e-4cad-80c6-c4b3a18eb23d', termDays: '15', termType: 'DAYSAFTERBILLDATE' })); req.end(); delete: tags: - Customer summary: Removes the Customer resource. operationId: Customer_removeResource description: Removes the Customer resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: Customer resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/customers/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/customers/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/customers/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/customers/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/customers/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/customers/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/customers/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/customers/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/customers/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /data_sync: parameters: [] get: tags: - DataSync summary: >- Syncs the latest data from a connected application and returns a success or failure message. operationId: DataSync_getResource description: Retrieves a DataSync resource. parameters: - description: 'The key of the application you would like to sync. ' name: key in: query required: true deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false example: quickbooks responses: '200': description: DataSync resource content: application/json: schema: $ref: '#/components/schemas/DataSyncGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/DataSyncGetResource200Response' text/xml: schema: $ref: '#/components/schemas/DataSyncGetResource200Response' text/csv: schema: $ref: '#/components/schemas/DataSyncGetResource200Response' text/html: schema: $ref: '#/components/schemas/DataSyncGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/data_sync?key=SOME_STRING_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/data_sync?key=SOME_STRING_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/data_sync?key=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/data_sync?key=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/data_sync?key=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/data_sync?key=SOME_STRING_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/data_sync?key=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/data_sync?key=SOME_STRING_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/data_sync?key=SOME_STRING_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /deals: parameters: [] get: tags: - Deal summary: Retrieves the collection of Deal resources. operationId: Deal_getCollection description: Retrieves the collection of Deal resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Deal collection content: application/json: schema: $ref: '#/components/schemas/DealGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/DealGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/DealGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/DealGetCollection200Response' text/html: schema: $ref: '#/components/schemas/DealGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/deals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/deals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/deals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/deals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/deals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/deals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/deals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/deals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/deals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - Deal summary: Creates a Deal resource. operationId: Deal_createResource description: Creates a Deal resource. parameters: [] requestBody: description: The new Deal resource content: application/json: schema: $ref: '#/components/schemas/DealCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/DealCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/DealCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/DealCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/DealCreateResourceRequest4' required: true responses: '201': description: Deal resource created content: application/json: schema: $ref: '#/components/schemas/DealCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/DealCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/DealCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/DealCreateResource201Response' text/html: schema: $ref: '#/components/schemas/DealCreateResource201Response' links: GetDealItem: operationId: getDealItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /deals/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"ownerId\":\"string\",\"ownerName\":\"Dave Simpson\",\"stage\":\"decision\",\"dealName\":\"string\",\"description\":\"string\",\"prospectId\":\"string\",\"prospectName\":\"string\",\"expectedRevenue\":0,\"currency\":\"USD\",\"created\":\"2021-07-28 00:00:00\",\"closed\":\"2021-07-28 00:00:00\",\"associatedContactIds\":[\"string\"],\"associatedCompanyIds\":[\"string\"],\"numAssociatedContacts\":5}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/deals") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/deals"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"ownerId\":\"string\",\"ownerName\":\"Dave Simpson\",\"stage\":\"decision\",\"dealName\":\"string\",\"description\":\"string\",\"prospectId\":\"string\",\"prospectName\":\"string\",\"expectedRevenue\":0,\"currency\":\"USD\",\"created\":\"2021-07-28 00:00:00\",\"closed\":\"2021-07-28 00:00:00\",\"associatedContactIds\":[\"string\"],\"associatedCompanyIds\":[\"string\"],\"numAssociatedContacts\":5}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/deals \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"706f68c5-46b2-43d8-9aa8-41d1cc2a317f","ownerId":"string","ownerName":"Dave Simpson","stage":"decision","dealName":"string","description":"string","prospectId":"string","prospectName":"string","expectedRevenue":0,"currency":"USD","created":"2021-07-28 00:00:00","closed":"2021-07-28 00:00:00","associatedContactIds":["string"],"associatedCompanyIds":["string"],"numAssociatedContacts":5}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/deals", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"ownerId\":\"string\",\"ownerName\":\"Dave Simpson\",\"stage\":\"decision\",\"dealName\":\"string\",\"description\":\"string\",\"prospectId\":\"string\",\"prospectName\":\"string\",\"expectedRevenue\":0,\"currency\":\"USD\",\"created\":\"2021-07-28 00:00:00\",\"closed\":\"2021-07-28 00:00:00\",\"associatedContactIds\":[\"string\"],\"associatedCompanyIds\":[\"string\"],\"numAssociatedContacts\":5}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/deals") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"ownerId\":\"string\",\"ownerName\":\"Dave Simpson\",\"stage\":\"decision\",\"dealName\":\"string\",\"description\":\"string\",\"prospectId\":\"string\",\"prospectName\":\"string\",\"expectedRevenue\":0,\"currency\":\"USD\",\"created\":\"2021-07-28 00:00:00\",\"closed\":\"2021-07-28 00:00:00\",\"associatedContactIds\":[\"string\"],\"associatedCompanyIds\":[\"string\"],\"numAssociatedContacts\":5}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"ownerId\":\"string\",\"ownerName\":\"Dave Simpson\",\"stage\":\"decision\",\"dealName\":\"string\",\"description\":\"string\",\"prospectId\":\"string\",\"prospectName\":\"string\",\"expectedRevenue\":0,\"currency\":\"USD\",\"created\":\"2021-07-28 00:00:00\",\"closed\":\"2021-07-28 00:00:00\",\"associatedContactIds\":[\"string\"],\"associatedCompanyIds\":[\"string\"],\"numAssociatedContacts\":5}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/deals", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/deals\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\\\",\\\"ownerId\\\":\\\"string\\\",\\\"ownerName\\\":\\\"Dave Simpson\\\",\\\"stage\\\":\\\"decision\\\",\\\"dealName\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"prospectId\\\":\\\"string\\\",\\\"prospectName\\\":\\\"string\\\",\\\"expectedRevenue\\\":0,\\\"currency\\\":\\\"USD\\\",\\\"created\\\":\\\"2021-07-28 00:00:00\\\",\\\"closed\\\":\\\"2021-07-28 00:00:00\\\",\\\"associatedContactIds\\\":[\\\"string\\\"],\\\"associatedCompanyIds\\\":[\\\"string\\\"],\\\"numAssociatedContacts\\\":5}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/deals", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"ownerId\":\"string\",\"ownerName\":\"Dave Simpson\",\"stage\":\"decision\",\"dealName\":\"string\",\"description\":\"string\",\"prospectId\":\"string\",\"prospectName\":\"string\",\"expectedRevenue\":0,\"currency\":\"USD\",\"created\":\"2021-07-28 00:00:00\",\"closed\":\"2021-07-28 00:00:00\",\"associatedContactIds\":[\"string\"],\"associatedCompanyIds\":[\"string\"],\"numAssociatedContacts\":5}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/deals", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '706f68c5-46b2-43d8-9aa8-41d1cc2a317f', ownerId: 'string', ownerName: 'Dave Simpson', stage: 'decision', dealName: 'string', description: 'string', prospectId: 'string', prospectName: 'string', expectedRevenue: 0, currency: 'USD', created: '2021-07-28 00:00:00', closed: '2021-07-28 00:00:00', associatedContactIds: ['string'], associatedCompanyIds: ['string'], numAssociatedContacts: 5 })); req.end(); /deals/{id}: parameters: [] get: tags: - Deal summary: Retrieves a Deal resource. operationId: Deal_getResource description: Retrieves a Deal resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Deal resource content: application/json: schema: $ref: '#/components/schemas/DealGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/DealGetResource200Response' text/xml: schema: $ref: '#/components/schemas/DealGetResource200Response' text/csv: schema: $ref: '#/components/schemas/DealGetResource200Response' text/html: schema: $ref: '#/components/schemas/DealGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/deals/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/deals/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/deals/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/deals/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/deals/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/deals/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/deals/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/deals/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/deals/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - Deal summary: Replaces the Deal resource. operationId: Deal_updateResource description: Replaces the Deal resource. parameters: - description: Resource identifier name: id in: path 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/DealUpdateResourceRequest' application/xml: schema: $ref: '#/components/schemas/DealUpdateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/DealUpdateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/DealUpdateResourceRequest3' text/html: schema: $ref: '#/components/schemas/DealUpdateResourceRequest4' required: true responses: '200': description: Deal resource updated content: application/json: schema: $ref: '#/components/schemas/DealUpdateResourceResponse' application/xml: schema: $ref: '#/components/schemas/DealUpdateResource200Response' text/xml: schema: $ref: '#/components/schemas/DealUpdateResource200Response' text/csv: schema: $ref: '#/components/schemas/DealUpdateResource200Response' text/html: schema: $ref: '#/components/schemas/DealUpdateResource200Response' links: GetDealItem: operationId: getDealItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /deals/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"ownerId\":\"string\",\"ownerName\":\"Dave Simpson\",\"stage\":\"decision\",\"dealName\":\"string\",\"description\":\"string\",\"prospectId\":\"string\",\"prospectName\":\"string\",\"expectedRevenue\":0,\"currency\":\"USD\",\"created\":\"2021-07-28 00:00:00\",\"closed\":\"2021-07-28 00:00:00\",\"associatedContactIds\":[\"string\"],\"associatedCompanyIds\":[\"string\"],\"numAssociatedContacts\":5}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/deals/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/deals/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"ownerId\":\"string\",\"ownerName\":\"Dave Simpson\",\"stage\":\"decision\",\"dealName\":\"string\",\"description\":\"string\",\"prospectId\":\"string\",\"prospectName\":\"string\",\"expectedRevenue\":0,\"currency\":\"USD\",\"created\":\"2021-07-28 00:00:00\",\"closed\":\"2021-07-28 00:00:00\",\"associatedContactIds\":[\"string\"],\"associatedCompanyIds\":[\"string\"],\"numAssociatedContacts\":5}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/deals/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"706f68c5-46b2-43d8-9aa8-41d1cc2a317f","ownerId":"string","ownerName":"Dave Simpson","stage":"decision","dealName":"string","description":"string","prospectId":"string","prospectName":"string","expectedRevenue":0,"currency":"USD","created":"2021-07-28 00:00:00","closed":"2021-07-28 00:00:00","associatedContactIds":["string"],"associatedCompanyIds":["string"],"numAssociatedContacts":5}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/deals/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"ownerId\":\"string\",\"ownerName\":\"Dave Simpson\",\"stage\":\"decision\",\"dealName\":\"string\",\"description\":\"string\",\"prospectId\":\"string\",\"prospectName\":\"string\",\"expectedRevenue\":0,\"currency\":\"USD\",\"created\":\"2021-07-28 00:00:00\",\"closed\":\"2021-07-28 00:00:00\",\"associatedContactIds\":[\"string\"],\"associatedCompanyIds\":[\"string\"],\"numAssociatedContacts\":5}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/deals/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"ownerId\":\"string\",\"ownerName\":\"Dave Simpson\",\"stage\":\"decision\",\"dealName\":\"string\",\"description\":\"string\",\"prospectId\":\"string\",\"prospectName\":\"string\",\"expectedRevenue\":0,\"currency\":\"USD\",\"created\":\"2021-07-28 00:00:00\",\"closed\":\"2021-07-28 00:00:00\",\"associatedContactIds\":[\"string\"],\"associatedCompanyIds\":[\"string\"],\"numAssociatedContacts\":5}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"ownerId\":\"string\",\"ownerName\":\"Dave Simpson\",\"stage\":\"decision\",\"dealName\":\"string\",\"description\":\"string\",\"prospectId\":\"string\",\"prospectName\":\"string\",\"expectedRevenue\":0,\"currency\":\"USD\",\"created\":\"2021-07-28 00:00:00\",\"closed\":\"2021-07-28 00:00:00\",\"associatedContactIds\":[\"string\"],\"associatedCompanyIds\":[\"string\"],\"numAssociatedContacts\":5}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/deals/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/deals/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\\\",\\\"ownerId\\\":\\\"string\\\",\\\"ownerName\\\":\\\"Dave Simpson\\\",\\\"stage\\\":\\\"decision\\\",\\\"dealName\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"prospectId\\\":\\\"string\\\",\\\"prospectName\\\":\\\"string\\\",\\\"expectedRevenue\\\":0,\\\"currency\\\":\\\"USD\\\",\\\"created\\\":\\\"2021-07-28 00:00:00\\\",\\\"closed\\\":\\\"2021-07-28 00:00:00\\\",\\\"associatedContactIds\\\":[\\\"string\\\"],\\\"associatedCompanyIds\\\":[\\\"string\\\"],\\\"numAssociatedContacts\\\":5}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/deals/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"ownerId\":\"string\",\"ownerName\":\"Dave Simpson\",\"stage\":\"decision\",\"dealName\":\"string\",\"description\":\"string\",\"prospectId\":\"string\",\"prospectName\":\"string\",\"expectedRevenue\":0,\"currency\":\"USD\",\"created\":\"2021-07-28 00:00:00\",\"closed\":\"2021-07-28 00:00:00\",\"associatedContactIds\":[\"string\"],\"associatedCompanyIds\":[\"string\"],\"numAssociatedContacts\":5}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/deals/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '706f68c5-46b2-43d8-9aa8-41d1cc2a317f', ownerId: 'string', ownerName: 'Dave Simpson', stage: 'decision', dealName: 'string', description: 'string', prospectId: 'string', prospectName: 'string', expectedRevenue: 0, currency: 'USD', created: '2021-07-28 00:00:00', closed: '2021-07-28 00:00:00', associatedContactIds: ['string'], associatedCompanyIds: ['string'], numAssociatedContacts: 5 })); req.end(); delete: tags: - Deal summary: Removes the Deal resource. operationId: Deal_removeResource description: Removes the Deal resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: Deal resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/deals/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/deals/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/deals/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/deals/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/deals/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/deals/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/deals/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/deals/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/deals/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /departments: parameters: [] get: tags: - Department summary: Retrieves the collection of Department resources. operationId: Department_getCollection description: Retrieves the collection of Department resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Department collection content: application/json: schema: $ref: '#/components/schemas/DepartmentGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/DepartmentGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/DepartmentGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/DepartmentGetCollection200Response' text/html: schema: $ref: '#/components/schemas/DepartmentGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/departments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/departments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/departments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/departments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/departments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/departments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/departments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/departments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/departments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /departments/{id}: parameters: [] get: tags: - Department summary: Retrieves a Department resource. operationId: Department_getResource description: Retrieves a Department resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Department resource content: application/json: schema: $ref: '#/components/schemas/DepartmentGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/DepartmentGetResource200Response' text/xml: schema: $ref: '#/components/schemas/DepartmentGetResource200Response' text/csv: schema: $ref: '#/components/schemas/DepartmentGetResource200Response' text/html: schema: $ref: '#/components/schemas/DepartmentGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/departments/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/departments/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/departments/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/departments/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/departments/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/departments/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/departments/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/departments/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/departments/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /employees: parameters: [] get: tags: - Employee summary: Retrieves the collection of Employee resources. operationId: Employee_getCollection description: Retrieves the collection of Employee resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Employee collection content: application/json: schema: $ref: '#/components/schemas/EmployeeGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/EmployeeGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/EmployeeGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/EmployeeGetCollection200Response' text/html: schema: $ref: '#/components/schemas/EmployeeGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/employees?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/employees?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/employees?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/employees?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/employees?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/employees?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/employees?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/employees?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/employees?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - Employee summary: Creates a Employee resource. operationId: Employee_createResource description: Creates a Employee resource. parameters: [] requestBody: description: The new Employee resource content: application/json: schema: $ref: '#/components/schemas/EmployeeCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/EmployeeCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/EmployeeCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/EmployeeCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/EmployeeCreateResourceRequest4' required: true responses: '201': description: Employee resource created content: application/json: schema: $ref: '#/components/schemas/EmployeeCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/EmployeeCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/EmployeeCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/EmployeeCreateResource201Response' text/html: schema: $ref: '#/components/schemas/EmployeeCreateResource201Response' links: GetEmployeeItem: operationId: getEmployeeItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /employees/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"firstName\":\"Steve\",\"lastName\":\"James\",\"fullName\":\"Steve James\",\"active\":true,\"primaryPhone\":\"4168769854\",\"primaryAddr\":\"451 Lincoln street\",\"primaryAddrCity\":\"Toronto\",\"primaryAddrPostalcode\":\"L8H Y5F\",\"primaryAddrState\":\"California\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"link\":\"steve.james.com\",\"email\":\"steve.james@gmail.com\",\"mobilePhone\":\"4167854398\",\"payRate\":\"20\",\"title\":\"Mr\",\"gender\":\"Female\",\"birthDate\":\"2021-06-24\",\"hiredDate\":\"2021-06-24\",\"employeeNumber\":\"Female\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/employees") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/employees"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"firstName\":\"Steve\",\"lastName\":\"James\",\"fullName\":\"Steve James\",\"active\":true,\"primaryPhone\":\"4168769854\",\"primaryAddr\":\"451 Lincoln street\",\"primaryAddrCity\":\"Toronto\",\"primaryAddrPostalcode\":\"L8H Y5F\",\"primaryAddrState\":\"California\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"link\":\"steve.james.com\",\"email\":\"steve.james@gmail.com\",\"mobilePhone\":\"4167854398\",\"payRate\":\"20\",\"title\":\"Mr\",\"gender\":\"Female\",\"birthDate\":\"2021-06-24\",\"hiredDate\":\"2021-06-24\",\"employeeNumber\":\"Female\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/employees \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"706f68c5-46b2-43d8-9aa8-41d1cc2a317f","firstName":"Steve","lastName":"James","fullName":"Steve James","active":true,"primaryPhone":"4168769854","primaryAddr":"451 Lincoln street","primaryAddrCity":"Toronto","primaryAddrPostalcode":"L8H Y5F","primaryAddrState":"California","created":"2021-06-24 22:35:07","modified":"2021-06-24 22:35:07","link":"steve.james.com","email":"steve.james@gmail.com","mobilePhone":"4167854398","payRate":"20","title":"Mr","gender":"Female","birthDate":"2021-06-24","hiredDate":"2021-06-24","employeeNumber":"Female"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/employees", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"firstName\":\"Steve\",\"lastName\":\"James\",\"fullName\":\"Steve James\",\"active\":true,\"primaryPhone\":\"4168769854\",\"primaryAddr\":\"451 Lincoln street\",\"primaryAddrCity\":\"Toronto\",\"primaryAddrPostalcode\":\"L8H Y5F\",\"primaryAddrState\":\"California\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"link\":\"steve.james.com\",\"email\":\"steve.james@gmail.com\",\"mobilePhone\":\"4167854398\",\"payRate\":\"20\",\"title\":\"Mr\",\"gender\":\"Female\",\"birthDate\":\"2021-06-24\",\"hiredDate\":\"2021-06-24\",\"employeeNumber\":\"Female\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/employees") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"firstName\":\"Steve\",\"lastName\":\"James\",\"fullName\":\"Steve James\",\"active\":true,\"primaryPhone\":\"4168769854\",\"primaryAddr\":\"451 Lincoln street\",\"primaryAddrCity\":\"Toronto\",\"primaryAddrPostalcode\":\"L8H Y5F\",\"primaryAddrState\":\"California\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"link\":\"steve.james.com\",\"email\":\"steve.james@gmail.com\",\"mobilePhone\":\"4167854398\",\"payRate\":\"20\",\"title\":\"Mr\",\"gender\":\"Female\",\"birthDate\":\"2021-06-24\",\"hiredDate\":\"2021-06-24\",\"employeeNumber\":\"Female\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"firstName\":\"Steve\",\"lastName\":\"James\",\"fullName\":\"Steve James\",\"active\":true,\"primaryPhone\":\"4168769854\",\"primaryAddr\":\"451 Lincoln street\",\"primaryAddrCity\":\"Toronto\",\"primaryAddrPostalcode\":\"L8H Y5F\",\"primaryAddrState\":\"California\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"link\":\"steve.james.com\",\"email\":\"steve.james@gmail.com\",\"mobilePhone\":\"4167854398\",\"payRate\":\"20\",\"title\":\"Mr\",\"gender\":\"Female\",\"birthDate\":\"2021-06-24\",\"hiredDate\":\"2021-06-24\",\"employeeNumber\":\"Female\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/employees", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/employees\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\\\",\\\"firstName\\\":\\\"Steve\\\",\\\"lastName\\\":\\\"James\\\",\\\"fullName\\\":\\\"Steve James\\\",\\\"active\\\":true,\\\"primaryPhone\\\":\\\"4168769854\\\",\\\"primaryAddr\\\":\\\"451 Lincoln street\\\",\\\"primaryAddrCity\\\":\\\"Toronto\\\",\\\"primaryAddrPostalcode\\\":\\\"L8H Y5F\\\",\\\"primaryAddrState\\\":\\\"California\\\",\\\"created\\\":\\\"2021-06-24 22:35:07\\\",\\\"modified\\\":\\\"2021-06-24 22:35:07\\\",\\\"link\\\":\\\"steve.james.com\\\",\\\"email\\\":\\\"steve.james@gmail.com\\\",\\\"mobilePhone\\\":\\\"4167854398\\\",\\\"payRate\\\":\\\"20\\\",\\\"title\\\":\\\"Mr\\\",\\\"gender\\\":\\\"Female\\\",\\\"birthDate\\\":\\\"2021-06-24\\\",\\\"hiredDate\\\":\\\"2021-06-24\\\",\\\"employeeNumber\\\":\\\"Female\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/employees", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"firstName\":\"Steve\",\"lastName\":\"James\",\"fullName\":\"Steve James\",\"active\":true,\"primaryPhone\":\"4168769854\",\"primaryAddr\":\"451 Lincoln street\",\"primaryAddrCity\":\"Toronto\",\"primaryAddrPostalcode\":\"L8H Y5F\",\"primaryAddrState\":\"California\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"link\":\"steve.james.com\",\"email\":\"steve.james@gmail.com\",\"mobilePhone\":\"4167854398\",\"payRate\":\"20\",\"title\":\"Mr\",\"gender\":\"Female\",\"birthDate\":\"2021-06-24\",\"hiredDate\":\"2021-06-24\",\"employeeNumber\":\"Female\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/employees", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '706f68c5-46b2-43d8-9aa8-41d1cc2a317f', firstName: 'Steve', lastName: 'James', fullName: 'Steve James', active: true, primaryPhone: '4168769854', primaryAddr: '451 Lincoln street', primaryAddrCity: 'Toronto', primaryAddrPostalcode: 'L8H Y5F', primaryAddrState: 'California', created: '2021-06-24 22:35:07', modified: '2021-06-24 22:35:07', link: 'steve.james.com', email: 'steve.james@gmail.com', mobilePhone: '4167854398', payRate: '20', title: 'Mr', gender: 'Female', birthDate: '2021-06-24', hiredDate: '2021-06-24', employeeNumber: 'Female' })); req.end(); /employees/{id}: parameters: [] get: tags: - Employee summary: Retrieves a Employee resource. operationId: Employee_getResource description: Retrieves a Employee resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Employee resource content: application/json: schema: $ref: '#/components/schemas/EmployeeGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/EmployeeGetResource200Response' text/xml: schema: $ref: '#/components/schemas/EmployeeGetResource200Response' text/csv: schema: $ref: '#/components/schemas/EmployeeGetResource200Response' text/html: schema: $ref: '#/components/schemas/EmployeeGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/employees/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/employees/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/employees/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/employees/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/employees/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/employees/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/employees/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/employees/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/employees/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - Employee summary: Replaces the Employee resource. operationId: Employee_replaceResource description: Replaces the Employee resource. parameters: - description: Resource identifier name: id in: path 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/EmployeeReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/EmployeeReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/EmployeeReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/EmployeeReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/EmployeeReplaceResourceRequest4' required: true responses: '200': description: Employee resource updated content: application/json: schema: $ref: '#/components/schemas/EmployeeReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/EmployeeReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/EmployeeReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/EmployeeReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/EmployeeReplaceResource200Response' links: GetEmployeeItem: operationId: getEmployeeItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /employees/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"firstName\":\"Steve\",\"lastName\":\"James\",\"fullName\":\"Steve James\",\"active\":true,\"primaryPhone\":\"4168769854\",\"primaryAddr\":\"451 Lincoln street\",\"primaryAddrCity\":\"Toronto\",\"primaryAddrPostalcode\":\"L8H Y5F\",\"primaryAddrState\":\"California\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"link\":\"steve.james.com\",\"email\":\"steve.james@gmail.com\",\"mobilePhone\":\"4167854398\",\"payRate\":\"20\",\"title\":\"Mr\",\"gender\":\"Female\",\"birthDate\":\"2021-06-24\",\"hiredDate\":\"2021-06-24\",\"employeeNumber\":\"Female\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/employees/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/employees/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"firstName\":\"Steve\",\"lastName\":\"James\",\"fullName\":\"Steve James\",\"active\":true,\"primaryPhone\":\"4168769854\",\"primaryAddr\":\"451 Lincoln street\",\"primaryAddrCity\":\"Toronto\",\"primaryAddrPostalcode\":\"L8H Y5F\",\"primaryAddrState\":\"California\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"link\":\"steve.james.com\",\"email\":\"steve.james@gmail.com\",\"mobilePhone\":\"4167854398\",\"payRate\":\"20\",\"title\":\"Mr\",\"gender\":\"Female\",\"birthDate\":\"2021-06-24\",\"hiredDate\":\"2021-06-24\",\"employeeNumber\":\"Female\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/employees/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"706f68c5-46b2-43d8-9aa8-41d1cc2a317f","firstName":"Steve","lastName":"James","fullName":"Steve James","active":true,"primaryPhone":"4168769854","primaryAddr":"451 Lincoln street","primaryAddrCity":"Toronto","primaryAddrPostalcode":"L8H Y5F","primaryAddrState":"California","created":"2021-06-24 22:35:07","modified":"2021-06-24 22:35:07","link":"steve.james.com","email":"steve.james@gmail.com","mobilePhone":"4167854398","payRate":"20","title":"Mr","gender":"Female","birthDate":"2021-06-24","hiredDate":"2021-06-24","employeeNumber":"Female"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/employees/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"firstName\":\"Steve\",\"lastName\":\"James\",\"fullName\":\"Steve James\",\"active\":true,\"primaryPhone\":\"4168769854\",\"primaryAddr\":\"451 Lincoln street\",\"primaryAddrCity\":\"Toronto\",\"primaryAddrPostalcode\":\"L8H Y5F\",\"primaryAddrState\":\"California\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"link\":\"steve.james.com\",\"email\":\"steve.james@gmail.com\",\"mobilePhone\":\"4167854398\",\"payRate\":\"20\",\"title\":\"Mr\",\"gender\":\"Female\",\"birthDate\":\"2021-06-24\",\"hiredDate\":\"2021-06-24\",\"employeeNumber\":\"Female\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/employees/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"firstName\":\"Steve\",\"lastName\":\"James\",\"fullName\":\"Steve James\",\"active\":true,\"primaryPhone\":\"4168769854\",\"primaryAddr\":\"451 Lincoln street\",\"primaryAddrCity\":\"Toronto\",\"primaryAddrPostalcode\":\"L8H Y5F\",\"primaryAddrState\":\"California\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"link\":\"steve.james.com\",\"email\":\"steve.james@gmail.com\",\"mobilePhone\":\"4167854398\",\"payRate\":\"20\",\"title\":\"Mr\",\"gender\":\"Female\",\"birthDate\":\"2021-06-24\",\"hiredDate\":\"2021-06-24\",\"employeeNumber\":\"Female\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"firstName\":\"Steve\",\"lastName\":\"James\",\"fullName\":\"Steve James\",\"active\":true,\"primaryPhone\":\"4168769854\",\"primaryAddr\":\"451 Lincoln street\",\"primaryAddrCity\":\"Toronto\",\"primaryAddrPostalcode\":\"L8H Y5F\",\"primaryAddrState\":\"California\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"link\":\"steve.james.com\",\"email\":\"steve.james@gmail.com\",\"mobilePhone\":\"4167854398\",\"payRate\":\"20\",\"title\":\"Mr\",\"gender\":\"Female\",\"birthDate\":\"2021-06-24\",\"hiredDate\":\"2021-06-24\",\"employeeNumber\":\"Female\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/employees/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/employees/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\\\",\\\"firstName\\\":\\\"Steve\\\",\\\"lastName\\\":\\\"James\\\",\\\"fullName\\\":\\\"Steve James\\\",\\\"active\\\":true,\\\"primaryPhone\\\":\\\"4168769854\\\",\\\"primaryAddr\\\":\\\"451 Lincoln street\\\",\\\"primaryAddrCity\\\":\\\"Toronto\\\",\\\"primaryAddrPostalcode\\\":\\\"L8H Y5F\\\",\\\"primaryAddrState\\\":\\\"California\\\",\\\"created\\\":\\\"2021-06-24 22:35:07\\\",\\\"modified\\\":\\\"2021-06-24 22:35:07\\\",\\\"link\\\":\\\"steve.james.com\\\",\\\"email\\\":\\\"steve.james@gmail.com\\\",\\\"mobilePhone\\\":\\\"4167854398\\\",\\\"payRate\\\":\\\"20\\\",\\\"title\\\":\\\"Mr\\\",\\\"gender\\\":\\\"Female\\\",\\\"birthDate\\\":\\\"2021-06-24\\\",\\\"hiredDate\\\":\\\"2021-06-24\\\",\\\"employeeNumber\\\":\\\"Female\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/employees/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"firstName\":\"Steve\",\"lastName\":\"James\",\"fullName\":\"Steve James\",\"active\":true,\"primaryPhone\":\"4168769854\",\"primaryAddr\":\"451 Lincoln street\",\"primaryAddrCity\":\"Toronto\",\"primaryAddrPostalcode\":\"L8H Y5F\",\"primaryAddrState\":\"California\",\"created\":\"2021-06-24 22:35:07\",\"modified\":\"2021-06-24 22:35:07\",\"link\":\"steve.james.com\",\"email\":\"steve.james@gmail.com\",\"mobilePhone\":\"4167854398\",\"payRate\":\"20\",\"title\":\"Mr\",\"gender\":\"Female\",\"birthDate\":\"2021-06-24\",\"hiredDate\":\"2021-06-24\",\"employeeNumber\":\"Female\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/employees/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '706f68c5-46b2-43d8-9aa8-41d1cc2a317f', firstName: 'Steve', lastName: 'James', fullName: 'Steve James', active: true, primaryPhone: '4168769854', primaryAddr: '451 Lincoln street', primaryAddrCity: 'Toronto', primaryAddrPostalcode: 'L8H Y5F', primaryAddrState: 'California', created: '2021-06-24 22:35:07', modified: '2021-06-24 22:35:07', link: 'steve.james.com', email: 'steve.james@gmail.com', mobilePhone: '4167854398', payRate: '20', title: 'Mr', gender: 'Female', birthDate: '2021-06-24', hiredDate: '2021-06-24', employeeNumber: 'Female' })); req.end(); delete: tags: - Employee summary: Removes the Employee resource. operationId: Employee_removeResource description: Removes the Employee resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: Employee resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/employees/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/employees/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/employees/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/employees/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/employees/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/employees/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/employees/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/employees/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/employees/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /engagements: parameters: [] get: tags: - Engagement summary: Retrieves the collection of Engagement resources. operationId: Engagement_getCollection description: Retrieves the collection of Engagement resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Engagement collection content: application/json: schema: $ref: '#/components/schemas/EngagementGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/EngagementGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/EngagementGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/EngagementGetCollection200Response' text/html: schema: $ref: '#/components/schemas/EngagementGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/engagements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/engagements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/engagements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/engagements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/engagements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/engagements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/engagements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/engagements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/engagements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /engagements/{id}: parameters: [] get: tags: - Engagement summary: Retrieves a Engagement resource. operationId: Engagement_getResource description: Retrieves a Engagement resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Engagement resource content: application/json: schema: $ref: '#/components/schemas/EngagementGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/EngagementGetResource200Response' text/xml: schema: $ref: '#/components/schemas/EngagementGetResource200Response' text/csv: schema: $ref: '#/components/schemas/EngagementGetResource200Response' text/html: schema: $ref: '#/components/schemas/EngagementGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/engagements/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/engagements/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/engagements/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/engagements/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/engagements/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/engagements/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/engagements/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/engagements/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/engagements/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /estimates: parameters: [] get: tags: - Estimate summary: Retrieves the collection of Estimate resources. operationId: Estimate_getCollection description: Retrieves the collection of Estimate resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Estimate collection content: application/json: schema: $ref: '#/components/schemas/EstimateGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/EstimateGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/EstimateGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/EstimateGetCollection200Response' text/html: schema: $ref: '#/components/schemas/EstimateGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/estimates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/estimates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/estimates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/estimates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/estimates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/estimates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/estimates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/estimates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/estimates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /estimates/{id}: parameters: [] get: tags: - Estimate summary: Retrieves a Estimate resource. operationId: Estimate_getResource description: Retrieves a Estimate resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Estimate resource content: application/json: schema: $ref: '#/components/schemas/EstimateGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/EstimateGetResource200Response' text/xml: schema: $ref: '#/components/schemas/EstimateGetResource200Response' text/csv: schema: $ref: '#/components/schemas/EstimateGetResource200Response' text/html: schema: $ref: '#/components/schemas/EstimateGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/estimates/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/estimates/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/estimates/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/estimates/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/estimates/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/estimates/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/estimates/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/estimates/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/estimates/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /events: parameters: [] get: tags: - Event summary: Retrieves the collection of Event resources. operationId: Event_getCollection description: Retrieves the collection of Event resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Event collection content: application/json: schema: $ref: '#/components/schemas/EventGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/EventGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/EventGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/EventGetCollection200Response' text/html: schema: $ref: '#/components/schemas/EventGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /events/{id}: parameters: [] get: tags: - Event summary: Retrieves a Event resource. operationId: Event_getResource description: Retrieves a Event resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Event resource content: application/json: schema: $ref: '#/components/schemas/EventGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/EventGetResource200Response' text/xml: schema: $ref: '#/components/schemas/EventGetResource200Response' text/csv: schema: $ref: '#/components/schemas/EventGetResource200Response' text/html: schema: $ref: '#/components/schemas/EventGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/events/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/events/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/events/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/events/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/events/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/events/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/events/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/events/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/events/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /executive_summaries/{id}: parameters: [] get: tags: - ExecutiveSummary summary: Retrieves a ExecutiveSummary resource. operationId: ExecutiveSummary_getResource description: Retrieves a ExecutiveSummary resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: ExecutiveSummary resource content: application/json: schema: $ref: '#/components/schemas/ExecutiveSummaryGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/ExecutiveSummaryGetResource200Response' text/xml: schema: $ref: '#/components/schemas/ExecutiveSummaryGetResource200Response' text/csv: schema: $ref: '#/components/schemas/ExecutiveSummaryGetResource200Response' text/html: schema: $ref: '#/components/schemas/ExecutiveSummaryGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/executive_summaries/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/executive_summaries/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/executive_summaries/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/executive_summaries/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/executive_summaries/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/executive_summaries/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/executive_summaries/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/executive_summaries/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/executive_summaries/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /executive_summary: parameters: [] get: tags: - ExecutiveSummary summary: Retrieves the collection of ExecutiveSummary resources. operationId: ExecutiveSummary_getCollection description: Retrieves the collection of ExecutiveSummary resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: ExecutiveSummary collection content: application/json: schema: $ref: '#/components/schemas/ExecutiveSummaryGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/ExecutiveSummaryGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/ExecutiveSummaryGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/ExecutiveSummaryGetCollection200Response' text/html: schema: $ref: '#/components/schemas/ExecutiveSummaryGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/executive_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/executive_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/executive_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/executive_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/executive_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/executive_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/executive_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/executive_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/executive_summary?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /expenses: parameters: [] get: tags: - Expense summary: Retrieves the collection of Expense resources. operationId: Expense_getCollection description: Retrieves the collection of Expense resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Expense collection content: application/json: schema: $ref: '#/components/schemas/ExpenseGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/ExpenseGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/ExpenseGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/ExpenseGetCollection200Response' text/html: schema: $ref: '#/components/schemas/ExpenseGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - Expense summary: Creates a Expense resource. operationId: Expense_createResource description: Creates a Expense resource. parameters: [] requestBody: description: The new Expense resource content: application/json: schema: $ref: '#/components/schemas/ExpenseCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/ExpenseCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/ExpenseCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/ExpenseCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/ExpenseCreateResourceRequest4' required: true responses: '201': description: Expense resource created content: application/json: schema: $ref: '#/components/schemas/ExpenseCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/ExpenseCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/ExpenseCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/ExpenseCreateResource201Response' text/html: schema: $ref: '#/components/schemas/ExpenseCreateResource201Response' links: GetExpenseItem: operationId: getExpenseItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /expenses/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"982000000030049\",\"txnId\":\"9856\",\"type\":\"expense\",\"accountId\":\"1057\",\"currency\":\"EUR\",\"subtotal\":9000,\"totalAmount\":12000,\"referenceNumber\":\"782364\",\"status\":\"Unbilled\",\"invoiceId\":\"460000000028192\",\"invoiceNumber\":\"INV-00003\",\"modified\":\"2019-05-25T02:17:40.080Z\",\"accountName\":\"Rent\",\"created\":\"2019-05-22T02:17:40.080Z\",\"accountCode\":\"4560\",\"contactId\":\"23\",\"contactName\":\"Cool Cars\",\"contactType\":\"Vendor\",\"paymentMethodId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"date\":\"2019-05-22T02:17:40.080Z\",\"taxAmount\":3000,\"description\":\"GPS rent\",\"deleted\":true}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/expenses") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/expenses"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"982000000030049\",\"txnId\":\"9856\",\"type\":\"expense\",\"accountId\":\"1057\",\"currency\":\"EUR\",\"subtotal\":9000,\"totalAmount\":12000,\"referenceNumber\":\"782364\",\"status\":\"Unbilled\",\"invoiceId\":\"460000000028192\",\"invoiceNumber\":\"INV-00003\",\"modified\":\"2019-05-25T02:17:40.080Z\",\"accountName\":\"Rent\",\"created\":\"2019-05-22T02:17:40.080Z\",\"accountCode\":\"4560\",\"contactId\":\"23\",\"contactName\":\"Cool Cars\",\"contactType\":\"Vendor\",\"paymentMethodId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"date\":\"2019-05-22T02:17:40.080Z\",\"taxAmount\":3000,\"description\":\"GPS rent\",\"deleted\":true}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/expenses \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"982000000030049","txnId":"9856","type":"expense","accountId":"1057","currency":"EUR","subtotal":9000,"totalAmount":12000,"referenceNumber":"782364","status":"Unbilled","invoiceId":"460000000028192","invoiceNumber":"INV-00003","modified":"2019-05-25T02:17:40.080Z","accountName":"Rent","created":"2019-05-22T02:17:40.080Z","accountCode":"4560","contactId":"23","contactName":"Cool Cars","contactType":"Vendor","paymentMethodId":"1d80716b-427e-4cad-80c6-c4b3a18eb23d","date":"2019-05-22T02:17:40.080Z","taxAmount":3000,"description":"GPS rent","deleted":true}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/expenses", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"982000000030049\",\"txnId\":\"9856\",\"type\":\"expense\",\"accountId\":\"1057\",\"currency\":\"EUR\",\"subtotal\":9000,\"totalAmount\":12000,\"referenceNumber\":\"782364\",\"status\":\"Unbilled\",\"invoiceId\":\"460000000028192\",\"invoiceNumber\":\"INV-00003\",\"modified\":\"2019-05-25T02:17:40.080Z\",\"accountName\":\"Rent\",\"created\":\"2019-05-22T02:17:40.080Z\",\"accountCode\":\"4560\",\"contactId\":\"23\",\"contactName\":\"Cool Cars\",\"contactType\":\"Vendor\",\"paymentMethodId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"date\":\"2019-05-22T02:17:40.080Z\",\"taxAmount\":3000,\"description\":\"GPS rent\",\"deleted\":true}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/expenses") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"982000000030049\",\"txnId\":\"9856\",\"type\":\"expense\",\"accountId\":\"1057\",\"currency\":\"EUR\",\"subtotal\":9000,\"totalAmount\":12000,\"referenceNumber\":\"782364\",\"status\":\"Unbilled\",\"invoiceId\":\"460000000028192\",\"invoiceNumber\":\"INV-00003\",\"modified\":\"2019-05-25T02:17:40.080Z\",\"accountName\":\"Rent\",\"created\":\"2019-05-22T02:17:40.080Z\",\"accountCode\":\"4560\",\"contactId\":\"23\",\"contactName\":\"Cool Cars\",\"contactType\":\"Vendor\",\"paymentMethodId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"date\":\"2019-05-22T02:17:40.080Z\",\"taxAmount\":3000,\"description\":\"GPS rent\",\"deleted\":true}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"982000000030049\",\"txnId\":\"9856\",\"type\":\"expense\",\"accountId\":\"1057\",\"currency\":\"EUR\",\"subtotal\":9000,\"totalAmount\":12000,\"referenceNumber\":\"782364\",\"status\":\"Unbilled\",\"invoiceId\":\"460000000028192\",\"invoiceNumber\":\"INV-00003\",\"modified\":\"2019-05-25T02:17:40.080Z\",\"accountName\":\"Rent\",\"created\":\"2019-05-22T02:17:40.080Z\",\"accountCode\":\"4560\",\"contactId\":\"23\",\"contactName\":\"Cool Cars\",\"contactType\":\"Vendor\",\"paymentMethodId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"date\":\"2019-05-22T02:17:40.080Z\",\"taxAmount\":3000,\"description\":\"GPS rent\",\"deleted\":true}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/expenses", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/expenses\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"982000000030049\\\",\\\"txnId\\\":\\\"9856\\\",\\\"type\\\":\\\"expense\\\",\\\"accountId\\\":\\\"1057\\\",\\\"currency\\\":\\\"EUR\\\",\\\"subtotal\\\":9000,\\\"totalAmount\\\":12000,\\\"referenceNumber\\\":\\\"782364\\\",\\\"status\\\":\\\"Unbilled\\\",\\\"invoiceId\\\":\\\"460000000028192\\\",\\\"invoiceNumber\\\":\\\"INV-00003\\\",\\\"modified\\\":\\\"2019-05-25T02:17:40.080Z\\\",\\\"accountName\\\":\\\"Rent\\\",\\\"created\\\":\\\"2019-05-22T02:17:40.080Z\\\",\\\"accountCode\\\":\\\"4560\\\",\\\"contactId\\\":\\\"23\\\",\\\"contactName\\\":\\\"Cool Cars\\\",\\\"contactType\\\":\\\"Vendor\\\",\\\"paymentMethodId\\\":\\\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\\\",\\\"date\\\":\\\"2019-05-22T02:17:40.080Z\\\",\\\"taxAmount\\\":3000,\\\"description\\\":\\\"GPS rent\\\",\\\"deleted\\\":true}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/expenses", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"982000000030049\",\"txnId\":\"9856\",\"type\":\"expense\",\"accountId\":\"1057\",\"currency\":\"EUR\",\"subtotal\":9000,\"totalAmount\":12000,\"referenceNumber\":\"782364\",\"status\":\"Unbilled\",\"invoiceId\":\"460000000028192\",\"invoiceNumber\":\"INV-00003\",\"modified\":\"2019-05-25T02:17:40.080Z\",\"accountName\":\"Rent\",\"created\":\"2019-05-22T02:17:40.080Z\",\"accountCode\":\"4560\",\"contactId\":\"23\",\"contactName\":\"Cool Cars\",\"contactType\":\"Vendor\",\"paymentMethodId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"date\":\"2019-05-22T02:17:40.080Z\",\"taxAmount\":3000,\"description\":\"GPS rent\",\"deleted\":true}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/expenses", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '982000000030049', txnId: '9856', type: 'expense', accountId: '1057', currency: 'EUR', subtotal: 9000, totalAmount: 12000, referenceNumber: '782364', status: 'Unbilled', invoiceId: '460000000028192', invoiceNumber: 'INV-00003', modified: '2019-05-25T02:17:40.080Z', accountName: 'Rent', created: '2019-05-22T02:17:40.080Z', accountCode: '4560', contactId: '23', contactName: 'Cool Cars', contactType: 'Vendor', paymentMethodId: '1d80716b-427e-4cad-80c6-c4b3a18eb23d', date: '2019-05-22T02:17:40.080Z', taxAmount: 3000, description: 'GPS rent', deleted: true })); req.end(); /expenses/{id}: parameters: [] get: tags: - Expense summary: Retrieves a Expense resource. operationId: Expense_get description: Retrieves a Expense resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Expense resource content: application/json: schema: $ref: '#/components/schemas/ExpenseGetResponse' application/xml: schema: $ref: '#/components/schemas/ExpenseGet200Response' text/xml: schema: $ref: '#/components/schemas/ExpenseGet200Response' text/csv: schema: $ref: '#/components/schemas/ExpenseGet200Response' text/html: schema: $ref: '#/components/schemas/ExpenseGet200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/expenses/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/expenses/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/expenses/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/expenses/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/expenses/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/expenses/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/expenses/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/expenses/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/expenses/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - Expense summary: Replaces the Expense resource. operationId: Expense_replaceResource description: Replaces the Expense resource. parameters: - description: Resource identifier name: id in: path 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/ExpenseReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/ExpenseReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/ExpenseReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/ExpenseReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/ExpenseReplaceResourceRequest4' required: true responses: '200': description: Expense resource updated content: application/json: schema: $ref: '#/components/schemas/ExpenseReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/ExpenseReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/ExpenseReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/ExpenseReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/ExpenseReplaceResource200Response' links: GetExpenseItem: operationId: getExpenseItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /expenses/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"982000000030049\",\"txnId\":\"9856\",\"type\":\"expense\",\"accountId\":\"1057\",\"currency\":\"EUR\",\"subtotal\":9000,\"totalAmount\":12000,\"referenceNumber\":\"782364\",\"status\":\"Unbilled\",\"invoiceId\":\"460000000028192\",\"invoiceNumber\":\"INV-00003\",\"modified\":\"2019-05-25T02:17:40.080Z\",\"accountName\":\"Rent\",\"created\":\"2019-05-22T02:17:40.080Z\",\"accountCode\":\"4560\",\"contactId\":\"23\",\"contactName\":\"Cool Cars\",\"contactType\":\"Vendor\",\"paymentMethodId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"date\":\"2019-05-22T02:17:40.080Z\",\"taxAmount\":3000,\"description\":\"GPS rent\",\"deleted\":true}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/expenses/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/expenses/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"982000000030049\",\"txnId\":\"9856\",\"type\":\"expense\",\"accountId\":\"1057\",\"currency\":\"EUR\",\"subtotal\":9000,\"totalAmount\":12000,\"referenceNumber\":\"782364\",\"status\":\"Unbilled\",\"invoiceId\":\"460000000028192\",\"invoiceNumber\":\"INV-00003\",\"modified\":\"2019-05-25T02:17:40.080Z\",\"accountName\":\"Rent\",\"created\":\"2019-05-22T02:17:40.080Z\",\"accountCode\":\"4560\",\"contactId\":\"23\",\"contactName\":\"Cool Cars\",\"contactType\":\"Vendor\",\"paymentMethodId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"date\":\"2019-05-22T02:17:40.080Z\",\"taxAmount\":3000,\"description\":\"GPS rent\",\"deleted\":true}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/expenses/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"982000000030049","txnId":"9856","type":"expense","accountId":"1057","currency":"EUR","subtotal":9000,"totalAmount":12000,"referenceNumber":"782364","status":"Unbilled","invoiceId":"460000000028192","invoiceNumber":"INV-00003","modified":"2019-05-25T02:17:40.080Z","accountName":"Rent","created":"2019-05-22T02:17:40.080Z","accountCode":"4560","contactId":"23","contactName":"Cool Cars","contactType":"Vendor","paymentMethodId":"1d80716b-427e-4cad-80c6-c4b3a18eb23d","date":"2019-05-22T02:17:40.080Z","taxAmount":3000,"description":"GPS rent","deleted":true}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/expenses/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"982000000030049\",\"txnId\":\"9856\",\"type\":\"expense\",\"accountId\":\"1057\",\"currency\":\"EUR\",\"subtotal\":9000,\"totalAmount\":12000,\"referenceNumber\":\"782364\",\"status\":\"Unbilled\",\"invoiceId\":\"460000000028192\",\"invoiceNumber\":\"INV-00003\",\"modified\":\"2019-05-25T02:17:40.080Z\",\"accountName\":\"Rent\",\"created\":\"2019-05-22T02:17:40.080Z\",\"accountCode\":\"4560\",\"contactId\":\"23\",\"contactName\":\"Cool Cars\",\"contactType\":\"Vendor\",\"paymentMethodId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"date\":\"2019-05-22T02:17:40.080Z\",\"taxAmount\":3000,\"description\":\"GPS rent\",\"deleted\":true}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/expenses/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"982000000030049\",\"txnId\":\"9856\",\"type\":\"expense\",\"accountId\":\"1057\",\"currency\":\"EUR\",\"subtotal\":9000,\"totalAmount\":12000,\"referenceNumber\":\"782364\",\"status\":\"Unbilled\",\"invoiceId\":\"460000000028192\",\"invoiceNumber\":\"INV-00003\",\"modified\":\"2019-05-25T02:17:40.080Z\",\"accountName\":\"Rent\",\"created\":\"2019-05-22T02:17:40.080Z\",\"accountCode\":\"4560\",\"contactId\":\"23\",\"contactName\":\"Cool Cars\",\"contactType\":\"Vendor\",\"paymentMethodId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"date\":\"2019-05-22T02:17:40.080Z\",\"taxAmount\":3000,\"description\":\"GPS rent\",\"deleted\":true}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"982000000030049\",\"txnId\":\"9856\",\"type\":\"expense\",\"accountId\":\"1057\",\"currency\":\"EUR\",\"subtotal\":9000,\"totalAmount\":12000,\"referenceNumber\":\"782364\",\"status\":\"Unbilled\",\"invoiceId\":\"460000000028192\",\"invoiceNumber\":\"INV-00003\",\"modified\":\"2019-05-25T02:17:40.080Z\",\"accountName\":\"Rent\",\"created\":\"2019-05-22T02:17:40.080Z\",\"accountCode\":\"4560\",\"contactId\":\"23\",\"contactName\":\"Cool Cars\",\"contactType\":\"Vendor\",\"paymentMethodId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"date\":\"2019-05-22T02:17:40.080Z\",\"taxAmount\":3000,\"description\":\"GPS rent\",\"deleted\":true}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/expenses/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/expenses/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"982000000030049\\\",\\\"txnId\\\":\\\"9856\\\",\\\"type\\\":\\\"expense\\\",\\\"accountId\\\":\\\"1057\\\",\\\"currency\\\":\\\"EUR\\\",\\\"subtotal\\\":9000,\\\"totalAmount\\\":12000,\\\"referenceNumber\\\":\\\"782364\\\",\\\"status\\\":\\\"Unbilled\\\",\\\"invoiceId\\\":\\\"460000000028192\\\",\\\"invoiceNumber\\\":\\\"INV-00003\\\",\\\"modified\\\":\\\"2019-05-25T02:17:40.080Z\\\",\\\"accountName\\\":\\\"Rent\\\",\\\"created\\\":\\\"2019-05-22T02:17:40.080Z\\\",\\\"accountCode\\\":\\\"4560\\\",\\\"contactId\\\":\\\"23\\\",\\\"contactName\\\":\\\"Cool Cars\\\",\\\"contactType\\\":\\\"Vendor\\\",\\\"paymentMethodId\\\":\\\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\\\",\\\"date\\\":\\\"2019-05-22T02:17:40.080Z\\\",\\\"taxAmount\\\":3000,\\\"description\\\":\\\"GPS rent\\\",\\\"deleted\\\":true}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/expenses/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"982000000030049\",\"txnId\":\"9856\",\"type\":\"expense\",\"accountId\":\"1057\",\"currency\":\"EUR\",\"subtotal\":9000,\"totalAmount\":12000,\"referenceNumber\":\"782364\",\"status\":\"Unbilled\",\"invoiceId\":\"460000000028192\",\"invoiceNumber\":\"INV-00003\",\"modified\":\"2019-05-25T02:17:40.080Z\",\"accountName\":\"Rent\",\"created\":\"2019-05-22T02:17:40.080Z\",\"accountCode\":\"4560\",\"contactId\":\"23\",\"contactName\":\"Cool Cars\",\"contactType\":\"Vendor\",\"paymentMethodId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"date\":\"2019-05-22T02:17:40.080Z\",\"taxAmount\":3000,\"description\":\"GPS rent\",\"deleted\":true}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/expenses/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '982000000030049', txnId: '9856', type: 'expense', accountId: '1057', currency: 'EUR', subtotal: 9000, totalAmount: 12000, referenceNumber: '782364', status: 'Unbilled', invoiceId: '460000000028192', invoiceNumber: 'INV-00003', modified: '2019-05-25T02:17:40.080Z', accountName: 'Rent', created: '2019-05-22T02:17:40.080Z', accountCode: '4560', contactId: '23', contactName: 'Cool Cars', contactType: 'Vendor', paymentMethodId: '1d80716b-427e-4cad-80c6-c4b3a18eb23d', date: '2019-05-22T02:17:40.080Z', taxAmount: 3000, description: 'GPS rent', deleted: true })); req.end(); delete: tags: - Expense summary: Removes the Expense resource. operationId: Expense_removeResource description: Removes the Expense resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: Expense resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/expenses/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/expenses/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/expenses/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/expenses/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/expenses/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/expenses/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/expenses/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/expenses/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/expenses/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /financial_mapping: parameters: [] get: tags: - FinancialMapping summary: Retrieves the collection of FinancialMapping resources. operationId: FinancialMapping_getCollection description: Retrieves the collection of FinancialMapping resources. parameters: [] responses: '200': description: FinancialMapping collection content: application/json: schema: $ref: '#/components/schemas/FinancialMappingGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/FinancialMappingGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/FinancialMappingGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/FinancialMappingGetCollection200Response' text/html: schema: $ref: '#/components/schemas/FinancialMappingGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/financial_mapping") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/financial_mapping"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/financial_mapping \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/financial_mapping", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/financial_mapping") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/financial_mapping", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/financial_mapping\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/financial_mapping", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/financial_mapping", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /financial_mappings/{id}: parameters: [] get: tags: - FinancialMapping summary: Retrieves a FinancialMapping resource. operationId: FinancialMapping_getResource description: Retrieves a FinancialMapping resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: FinancialMapping resource content: application/json: schema: $ref: '#/components/schemas/FinancialMappingGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/FinancialMappingGetResource200Response' text/xml: schema: $ref: '#/components/schemas/FinancialMappingGetResource200Response' text/csv: schema: $ref: '#/components/schemas/FinancialMappingGetResource200Response' text/html: schema: $ref: '#/components/schemas/FinancialMappingGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/financial_mappings/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/financial_mappings/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/financial_mappings/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/financial_mappings/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/financial_mappings/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/financial_mappings/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/financial_mappings/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/financial_mappings/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/financial_mappings/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /financial_periods: parameters: [] get: tags: - FinancialPeriod summary: Retrieves the collection of FinancialPeriod resources. operationId: FinancialPeriod_getCollection description: Retrieves the collection of FinancialPeriod resources. parameters: [] responses: '200': description: FinancialPeriod collection content: application/json: schema: $ref: '#/components/schemas/FinancialPeriodGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/FinancialPeriodGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/FinancialPeriodGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/FinancialPeriodGetCollection200Response' text/html: schema: $ref: '#/components/schemas/FinancialPeriodGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/financial_periods") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/financial_periods"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/financial_periods \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/financial_periods", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/financial_periods") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/financial_periods", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/financial_periods\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/financial_periods", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/financial_periods", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /financial_periods/{id}: parameters: [] get: tags: - FinancialPeriod summary: Retrieves a FinancialPeriod resource. operationId: FinancialPeriod_getResource description: Retrieves a FinancialPeriod resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: FinancialPeriod resource content: application/json: schema: $ref: '#/components/schemas/FinancialPeriodGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/FinancialPeriodGetResource200Response' text/xml: schema: $ref: '#/components/schemas/FinancialPeriodGetResource200Response' text/csv: schema: $ref: '#/components/schemas/FinancialPeriodGetResource200Response' text/html: schema: $ref: '#/components/schemas/FinancialPeriodGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/financial_periods/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/financial_periods/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/financial_periods/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/financial_periods/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/financial_periods/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/financial_periods/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/financial_periods/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/financial_periods/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/financial_periods/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /form_data: parameters: [] get: tags: - FormData summary: Retrieves JSON Form Data operationId: FormData_getJsonData description: >- The returned object will have keys based on the 'name' attributes of each form input. parameters: - description: >- The key of the Form that you would like to retrieve data for. Default is 'profile'. name: key in: query required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false example: profile - description: Resource identifier name: formInput1 in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: FormData resource content: application/json: schema: $ref: '#/components/schemas/FormDataGetJsonDataResponse' application/xml: schema: $ref: '#/components/schemas/FormDataGetJsonData200Response' text/xml: schema: $ref: '#/components/schemas/FormDataGetJsonData200Response' text/csv: schema: $ref: '#/components/schemas/FormDataGetJsonData200Response' text/html: schema: $ref: '#/components/schemas/FormDataGetJsonData200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/form_data?key=SOME_STRING_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/form_data?key=SOME_STRING_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/form_data?key=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/form_data?key=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/form_data?key=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/form_data?key=SOME_STRING_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/form_data?key=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/form_data?key=SOME_STRING_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/form_data?key=SOME_STRING_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /forms: parameters: [] get: tags: - Form summary: Retrieves the collection of Form resources. operationId: Form_getCollection description: Retrieves the collection of Form resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Form collection content: application/json: schema: $ref: '#/components/schemas/FormGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/FormGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/FormGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/FormGetCollection200Response' text/html: schema: $ref: '#/components/schemas/FormGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/forms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/forms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/forms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/forms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/forms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/forms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/forms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/forms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/forms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /forms/{id}: parameters: [] get: tags: - Form summary: Retrieves a Form resource. operationId: Form_getResource description: Retrieves a Form resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Form resource content: application/json: schema: $ref: '#/components/schemas/FormGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/FormGetResource200Response' text/xml: schema: $ref: '#/components/schemas/FormGetResource200Response' text/csv: schema: $ref: '#/components/schemas/FormGetResource200Response' text/html: schema: $ref: '#/components/schemas/FormGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/forms/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/forms/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/forms/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/forms/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/forms/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/forms/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/forms/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/forms/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/forms/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /growth_histories: parameters: [] get: tags: - GrowthHistory summary: Retrieves the collection of GrowthHistory resources. operationId: GrowthHistory_getCollection description: Retrieves the collection of GrowthHistory resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: GrowthHistory collection content: application/json: schema: $ref: '#/components/schemas/GrowthHistoryGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/GrowthHistoryGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/GrowthHistoryGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/GrowthHistoryGetCollection200Response' text/html: schema: $ref: '#/components/schemas/GrowthHistoryGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/growth_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/growth_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/growth_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/growth_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/growth_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/growth_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/growth_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/growth_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/growth_histories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /growth_histories/{id}: parameters: [] get: tags: - GrowthHistory summary: Retrieves a GrowthHistory resource. operationId: GrowthHistory_getResource description: Retrieves a GrowthHistory resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: GrowthHistory resource content: application/json: schema: $ref: '#/components/schemas/GrowthHistoryGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/GrowthHistoryGetResource200Response' text/xml: schema: $ref: '#/components/schemas/GrowthHistoryGetResource200Response' text/csv: schema: $ref: '#/components/schemas/GrowthHistoryGetResource200Response' text/html: schema: $ref: '#/components/schemas/GrowthHistoryGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/growth_histories/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/growth_histories/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/growth_histories/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/growth_histories/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/growth_histories/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/growth_histories/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/growth_histories/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/growth_histories/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/growth_histories/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /integrations: parameters: [] get: tags: - IntegrationsList summary: Retrieves a list of integrations operationId: IntegrationsList_getList description: Retrieves a IntegrationsList resource. parameters: - description: Resource identifier name: file in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: IntegrationsList resource content: application/json: schema: $ref: '#/components/schemas/IntegrationsListGetListResponse' application/xml: schema: $ref: '#/components/schemas/IntegrationsListGetList200Response' text/xml: schema: $ref: '#/components/schemas/IntegrationsListGetList200Response' text/csv: schema: $ref: '#/components/schemas/IntegrationsListGetList200Response' text/html: schema: $ref: '#/components/schemas/IntegrationsListGetList200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/integrations") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/integrations"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/integrations \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/integrations", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/integrations") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/integrations", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/integrations\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/integrations", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/integrations", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /inventories: parameters: [] get: tags: - Inventory summary: Retrieves the collection of Inventory resources. operationId: Inventory_getCollection description: Retrieves the collection of Inventory resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Inventory collection content: application/json: schema: $ref: '#/components/schemas/InventoryGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/InventoryGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/InventoryGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/InventoryGetCollection200Response' text/html: schema: $ref: '#/components/schemas/InventoryGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/inventories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/inventories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/inventories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/inventories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/inventories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/inventories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/inventories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/inventories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/inventories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - Inventory summary: Creates a Inventory resource. operationId: Inventory_createResource description: Creates a Inventory resource. parameters: [] requestBody: description: The new Inventory resource content: application/json: schema: $ref: '#/components/schemas/InventoryCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/InventoryCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/InventoryCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/InventoryCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/InventoryCreateResourceRequest4' required: true responses: '201': description: Inventory resource created content: application/json: schema: $ref: '#/components/schemas/InventoryCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/InventoryCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/InventoryCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/InventoryCreateResource201Response' text/html: schema: $ref: '#/components/schemas/InventoryCreateResource201Response' links: GetInventoryItem: operationId: getInventoryItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /inventories/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"sku\":\"string\",\"modified\":\"2019-08-24T14:15:22Z\",\"integration\":\"quickbooks\",\"productName\":\"string\",\"totalQuantity\":0,\"fulfillableQuantity\":null}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/inventories") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/inventories"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"sku\":\"string\",\"modified\":\"2019-08-24T14:15:22Z\",\"integration\":\"quickbooks\",\"productName\":\"string\",\"totalQuantity\":0,\"fulfillableQuantity\":null}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/inventories \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"sku":"string","modified":"2019-08-24T14:15:22Z","integration":"quickbooks","productName":"string","totalQuantity":0,"fulfillableQuantity":null}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/inventories", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"sku\":\"string\",\"modified\":\"2019-08-24T14:15:22Z\",\"integration\":\"quickbooks\",\"productName\":\"string\",\"totalQuantity\":0,\"fulfillableQuantity\":null}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/inventories") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"sku\":\"string\",\"modified\":\"2019-08-24T14:15:22Z\",\"integration\":\"quickbooks\",\"productName\":\"string\",\"totalQuantity\":0,\"fulfillableQuantity\":null}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"sku\":\"string\",\"modified\":\"2019-08-24T14:15:22Z\",\"integration\":\"quickbooks\",\"productName\":\"string\",\"totalQuantity\":0,\"fulfillableQuantity\":null}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/inventories", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/inventories\"\n\n\tpayload := strings.NewReader(\"{\\\"sku\\\":\\\"string\\\",\\\"modified\\\":\\\"2019-08-24T14:15:22Z\\\",\\\"integration\\\":\\\"quickbooks\\\",\\\"productName\\\":\\\"string\\\",\\\"totalQuantity\\\":0,\\\"fulfillableQuantity\\\":null}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/inventories", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"sku\":\"string\",\"modified\":\"2019-08-24T14:15:22Z\",\"integration\":\"quickbooks\",\"productName\":\"string\",\"totalQuantity\":0,\"fulfillableQuantity\":null}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/inventories", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ sku: 'string', modified: '2019-08-24T14:15:22Z', integration: 'quickbooks', productName: 'string', totalQuantity: 0, fulfillableQuantity: null })); req.end(); /inventories/{id}: parameters: [] get: tags: - Inventory summary: Retrieves a Inventory resource. operationId: Inventory_getResource description: Retrieves a Inventory resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Inventory resource content: application/json: schema: $ref: '#/components/schemas/InventoryGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/InventoryGetResource200Response' text/xml: schema: $ref: '#/components/schemas/InventoryGetResource200Response' text/csv: schema: $ref: '#/components/schemas/InventoryGetResource200Response' text/html: schema: $ref: '#/components/schemas/InventoryGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/inventories/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/inventories/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/inventories/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/inventories/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/inventories/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/inventories/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/inventories/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/inventories/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/inventories/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - Inventory summary: Replaces the Inventory resource. operationId: Inventory_replaceResource description: Replaces the Inventory resource. parameters: - description: Resource identifier name: id in: path 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/InventoryReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/InventoryReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/InventoryReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/InventoryReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/InventoryReplaceResourceRequest4' required: true responses: '200': description: Inventory resource updated content: application/json: schema: $ref: '#/components/schemas/InventoryReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/InventoryReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/InventoryReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/InventoryReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/InventoryReplaceResource200Response' links: GetInventoryItem: operationId: getInventoryItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /inventories/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"sku\":\"string\",\"modified\":\"2019-08-24T14:15:22Z\",\"integration\":\"quickbooks\",\"productName\":\"string\",\"totalQuantity\":0,\"fulfillableQuantity\":null}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/inventories/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/inventories/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"sku\":\"string\",\"modified\":\"2019-08-24T14:15:22Z\",\"integration\":\"quickbooks\",\"productName\":\"string\",\"totalQuantity\":0,\"fulfillableQuantity\":null}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/inventories/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"sku":"string","modified":"2019-08-24T14:15:22Z","integration":"quickbooks","productName":"string","totalQuantity":0,"fulfillableQuantity":null}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/inventories/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"sku\":\"string\",\"modified\":\"2019-08-24T14:15:22Z\",\"integration\":\"quickbooks\",\"productName\":\"string\",\"totalQuantity\":0,\"fulfillableQuantity\":null}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/inventories/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"sku\":\"string\",\"modified\":\"2019-08-24T14:15:22Z\",\"integration\":\"quickbooks\",\"productName\":\"string\",\"totalQuantity\":0,\"fulfillableQuantity\":null}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"sku\":\"string\",\"modified\":\"2019-08-24T14:15:22Z\",\"integration\":\"quickbooks\",\"productName\":\"string\",\"totalQuantity\":0,\"fulfillableQuantity\":null}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/inventories/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/inventories/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"sku\\\":\\\"string\\\",\\\"modified\\\":\\\"2019-08-24T14:15:22Z\\\",\\\"integration\\\":\\\"quickbooks\\\",\\\"productName\\\":\\\"string\\\",\\\"totalQuantity\\\":0,\\\"fulfillableQuantity\\\":null}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/inventories/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"sku\":\"string\",\"modified\":\"2019-08-24T14:15:22Z\",\"integration\":\"quickbooks\",\"productName\":\"string\",\"totalQuantity\":0,\"fulfillableQuantity\":null}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/inventories/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ sku: 'string', modified: '2019-08-24T14:15:22Z', integration: 'quickbooks', productName: 'string', totalQuantity: 0, fulfillableQuantity: null })); req.end(); delete: tags: - Inventory summary: Removes the Inventory resource. operationId: Inventory_removeResource description: Removes the Inventory resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: Inventory resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/inventories/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/inventories/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/inventories/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/inventories/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/inventories/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/inventories/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/inventories/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/inventories/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/inventories/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /invoice_items: parameters: [] get: tags: - InvoiceItem summary: Retrieves the collection of InvoiceItem resources. operationId: InvoiceItem_listResources description: Retrieves the collection of InvoiceItem resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false - description: '' name: invoiceId in: query required: false deprecated: false allowEmptyValue: true schema: type: string style: form explode: false allowReserved: false - description: '' name: invoiceId[] in: query required: false deprecated: false allowEmptyValue: true schema: type: array items: type: string style: form explode: true allowReserved: false responses: '200': description: InvoiceItem collection content: application/json: schema: $ref: '#/components/schemas/InvoiceItemListResourcesResponse' application/xml: schema: $ref: '#/components/schemas/InvoiceItemListResources200Response' text/xml: schema: $ref: '#/components/schemas/InvoiceItemListResources200Response' text/csv: schema: $ref: '#/components/schemas/InvoiceItemListResources200Response' text/html: schema: $ref: '#/components/schemas/InvoiceItemListResources200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/invoice_items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&invoiceId=SOME_STRING_VALUE&invoiceId%5B%5D=SOME_ARRAY_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/invoice_items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&invoiceId=SOME_STRING_VALUE&invoiceId%5B%5D=SOME_ARRAY_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/invoice_items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&invoiceId=SOME_STRING_VALUE&invoiceId%5B%5D=SOME_ARRAY_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/invoice_items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&invoiceId=SOME_STRING_VALUE&invoiceId%5B%5D=SOME_ARRAY_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/invoice_items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&invoiceId=SOME_STRING_VALUE&invoiceId%5B%5D=SOME_ARRAY_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/invoice_items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&invoiceId=SOME_STRING_VALUE&invoiceId%5B%5D=SOME_ARRAY_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/invoice_items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&invoiceId=SOME_STRING_VALUE&invoiceId%5B%5D=SOME_ARRAY_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/invoice_items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&invoiceId=SOME_STRING_VALUE&invoiceId%5B%5D=SOME_ARRAY_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/invoice_items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&invoiceId=SOME_STRING_VALUE&invoiceId%5B%5D=SOME_ARRAY_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - InvoiceItem summary: Creates a InvoiceItem resource. operationId: InvoiceItem_createResource description: Creates a InvoiceItem resource. parameters: [] requestBody: description: The new InvoiceItem resource content: application/json: schema: $ref: '#/components/schemas/InvoiceItemCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/InvoiceItemCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/InvoiceItemCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/InvoiceItemCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/InvoiceItemCreateResourceRequest4' required: true responses: '201': description: InvoiceItem resource created content: application/json: schema: $ref: '#/components/schemas/InvoiceItemCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/InvoiceItemCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/InvoiceItemCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/InvoiceItemCreateResource201Response' text/html: schema: $ref: '#/components/schemas/InvoiceItemCreateResource201Response' links: GetInvoiceItemItem: operationId: getInvoiceItemItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /invoice_items/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"1\",\"invoiceId\":\"quickbooks-34\",\"description\":\"Bag of soil\",\"quantity\":2.25,\"unitPrice\":18900,\"itemId\":\"1002\",\"itemName\":\"Bag of soil\",\"lineAmount\":42525}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/invoice_items") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/invoice_items"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"1\",\"invoiceId\":\"quickbooks-34\",\"description\":\"Bag of soil\",\"quantity\":2.25,\"unitPrice\":18900,\"itemId\":\"1002\",\"itemName\":\"Bag of soil\",\"lineAmount\":42525}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/invoice_items \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"1","invoiceId":"quickbooks-34","description":"Bag of soil","quantity":2.25,"unitPrice":18900,"itemId":"1002","itemName":"Bag of soil","lineAmount":42525}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/invoice_items", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"1\",\"invoiceId\":\"quickbooks-34\",\"description\":\"Bag of soil\",\"quantity\":2.25,\"unitPrice\":18900,\"itemId\":\"1002\",\"itemName\":\"Bag of soil\",\"lineAmount\":42525}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/invoice_items") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"1\",\"invoiceId\":\"quickbooks-34\",\"description\":\"Bag of soil\",\"quantity\":2.25,\"unitPrice\":18900,\"itemId\":\"1002\",\"itemName\":\"Bag of soil\",\"lineAmount\":42525}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"1\",\"invoiceId\":\"quickbooks-34\",\"description\":\"Bag of soil\",\"quantity\":2.25,\"unitPrice\":18900,\"itemId\":\"1002\",\"itemName\":\"Bag of soil\",\"lineAmount\":42525}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/invoice_items", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/invoice_items\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"1\\\",\\\"invoiceId\\\":\\\"quickbooks-34\\\",\\\"description\\\":\\\"Bag of soil\\\",\\\"quantity\\\":2.25,\\\"unitPrice\\\":18900,\\\"itemId\\\":\\\"1002\\\",\\\"itemName\\\":\\\"Bag of soil\\\",\\\"lineAmount\\\":42525}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/invoice_items", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"1\",\"invoiceId\":\"quickbooks-34\",\"description\":\"Bag of soil\",\"quantity\":2.25,\"unitPrice\":18900,\"itemId\":\"1002\",\"itemName\":\"Bag of soil\",\"lineAmount\":42525}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/invoice_items", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '1', invoiceId: 'quickbooks-34', description: 'Bag of soil', quantity: 2.25, unitPrice: 18900, itemId: '1002', itemName: 'Bag of soil', lineAmount: 42525 })); req.end(); /invoice_items/{id}: parameters: [] get: tags: - InvoiceItem summary: Retrieves a InvoiceItem resource. operationId: InvoiceItem_getResource description: Retrieves a InvoiceItem resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: InvoiceItem resource content: application/json: schema: $ref: '#/components/schemas/InvoiceItemGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/InvoiceItemGetResource200Response' text/xml: schema: $ref: '#/components/schemas/InvoiceItemGetResource200Response' text/csv: schema: $ref: '#/components/schemas/InvoiceItemGetResource200Response' text/html: schema: $ref: '#/components/schemas/InvoiceItemGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/invoice_items/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/invoice_items/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/invoice_items/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/invoice_items/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/invoice_items/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/invoice_items/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/invoice_items/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/invoice_items/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/invoice_items/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - InvoiceItem summary: Replaces the InvoiceItem resource. operationId: InvoiceItem_replaceResource description: Replaces the InvoiceItem resource. parameters: - description: Resource identifier name: id in: path 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/InvoiceItemReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/InvoiceItemReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/InvoiceItemReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/InvoiceItemReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/InvoiceItemReplaceResourceRequest4' required: true responses: '200': description: InvoiceItem resource updated content: application/json: schema: $ref: '#/components/schemas/InvoiceItemReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/InvoiceItemReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/InvoiceItemReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/InvoiceItemReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/InvoiceItemReplaceResource200Response' links: GetInvoiceItemItem: operationId: getInvoiceItemItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /invoice_items/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"1\",\"invoiceId\":\"quickbooks-34\",\"description\":\"Bag of soil\",\"quantity\":2.25,\"unitPrice\":18900,\"itemId\":\"1002\",\"itemName\":\"Bag of soil\",\"lineAmount\":42525}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/invoice_items/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/invoice_items/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"1\",\"invoiceId\":\"quickbooks-34\",\"description\":\"Bag of soil\",\"quantity\":2.25,\"unitPrice\":18900,\"itemId\":\"1002\",\"itemName\":\"Bag of soil\",\"lineAmount\":42525}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/invoice_items/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"1","invoiceId":"quickbooks-34","description":"Bag of soil","quantity":2.25,"unitPrice":18900,"itemId":"1002","itemName":"Bag of soil","lineAmount":42525}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/invoice_items/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"1\",\"invoiceId\":\"quickbooks-34\",\"description\":\"Bag of soil\",\"quantity\":2.25,\"unitPrice\":18900,\"itemId\":\"1002\",\"itemName\":\"Bag of soil\",\"lineAmount\":42525}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/invoice_items/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"1\",\"invoiceId\":\"quickbooks-34\",\"description\":\"Bag of soil\",\"quantity\":2.25,\"unitPrice\":18900,\"itemId\":\"1002\",\"itemName\":\"Bag of soil\",\"lineAmount\":42525}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"1\",\"invoiceId\":\"quickbooks-34\",\"description\":\"Bag of soil\",\"quantity\":2.25,\"unitPrice\":18900,\"itemId\":\"1002\",\"itemName\":\"Bag of soil\",\"lineAmount\":42525}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/invoice_items/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/invoice_items/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"1\\\",\\\"invoiceId\\\":\\\"quickbooks-34\\\",\\\"description\\\":\\\"Bag of soil\\\",\\\"quantity\\\":2.25,\\\"unitPrice\\\":18900,\\\"itemId\\\":\\\"1002\\\",\\\"itemName\\\":\\\"Bag of soil\\\",\\\"lineAmount\\\":42525}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/invoice_items/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"1\",\"invoiceId\":\"quickbooks-34\",\"description\":\"Bag of soil\",\"quantity\":2.25,\"unitPrice\":18900,\"itemId\":\"1002\",\"itemName\":\"Bag of soil\",\"lineAmount\":42525}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/invoice_items/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '1', invoiceId: 'quickbooks-34', description: 'Bag of soil', quantity: 2.25, unitPrice: 18900, itemId: '1002', itemName: 'Bag of soil', lineAmount: 42525 })); req.end(); delete: tags: - InvoiceItem summary: Removes the InvoiceItem resource. operationId: InvoiceItem_removeResource description: Removes the InvoiceItem resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: InvoiceItem resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/invoice_items/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/invoice_items/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/invoice_items/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/invoice_items/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/invoice_items/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/invoice_items/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/invoice_items/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/invoice_items/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/invoice_items/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /invoices: parameters: [] get: tags: - Invoice summary: Retrieves the collection of Invoice resources. operationId: Invoice_getCollection description: Retrieves the collection of Invoice resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Invoice collection content: application/json: schema: $ref: '#/components/schemas/InvoiceGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/InvoiceGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/InvoiceGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/InvoiceGetCollection200Response' text/html: schema: $ref: '#/components/schemas/InvoiceGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /invoices/{id}: parameters: [] get: tags: - Invoice summary: Retrieves a Invoice resource. operationId: Invoice_getResource description: Retrieves a Invoice resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Invoice resource content: application/json: schema: $ref: '#/components/schemas/InvoiceGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/InvoiceGetResource200Response' text/xml: schema: $ref: '#/components/schemas/InvoiceGetResource200Response' text/csv: schema: $ref: '#/components/schemas/InvoiceGetResource200Response' text/html: schema: $ref: '#/components/schemas/InvoiceGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/invoices/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/invoices/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/invoices/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/invoices/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/invoices/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/invoices/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/invoices/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/invoices/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/invoices/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /items: parameters: [] get: tags: - Item summary: Retrieves the collection of Item resources. operationId: Item_getCollection description: Retrieves the collection of Item resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Item collection content: application/json: schema: $ref: '#/components/schemas/ItemGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/ItemGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/ItemGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/ItemGetCollection200Response' text/html: schema: $ref: '#/components/schemas/ItemGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/items?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /items/{id}: parameters: [] get: tags: - Item summary: Retrieves a Item resource. operationId: Item_getResource description: Retrieves a Item resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Item resource content: application/json: schema: $ref: '#/components/schemas/ItemGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/ItemGetResource200Response' text/xml: schema: $ref: '#/components/schemas/ItemGetResource200Response' text/csv: schema: $ref: '#/components/schemas/ItemGetResource200Response' text/html: schema: $ref: '#/components/schemas/ItemGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/items/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/items/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/items/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/items/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/items/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/items/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/items/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/items/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/items/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /journal_lines: parameters: [] get: tags: - JournalLine summary: Retrieves the collection of JournalLine resources. operationId: JournalLine_listResources description: Retrieves the collection of JournalLine resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false - description: '' name: journalId in: query required: false deprecated: false allowEmptyValue: true schema: type: string style: form explode: false allowReserved: false - description: '' name: journalId[] in: query required: false deprecated: false allowEmptyValue: true schema: type: array items: type: string style: form explode: true allowReserved: false responses: '200': description: JournalLine collection content: application/json: schema: $ref: '#/components/schemas/JournalLineListResourcesResponse' application/xml: schema: $ref: '#/components/schemas/JournalLineListResources200Response' text/xml: schema: $ref: '#/components/schemas/JournalLineListResources200Response' text/csv: schema: $ref: '#/components/schemas/JournalLineListResources200Response' text/html: schema: $ref: '#/components/schemas/JournalLineListResources200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/journal_lines?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&journalId=SOME_STRING_VALUE&journalId%5B%5D=SOME_ARRAY_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/journal_lines?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&journalId=SOME_STRING_VALUE&journalId%5B%5D=SOME_ARRAY_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/journal_lines?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&journalId=SOME_STRING_VALUE&journalId%5B%5D=SOME_ARRAY_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/journal_lines?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&journalId=SOME_STRING_VALUE&journalId%5B%5D=SOME_ARRAY_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/journal_lines?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&journalId=SOME_STRING_VALUE&journalId%5B%5D=SOME_ARRAY_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/journal_lines?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&journalId=SOME_STRING_VALUE&journalId%5B%5D=SOME_ARRAY_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/journal_lines?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&journalId=SOME_STRING_VALUE&journalId%5B%5D=SOME_ARRAY_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/journal_lines?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&journalId=SOME_STRING_VALUE&journalId%5B%5D=SOME_ARRAY_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/journal_lines?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE&journalId=SOME_STRING_VALUE&journalId%5B%5D=SOME_ARRAY_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /journal_lines/{id}: parameters: [] get: tags: - JournalLine summary: Retrieves a JournalLine resource. operationId: JournalLine_getResource description: Retrieves a JournalLine resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: JournalLine resource content: application/json: schema: $ref: '#/components/schemas/JournalLineGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/JournalLineGetResource200Response' text/xml: schema: $ref: '#/components/schemas/JournalLineGetResource200Response' text/csv: schema: $ref: '#/components/schemas/JournalLineGetResource200Response' text/html: schema: $ref: '#/components/schemas/JournalLineGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/journal_lines/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/journal_lines/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/journal_lines/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/journal_lines/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/journal_lines/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/journal_lines/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/journal_lines/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/journal_lines/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/journal_lines/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /journals: parameters: [] get: tags: - Journal summary: Retrieves the collection of Journal resources. operationId: Journal_getCollection description: Retrieves the collection of Journal resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Journal collection content: application/json: schema: $ref: '#/components/schemas/JournalGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/JournalGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/JournalGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/JournalGetCollection200Response' text/html: schema: $ref: '#/components/schemas/JournalGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /journals/{id}: parameters: [] get: tags: - Journal summary: Retrieves a Journal resource. operationId: Journal_getResource description: Retrieves a Journal resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Journal resource content: application/json: schema: $ref: '#/components/schemas/JournalGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/JournalGetResource200Response' text/xml: schema: $ref: '#/components/schemas/JournalGetResource200Response' text/csv: schema: $ref: '#/components/schemas/JournalGetResource200Response' text/html: schema: $ref: '#/components/schemas/JournalGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/journals/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/journals/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/journals/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/journals/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/journals/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/journals/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/journals/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/journals/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/journals/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /leads: parameters: [] get: tags: - Lead summary: Retrieves the collection of Lead resources. operationId: Lead_getCollection description: Retrieves the collection of Lead resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Lead collection content: application/json: schema: $ref: '#/components/schemas/LeadGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/LeadGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/LeadGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/LeadGetCollection200Response' text/html: schema: $ref: '#/components/schemas/LeadGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/leads?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/leads?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/leads?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/leads?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/leads?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/leads?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/leads?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/leads?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/leads?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - Lead summary: Creates a Lead resource. operationId: Lead_createResource description: Creates a Lead resource. parameters: [] requestBody: description: The new Lead resource content: application/json: schema: $ref: '#/components/schemas/LeadCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/LeadCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/LeadCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/LeadCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/LeadCreateResourceRequest4' required: true responses: '201': description: Lead resource created content: application/json: schema: $ref: '#/components/schemas/LeadCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/LeadCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/LeadCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/LeadCreateResource201Response' text/html: schema: $ref: '#/components/schemas/LeadCreateResource201Response' links: GetLeadItem: operationId: getLeadItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /leads/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"email\":\"ron.aurthor@gmail.com\",\"firstName\":\"Ronald\",\"lastName\":\"Aurthor\",\"primaryPhone\":\"416-555-0126\",\"addressLine1\":\"39 Parliment road\",\"city\":\"Detroit\",\"country\":\"United States\",\"company\":\"Ronalds Hot Rods\",\"postalCode\":\"48653\",\"website\":\"https://www.ronshotrods.com\",\"industry\":\"Automotive\",\"skypeUsername\":\"ronaldAurthor0127\",\"twitter\":\"@ronaldAutomotive\",\"annualRevenue\":\"50000000\",\"employeeCount\":113,\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/leads") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/leads"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"email\":\"ron.aurthor@gmail.com\",\"firstName\":\"Ronald\",\"lastName\":\"Aurthor\",\"primaryPhone\":\"416-555-0126\",\"addressLine1\":\"39 Parliment road\",\"city\":\"Detroit\",\"country\":\"United States\",\"company\":\"Ronalds Hot Rods\",\"postalCode\":\"48653\",\"website\":\"https://www.ronshotrods.com\",\"industry\":\"Automotive\",\"skypeUsername\":\"ronaldAurthor0127\",\"twitter\":\"@ronaldAutomotive\",\"annualRevenue\":\"50000000\",\"employeeCount\":113,\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/leads \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"90300000072369","email":"ron.aurthor@gmail.com","firstName":"Ronald","lastName":"Aurthor","primaryPhone":"416-555-0126","addressLine1":"39 Parliment road","city":"Detroit","country":"United States","company":"Ronalds Hot Rods","postalCode":"48653","website":"https://www.ronshotrods.com","industry":"Automotive","skypeUsername":"ronaldAurthor0127","twitter":"@ronaldAutomotive","annualRevenue":"50000000","employeeCount":113,"created":"2021-07-28 00:00:00","modified":"2021-09-15 00:00:00"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/leads", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"email\":\"ron.aurthor@gmail.com\",\"firstName\":\"Ronald\",\"lastName\":\"Aurthor\",\"primaryPhone\":\"416-555-0126\",\"addressLine1\":\"39 Parliment road\",\"city\":\"Detroit\",\"country\":\"United States\",\"company\":\"Ronalds Hot Rods\",\"postalCode\":\"48653\",\"website\":\"https://www.ronshotrods.com\",\"industry\":\"Automotive\",\"skypeUsername\":\"ronaldAurthor0127\",\"twitter\":\"@ronaldAutomotive\",\"annualRevenue\":\"50000000\",\"employeeCount\":113,\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/leads") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"email\":\"ron.aurthor@gmail.com\",\"firstName\":\"Ronald\",\"lastName\":\"Aurthor\",\"primaryPhone\":\"416-555-0126\",\"addressLine1\":\"39 Parliment road\",\"city\":\"Detroit\",\"country\":\"United States\",\"company\":\"Ronalds Hot Rods\",\"postalCode\":\"48653\",\"website\":\"https://www.ronshotrods.com\",\"industry\":\"Automotive\",\"skypeUsername\":\"ronaldAurthor0127\",\"twitter\":\"@ronaldAutomotive\",\"annualRevenue\":\"50000000\",\"employeeCount\":113,\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"email\":\"ron.aurthor@gmail.com\",\"firstName\":\"Ronald\",\"lastName\":\"Aurthor\",\"primaryPhone\":\"416-555-0126\",\"addressLine1\":\"39 Parliment road\",\"city\":\"Detroit\",\"country\":\"United States\",\"company\":\"Ronalds Hot Rods\",\"postalCode\":\"48653\",\"website\":\"https://www.ronshotrods.com\",\"industry\":\"Automotive\",\"skypeUsername\":\"ronaldAurthor0127\",\"twitter\":\"@ronaldAutomotive\",\"annualRevenue\":\"50000000\",\"employeeCount\":113,\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/leads", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/leads\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"90300000072369\\\",\\\"email\\\":\\\"ron.aurthor@gmail.com\\\",\\\"firstName\\\":\\\"Ronald\\\",\\\"lastName\\\":\\\"Aurthor\\\",\\\"primaryPhone\\\":\\\"416-555-0126\\\",\\\"addressLine1\\\":\\\"39 Parliment road\\\",\\\"city\\\":\\\"Detroit\\\",\\\"country\\\":\\\"United States\\\",\\\"company\\\":\\\"Ronalds Hot Rods\\\",\\\"postalCode\\\":\\\"48653\\\",\\\"website\\\":\\\"https://www.ronshotrods.com\\\",\\\"industry\\\":\\\"Automotive\\\",\\\"skypeUsername\\\":\\\"ronaldAurthor0127\\\",\\\"twitter\\\":\\\"@ronaldAutomotive\\\",\\\"annualRevenue\\\":\\\"50000000\\\",\\\"employeeCount\\\":113,\\\"created\\\":\\\"2021-07-28 00:00:00\\\",\\\"modified\\\":\\\"2021-09-15 00:00:00\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/leads", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"email\":\"ron.aurthor@gmail.com\",\"firstName\":\"Ronald\",\"lastName\":\"Aurthor\",\"primaryPhone\":\"416-555-0126\",\"addressLine1\":\"39 Parliment road\",\"city\":\"Detroit\",\"country\":\"United States\",\"company\":\"Ronalds Hot Rods\",\"postalCode\":\"48653\",\"website\":\"https://www.ronshotrods.com\",\"industry\":\"Automotive\",\"skypeUsername\":\"ronaldAurthor0127\",\"twitter\":\"@ronaldAutomotive\",\"annualRevenue\":\"50000000\",\"employeeCount\":113,\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/leads", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '90300000072369', email: 'ron.aurthor@gmail.com', firstName: 'Ronald', lastName: 'Aurthor', primaryPhone: '416-555-0126', addressLine1: '39 Parliment road', city: 'Detroit', country: 'United States', company: 'Ronalds Hot Rods', postalCode: '48653', website: 'https://www.ronshotrods.com', industry: 'Automotive', skypeUsername: 'ronaldAurthor0127', twitter: '@ronaldAutomotive', annualRevenue: '50000000', employeeCount: 113, created: '2021-07-28 00:00:00', modified: '2021-09-15 00:00:00' })); req.end(); /leads/{id}: parameters: [] get: tags: - Lead summary: Retrieves a Lead resource. operationId: Lead_getResource description: Retrieves a Lead resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Lead resource content: application/json: schema: $ref: '#/components/schemas/LeadGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/LeadGetResource200Response' text/xml: schema: $ref: '#/components/schemas/LeadGetResource200Response' text/csv: schema: $ref: '#/components/schemas/LeadGetResource200Response' text/html: schema: $ref: '#/components/schemas/LeadGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/leads/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/leads/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/leads/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/leads/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/leads/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/leads/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/leads/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/leads/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/leads/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - Lead summary: Replaces the Lead resource. operationId: Lead_replaceResource description: Replaces the Lead resource. parameters: - description: Resource identifier name: id in: path 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/LeadReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/LeadReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/LeadReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/LeadReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/LeadReplaceResourceRequest4' required: true responses: '200': description: Lead resource updated content: application/json: schema: $ref: '#/components/schemas/LeadReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/LeadReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/LeadReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/LeadReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/LeadReplaceResource200Response' links: GetLeadItem: operationId: getLeadItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /leads/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"email\":\"ron.aurthor@gmail.com\",\"firstName\":\"Ronald\",\"lastName\":\"Aurthor\",\"primaryPhone\":\"416-555-0126\",\"addressLine1\":\"39 Parliment road\",\"city\":\"Detroit\",\"country\":\"United States\",\"company\":\"Ronalds Hot Rods\",\"postalCode\":\"48653\",\"website\":\"https://www.ronshotrods.com\",\"industry\":\"Automotive\",\"skypeUsername\":\"ronaldAurthor0127\",\"twitter\":\"@ronaldAutomotive\",\"annualRevenue\":\"50000000\",\"employeeCount\":113,\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/leads/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/leads/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"email\":\"ron.aurthor@gmail.com\",\"firstName\":\"Ronald\",\"lastName\":\"Aurthor\",\"primaryPhone\":\"416-555-0126\",\"addressLine1\":\"39 Parliment road\",\"city\":\"Detroit\",\"country\":\"United States\",\"company\":\"Ronalds Hot Rods\",\"postalCode\":\"48653\",\"website\":\"https://www.ronshotrods.com\",\"industry\":\"Automotive\",\"skypeUsername\":\"ronaldAurthor0127\",\"twitter\":\"@ronaldAutomotive\",\"annualRevenue\":\"50000000\",\"employeeCount\":113,\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/leads/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"90300000072369","email":"ron.aurthor@gmail.com","firstName":"Ronald","lastName":"Aurthor","primaryPhone":"416-555-0126","addressLine1":"39 Parliment road","city":"Detroit","country":"United States","company":"Ronalds Hot Rods","postalCode":"48653","website":"https://www.ronshotrods.com","industry":"Automotive","skypeUsername":"ronaldAurthor0127","twitter":"@ronaldAutomotive","annualRevenue":"50000000","employeeCount":113,"created":"2021-07-28 00:00:00","modified":"2021-09-15 00:00:00"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/leads/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"email\":\"ron.aurthor@gmail.com\",\"firstName\":\"Ronald\",\"lastName\":\"Aurthor\",\"primaryPhone\":\"416-555-0126\",\"addressLine1\":\"39 Parliment road\",\"city\":\"Detroit\",\"country\":\"United States\",\"company\":\"Ronalds Hot Rods\",\"postalCode\":\"48653\",\"website\":\"https://www.ronshotrods.com\",\"industry\":\"Automotive\",\"skypeUsername\":\"ronaldAurthor0127\",\"twitter\":\"@ronaldAutomotive\",\"annualRevenue\":\"50000000\",\"employeeCount\":113,\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/leads/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"email\":\"ron.aurthor@gmail.com\",\"firstName\":\"Ronald\",\"lastName\":\"Aurthor\",\"primaryPhone\":\"416-555-0126\",\"addressLine1\":\"39 Parliment road\",\"city\":\"Detroit\",\"country\":\"United States\",\"company\":\"Ronalds Hot Rods\",\"postalCode\":\"48653\",\"website\":\"https://www.ronshotrods.com\",\"industry\":\"Automotive\",\"skypeUsername\":\"ronaldAurthor0127\",\"twitter\":\"@ronaldAutomotive\",\"annualRevenue\":\"50000000\",\"employeeCount\":113,\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"email\":\"ron.aurthor@gmail.com\",\"firstName\":\"Ronald\",\"lastName\":\"Aurthor\",\"primaryPhone\":\"416-555-0126\",\"addressLine1\":\"39 Parliment road\",\"city\":\"Detroit\",\"country\":\"United States\",\"company\":\"Ronalds Hot Rods\",\"postalCode\":\"48653\",\"website\":\"https://www.ronshotrods.com\",\"industry\":\"Automotive\",\"skypeUsername\":\"ronaldAurthor0127\",\"twitter\":\"@ronaldAutomotive\",\"annualRevenue\":\"50000000\",\"employeeCount\":113,\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/leads/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/leads/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"90300000072369\\\",\\\"email\\\":\\\"ron.aurthor@gmail.com\\\",\\\"firstName\\\":\\\"Ronald\\\",\\\"lastName\\\":\\\"Aurthor\\\",\\\"primaryPhone\\\":\\\"416-555-0126\\\",\\\"addressLine1\\\":\\\"39 Parliment road\\\",\\\"city\\\":\\\"Detroit\\\",\\\"country\\\":\\\"United States\\\",\\\"company\\\":\\\"Ronalds Hot Rods\\\",\\\"postalCode\\\":\\\"48653\\\",\\\"website\\\":\\\"https://www.ronshotrods.com\\\",\\\"industry\\\":\\\"Automotive\\\",\\\"skypeUsername\\\":\\\"ronaldAurthor0127\\\",\\\"twitter\\\":\\\"@ronaldAutomotive\\\",\\\"annualRevenue\\\":\\\"50000000\\\",\\\"employeeCount\\\":113,\\\"created\\\":\\\"2021-07-28 00:00:00\\\",\\\"modified\\\":\\\"2021-09-15 00:00:00\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/leads/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"email\":\"ron.aurthor@gmail.com\",\"firstName\":\"Ronald\",\"lastName\":\"Aurthor\",\"primaryPhone\":\"416-555-0126\",\"addressLine1\":\"39 Parliment road\",\"city\":\"Detroit\",\"country\":\"United States\",\"company\":\"Ronalds Hot Rods\",\"postalCode\":\"48653\",\"website\":\"https://www.ronshotrods.com\",\"industry\":\"Automotive\",\"skypeUsername\":\"ronaldAurthor0127\",\"twitter\":\"@ronaldAutomotive\",\"annualRevenue\":\"50000000\",\"employeeCount\":113,\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/leads/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '90300000072369', email: 'ron.aurthor@gmail.com', firstName: 'Ronald', lastName: 'Aurthor', primaryPhone: '416-555-0126', addressLine1: '39 Parliment road', city: 'Detroit', country: 'United States', company: 'Ronalds Hot Rods', postalCode: '48653', website: 'https://www.ronshotrods.com', industry: 'Automotive', skypeUsername: 'ronaldAurthor0127', twitter: '@ronaldAutomotive', annualRevenue: '50000000', employeeCount: 113, created: '2021-07-28 00:00:00', modified: '2021-09-15 00:00:00' })); req.end(); delete: tags: - Lead summary: Removes the Lead resource. operationId: Lead_removeResource description: Removes the Lead resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: Lead resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/leads/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/leads/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/leads/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/leads/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/leads/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/leads/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/leads/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/leads/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/leads/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /ledger_account_opening_balances: parameters: [] get: tags: - LedgerAccountOpeningBalance summary: Retrieves the collection of LedgerAccountOpeningBalance resources. operationId: LedgerAccountOpeningBalance_getCollection description: Retrieves the collection of LedgerAccountOpeningBalance resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: LedgerAccountOpeningBalance collection content: application/json: schema: $ref: >- #/components/schemas/LedgerAccountOpeningBalanceGetCollectionResponse application/xml: schema: $ref: >- #/components/schemas/LedgerAccountOpeningBalanceGetCollection200Response text/xml: schema: $ref: >- #/components/schemas/LedgerAccountOpeningBalanceGetCollection200Response text/csv: schema: $ref: >- #/components/schemas/LedgerAccountOpeningBalanceGetCollection200Response text/html: schema: $ref: >- #/components/schemas/LedgerAccountOpeningBalanceGetCollection200Response deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/ledger_account_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/ledger_account_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/ledger_account_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/ledger_account_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/ledger_account_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/ledger_account_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/ledger_account_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/ledger_account_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/ledger_account_opening_balances?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /ledger_account_opening_balances/{id}: parameters: [] get: tags: - LedgerAccountOpeningBalance summary: Retrieves a LedgerAccountOpeningBalance resource. operationId: LedgerAccountOpeningBalance_getResource description: Retrieves a LedgerAccountOpeningBalance resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: LedgerAccountOpeningBalance resource content: application/json: schema: $ref: >- #/components/schemas/LedgerAccountOpeningBalanceGetResourceResponse application/xml: schema: $ref: >- #/components/schemas/LedgerAccountOpeningBalanceGetResource200Response text/xml: schema: $ref: >- #/components/schemas/LedgerAccountOpeningBalanceGetResource200Response text/csv: schema: $ref: >- #/components/schemas/LedgerAccountOpeningBalanceGetResource200Response text/html: schema: $ref: >- #/components/schemas/LedgerAccountOpeningBalanceGetResource200Response '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/ledger_account_opening_balances/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/ledger_account_opening_balances/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/ledger_account_opening_balances/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/ledger_account_opening_balances/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/ledger_account_opening_balances/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/ledger_account_opening_balances/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/ledger_account_opening_balances/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/ledger_account_opening_balances/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/ledger_account_opening_balances/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /ledger_account_types: parameters: [] get: tags: - LedgerAccountType summary: Retrieves the collection of LedgerAccountType resources. operationId: LedgerAccountType_listOfResources description: Retrieves the collection of LedgerAccountType resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: LedgerAccountType collection content: application/json: schema: $ref: '#/components/schemas/LedgerAccountTypeListOfResourcesResponse' application/xml: schema: $ref: >- #/components/schemas/LedgerAccountTypeListOfResources200Response text/xml: schema: $ref: >- #/components/schemas/LedgerAccountTypeListOfResources200Response text/csv: schema: $ref: >- #/components/schemas/LedgerAccountTypeListOfResources200Response text/html: schema: $ref: >- #/components/schemas/LedgerAccountTypeListOfResources200Response deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/ledger_account_types?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/ledger_account_types?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/ledger_account_types?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/ledger_account_types?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/ledger_account_types?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/ledger_account_types?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/ledger_account_types?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/ledger_account_types?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/ledger_account_types?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /ledger_account_types/{id}: parameters: [] get: tags: - LedgerAccountType summary: Retrieves a LedgerAccountType resource. operationId: LedgerAccountType_getResource description: Retrieves a LedgerAccountType resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: LedgerAccountType resource content: application/json: schema: $ref: '#/components/schemas/LedgerAccountTypeGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/LedgerAccountTypeGetResource200Response' text/xml: schema: $ref: '#/components/schemas/LedgerAccountTypeGetResource200Response' text/csv: schema: $ref: '#/components/schemas/LedgerAccountTypeGetResource200Response' text/html: schema: $ref: '#/components/schemas/LedgerAccountTypeGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/ledger_account_types/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/ledger_account_types/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/ledger_account_types/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/ledger_account_types/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/ledger_account_types/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/ledger_account_types/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/ledger_account_types/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/ledger_account_types/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/ledger_account_types/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /ledger_accounts: parameters: [] get: tags: - LedgerAccounts summary: Retrieves the collection of LedgerAccounts resources. operationId: LedgerAccounts_getCollection description: Retrieves the collection of LedgerAccounts resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: LedgerAccounts collection content: application/json: schema: $ref: '#/components/schemas/LedgerAccountsGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/LedgerAccountsGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/LedgerAccountsGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/LedgerAccountsGetCollection200Response' text/html: schema: $ref: '#/components/schemas/LedgerAccountsGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/ledger_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/ledger_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/ledger_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/ledger_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/ledger_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/ledger_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/ledger_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/ledger_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/ledger_accounts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /ledger_accounts/{id}: parameters: [] get: tags: - LedgerAccounts summary: Retrieves a LedgerAccounts resource. operationId: LedgerAccounts_getResource description: Retrieves a LedgerAccounts resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: LedgerAccounts resource content: application/json: schema: $ref: '#/components/schemas/LedgerAccountsGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/LedgerAccountsGetResource200Response' text/xml: schema: $ref: '#/components/schemas/LedgerAccountsGetResource200Response' text/csv: schema: $ref: '#/components/schemas/LedgerAccountsGetResource200Response' text/html: schema: $ref: '#/components/schemas/LedgerAccountsGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/ledger_accounts/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/ledger_accounts/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/ledger_accounts/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/ledger_accounts/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/ledger_accounts/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/ledger_accounts/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/ledger_accounts/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/ledger_accounts/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/ledger_accounts/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /ledger_entries: parameters: [] get: tags: - LedgerEntry summary: Retrieves the collection of LedgerEntry resources. operationId: LedgerEntry_getCollection description: Retrieves the collection of LedgerEntry resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: LedgerEntry collection content: application/json: schema: $ref: '#/components/schemas/LedgerEntryGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/LedgerEntryGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/LedgerEntryGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/LedgerEntryGetCollection200Response' text/html: schema: $ref: '#/components/schemas/LedgerEntryGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/ledger_entries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/ledger_entries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/ledger_entries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/ledger_entries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/ledger_entries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/ledger_entries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/ledger_entries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/ledger_entries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/ledger_entries?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /ledger_entries/{id}: parameters: [] get: tags: - LedgerEntry summary: Retrieves a LedgerEntry resource. operationId: LedgerEntry_getResource description: Retrieves a LedgerEntry resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: LedgerEntry resource content: application/json: schema: $ref: '#/components/schemas/LedgerEntryGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/LedgerEntryGetResource200Response' text/xml: schema: $ref: '#/components/schemas/LedgerEntryGetResource200Response' text/csv: schema: $ref: '#/components/schemas/LedgerEntryGetResource200Response' text/html: schema: $ref: '#/components/schemas/LedgerEntryGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/ledger_entries/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/ledger_entries/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/ledger_entries/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/ledger_entries/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/ledger_entries/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/ledger_entries/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/ledger_entries/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/ledger_entries/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/ledger_entries/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /linked_transactions: parameters: [] get: tags: - LinkedTransaction summary: Retrieves the collection of LinkedTransaction resources. operationId: LinkedTransaction_listResources description: Retrieves the collection of LinkedTransaction resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: LinkedTransaction collection content: application/json: schema: $ref: '#/components/schemas/LinkedTransactionListResourcesResponse' application/xml: schema: $ref: '#/components/schemas/LinkedTransactionListResources200Response' text/xml: schema: $ref: '#/components/schemas/LinkedTransactionListResources200Response' text/csv: schema: $ref: '#/components/schemas/LinkedTransactionListResources200Response' text/html: schema: $ref: '#/components/schemas/LinkedTransactionListResources200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/linked_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/linked_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/linked_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/linked_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/linked_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/linked_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/linked_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/linked_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/linked_transactions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /linked_transactions/{id}: parameters: [] get: tags: - LinkedTransaction summary: Retrieves a LinkedTransaction resource. operationId: LinkedTransaction_getResource description: Retrieves a LinkedTransaction resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: LinkedTransaction resource content: application/json: schema: $ref: '#/components/schemas/LinkedTransactionGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/LinkedTransactionGetResource200Response' text/xml: schema: $ref: '#/components/schemas/LinkedTransactionGetResource200Response' text/csv: schema: $ref: '#/components/schemas/LinkedTransactionGetResource200Response' text/html: schema: $ref: '#/components/schemas/LinkedTransactionGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/linked_transactions/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/linked_transactions/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/linked_transactions/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/linked_transactions/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/linked_transactions/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/linked_transactions/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/linked_transactions/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/linked_transactions/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/linked_transactions/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /locations: parameters: [] get: tags: - Location summary: Retrieves the collection of Location resources. operationId: Location_getCollection description: Retrieves the collection of Location resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Location collection content: application/json: schema: $ref: '#/components/schemas/LocationGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/LocationGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/LocationGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/LocationGetCollection200Response' text/html: schema: $ref: '#/components/schemas/LocationGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - Location summary: Creates a Location resource. operationId: Location_createResource description: Creates a Location resource. parameters: [] requestBody: description: The new Location resource content: application/json: schema: $ref: '#/components/schemas/LocationCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/LocationCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/LocationCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/LocationCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/LocationCreateResourceRequest4' required: true responses: '201': description: Location resource created content: application/json: schema: $ref: '#/components/schemas/LocationCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/LocationCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/LocationCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/LocationCreateResource201Response' text/html: schema: $ref: '#/components/schemas/LocationCreateResource201Response' links: GetLocationItem: operationId: getLocationItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /locations/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"id\":\"quickbooks-34\",\"integration\":\"square\",\"srcId\":\"string\",\"created\":\"2013-11-18T02:17:40.080Z\",\"businessName\":\"Bowman and Co\",\"currency\":\"USD\",\"type\":\"string\",\"country\":\"United States\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"postalCode\":\"99660\",\"address\":\"708 Woodland Avenue\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/locations") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/locations"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"id\":\"quickbooks-34\",\"integration\":\"square\",\"srcId\":\"string\",\"created\":\"2013-11-18T02:17:40.080Z\",\"businessName\":\"Bowman and Co\",\"currency\":\"USD\",\"type\":\"string\",\"country\":\"United States\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"postalCode\":\"99660\",\"address\":\"708 Woodland Avenue\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/locations \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"id":"quickbooks-34","integration":"square","srcId":"string","created":"2013-11-18T02:17:40.080Z","businessName":"Bowman and Co","currency":"USD","type":"string","country":"United States","city":"St Paul","state":"Alaska","postalCode":"99660","address":"708 Woodland Avenue"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/locations", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"id\":\"quickbooks-34\",\"integration\":\"square\",\"srcId\":\"string\",\"created\":\"2013-11-18T02:17:40.080Z\",\"businessName\":\"Bowman and Co\",\"currency\":\"USD\",\"type\":\"string\",\"country\":\"United States\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"postalCode\":\"99660\",\"address\":\"708 Woodland Avenue\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/locations") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"id\":\"quickbooks-34\",\"integration\":\"square\",\"srcId\":\"string\",\"created\":\"2013-11-18T02:17:40.080Z\",\"businessName\":\"Bowman and Co\",\"currency\":\"USD\",\"type\":\"string\",\"country\":\"United States\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"postalCode\":\"99660\",\"address\":\"708 Woodland Avenue\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"id\":\"quickbooks-34\",\"integration\":\"square\",\"srcId\":\"string\",\"created\":\"2013-11-18T02:17:40.080Z\",\"businessName\":\"Bowman and Co\",\"currency\":\"USD\",\"type\":\"string\",\"country\":\"United States\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"postalCode\":\"99660\",\"address\":\"708 Woodland Avenue\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/locations", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/locations\"\n\n\tpayload := strings.NewReader(\"{\\\"id\\\":\\\"quickbooks-34\\\",\\\"integration\\\":\\\"square\\\",\\\"srcId\\\":\\\"string\\\",\\\"created\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"businessName\\\":\\\"Bowman and Co\\\",\\\"currency\\\":\\\"USD\\\",\\\"type\\\":\\\"string\\\",\\\"country\\\":\\\"United States\\\",\\\"city\\\":\\\"St Paul\\\",\\\"state\\\":\\\"Alaska\\\",\\\"postalCode\\\":\\\"99660\\\",\\\"address\\\":\\\"708 Woodland Avenue\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/locations", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"id\":\"quickbooks-34\",\"integration\":\"square\",\"srcId\":\"string\",\"created\":\"2013-11-18T02:17:40.080Z\",\"businessName\":\"Bowman and Co\",\"currency\":\"USD\",\"type\":\"string\",\"country\":\"United States\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"postalCode\":\"99660\",\"address\":\"708 Woodland Avenue\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/locations", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ id: 'quickbooks-34', integration: 'square', srcId: 'string', created: '2013-11-18T02:17:40.080Z', businessName: 'Bowman and Co', currency: 'USD', type: 'string', country: 'United States', city: 'St Paul', state: 'Alaska', postalCode: '99660', address: '708 Woodland Avenue' })); req.end(); /locations/{id}: parameters: [] get: tags: - Location summary: Retrieves a Location resource. operationId: Location_getResource description: Retrieves a Location resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Location resource content: application/json: schema: $ref: '#/components/schemas/LocationGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/LocationGetResource200Response' text/xml: schema: $ref: '#/components/schemas/LocationGetResource200Response' text/csv: schema: $ref: '#/components/schemas/LocationGetResource200Response' text/html: schema: $ref: '#/components/schemas/LocationGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/locations/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/locations/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/locations/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/locations/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/locations/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/locations/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/locations/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/locations/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/locations/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - Location summary: Replaces the Location resource. operationId: Location_replaceResource description: Replaces the Location resource. parameters: - description: Resource identifier name: id in: path 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/LocationReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/LocationReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/LocationReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/LocationReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/LocationReplaceResourceRequest4' required: true responses: '200': description: Location resource updated content: application/json: schema: $ref: '#/components/schemas/LocationReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/LocationReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/LocationReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/LocationReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/LocationReplaceResource200Response' links: GetLocationItem: operationId: getLocationItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /locations/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"id\":\"quickbooks-34\",\"integration\":\"square\",\"srcId\":\"string\",\"created\":\"2013-11-18T02:17:40.080Z\",\"businessName\":\"Bowman and Co\",\"currency\":\"USD\",\"type\":\"string\",\"country\":\"United States\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"postalCode\":\"99660\",\"address\":\"708 Woodland Avenue\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/locations/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/locations/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"id\":\"quickbooks-34\",\"integration\":\"square\",\"srcId\":\"string\",\"created\":\"2013-11-18T02:17:40.080Z\",\"businessName\":\"Bowman and Co\",\"currency\":\"USD\",\"type\":\"string\",\"country\":\"United States\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"postalCode\":\"99660\",\"address\":\"708 Woodland Avenue\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/locations/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"id":"quickbooks-34","integration":"square","srcId":"string","created":"2013-11-18T02:17:40.080Z","businessName":"Bowman and Co","currency":"USD","type":"string","country":"United States","city":"St Paul","state":"Alaska","postalCode":"99660","address":"708 Woodland Avenue"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/locations/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"id\":\"quickbooks-34\",\"integration\":\"square\",\"srcId\":\"string\",\"created\":\"2013-11-18T02:17:40.080Z\",\"businessName\":\"Bowman and Co\",\"currency\":\"USD\",\"type\":\"string\",\"country\":\"United States\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"postalCode\":\"99660\",\"address\":\"708 Woodland Avenue\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/locations/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"id\":\"quickbooks-34\",\"integration\":\"square\",\"srcId\":\"string\",\"created\":\"2013-11-18T02:17:40.080Z\",\"businessName\":\"Bowman and Co\",\"currency\":\"USD\",\"type\":\"string\",\"country\":\"United States\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"postalCode\":\"99660\",\"address\":\"708 Woodland Avenue\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"id\":\"quickbooks-34\",\"integration\":\"square\",\"srcId\":\"string\",\"created\":\"2013-11-18T02:17:40.080Z\",\"businessName\":\"Bowman and Co\",\"currency\":\"USD\",\"type\":\"string\",\"country\":\"United States\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"postalCode\":\"99660\",\"address\":\"708 Woodland Avenue\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/locations/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/locations/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"id\\\":\\\"quickbooks-34\\\",\\\"integration\\\":\\\"square\\\",\\\"srcId\\\":\\\"string\\\",\\\"created\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"businessName\\\":\\\"Bowman and Co\\\",\\\"currency\\\":\\\"USD\\\",\\\"type\\\":\\\"string\\\",\\\"country\\\":\\\"United States\\\",\\\"city\\\":\\\"St Paul\\\",\\\"state\\\":\\\"Alaska\\\",\\\"postalCode\\\":\\\"99660\\\",\\\"address\\\":\\\"708 Woodland Avenue\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/locations/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"id\":\"quickbooks-34\",\"integration\":\"square\",\"srcId\":\"string\",\"created\":\"2013-11-18T02:17:40.080Z\",\"businessName\":\"Bowman and Co\",\"currency\":\"USD\",\"type\":\"string\",\"country\":\"United States\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"postalCode\":\"99660\",\"address\":\"708 Woodland Avenue\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/locations/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ id: 'quickbooks-34', integration: 'square', srcId: 'string', created: '2013-11-18T02:17:40.080Z', businessName: 'Bowman and Co', currency: 'USD', type: 'string', country: 'United States', city: 'St Paul', state: 'Alaska', postalCode: '99660', address: '708 Woodland Avenue' })); req.end(); delete: tags: - Location summary: Removes the Location resource. operationId: Location_removeResource description: Removes the Location resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: Location resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/locations/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/locations/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/locations/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/locations/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/locations/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/locations/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/locations/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/locations/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/locations/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /manual_journals: parameters: [] get: tags: - ManualJournal summary: Retrieves the collection of ManualJournal resources. operationId: ManualJournal_getCollection description: Retrieves the collection of ManualJournal resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: ManualJournal collection content: application/json: schema: $ref: '#/components/schemas/ManualJournalGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/ManualJournalGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/ManualJournalGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/ManualJournalGetCollection200Response' text/html: schema: $ref: '#/components/schemas/ManualJournalGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/manual_journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/manual_journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/manual_journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/manual_journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/manual_journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/manual_journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/manual_journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/manual_journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/manual_journals?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /manual_journals/{id}: parameters: [] get: tags: - ManualJournal summary: Retrieves a ManualJournal resource. operationId: ManualJournal_getResource description: Retrieves a ManualJournal resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: ManualJournal resource content: application/json: schema: $ref: '#/components/schemas/ManualJournalGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/ManualJournalGetResource200Response' text/xml: schema: $ref: '#/components/schemas/ManualJournalGetResource200Response' text/csv: schema: $ref: '#/components/schemas/ManualJournalGetResource200Response' text/html: schema: $ref: '#/components/schemas/ManualJournalGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/manual_journals/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/manual_journals/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/manual_journals/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/manual_journals/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/manual_journals/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/manual_journals/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/manual_journals/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/manual_journals/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/manual_journals/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /metrics: parameters: [] get: tags: - Metrics summary: Retrieves a set of metrics operationId: Metrics_getSet description: Retrieves a Metrics resource. parameters: - description: YYYY-MM-DD name: start in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-07-01' - description: YYYY-MM-DD name: end in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-08-31' - description: >- If refresh is set, data will be fetched from the source application even when cached data is available name: refresh in: query required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false example: 'true' responses: '200': description: Metrics resource content: application/json: schema: $ref: '#/components/schemas/MetricsGetSetResponse' application/xml: schema: $ref: '#/components/schemas/MetricsGetSet200Response' text/xml: schema: $ref: '#/components/schemas/MetricsGetSet200Response' text/csv: schema: $ref: '#/components/schemas/MetricsGetSet200Response' text/html: schema: $ref: '#/components/schemas/MetricsGetSet200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/metrics?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/metrics?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/metrics?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/metrics?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/metrics?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/metrics?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/metrics?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/metrics?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/metrics?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /order_returns: parameters: [] get: tags: - OrderReturn summary: Retrieves the collection of OrderReturn resources. operationId: OrderReturn_listResources description: Retrieves the collection of OrderReturn resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: OrderReturn collection content: application/json: schema: $ref: '#/components/schemas/OrderReturnListResourcesResponse' application/xml: schema: $ref: '#/components/schemas/OrderReturnListResources200Response' text/xml: schema: $ref: '#/components/schemas/OrderReturnListResources200Response' text/csv: schema: $ref: '#/components/schemas/OrderReturnListResources200Response' text/html: schema: $ref: '#/components/schemas/OrderReturnListResources200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/order_returns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/order_returns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/order_returns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/order_returns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/order_returns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/order_returns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/order_returns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/order_returns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/order_returns?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /order_returns/{id}: parameters: [] get: tags: - OrderReturn summary: Retrieves a OrderReturn resource. operationId: OrderReturn_getResource description: Retrieves a OrderReturn resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: OrderReturn resource content: application/json: schema: $ref: '#/components/schemas/OrderReturnGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/OrderReturnGetResource200Response' text/xml: schema: $ref: '#/components/schemas/OrderReturnGetResource200Response' text/csv: schema: $ref: '#/components/schemas/OrderReturnGetResource200Response' text/html: schema: $ref: '#/components/schemas/OrderReturnGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/order_returns/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/order_returns/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/order_returns/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/order_returns/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/order_returns/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/order_returns/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/order_returns/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/order_returns/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/order_returns/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /orders: parameters: [] get: tags: - Order summary: Retrieves the collection of Order resources. operationId: Order_getCollection description: Retrieves the collection of Order resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Order collection content: application/json: schema: $ref: '#/components/schemas/OrderGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/OrderGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/OrderGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/OrderGetCollection200Response' text/html: schema: $ref: '#/components/schemas/OrderGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - Order summary: Creates a Order resource. operationId: Order_createResource description: Creates a Order resource. parameters: [] requestBody: description: The new Order resource content: application/json: schema: $ref: '#/components/schemas/OrderCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/OrderCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/OrderCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/OrderCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/OrderCreateResourceRequest4' required: true responses: '201': description: Order resource created content: application/json: schema: $ref: '#/components/schemas/OrderCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/OrderCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/OrderCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/OrderCreateResource201Response' text/html: schema: $ref: '#/components/schemas/OrderCreateResource201Response' links: GetOrderItem: operationId: getOrderItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /orders/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcID\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"name\":\"New order\",\"orderDate\":\"2019-08-25T02:17:40.080Z\",\"orderStatus\":\"activated\",\"description\":\"Monthly bundle\",\"amount\":\"1200\",\"quantity\":5,\"modified\":\"2019-08-25T02:17:40.080Z\",\"customerId\":\"C005\",\"firstName\":\"Jane\",\"lastName\":\"Doe\",\"currency\":\"USD\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/orders") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/orders"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcID\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"name\":\"New order\",\"orderDate\":\"2019-08-25T02:17:40.080Z\",\"orderStatus\":\"activated\",\"description\":\"Monthly bundle\",\"amount\":\"1200\",\"quantity\":5,\"modified\":\"2019-08-25T02:17:40.080Z\",\"customerId\":\"C005\",\"firstName\":\"Jane\",\"lastName\":\"Doe\",\"currency\":\"USD\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/orders \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcID":"GH2JK-67283H-YW82KHX-2883KK-KS78S","name":"New order","orderDate":"2019-08-25T02:17:40.080Z","orderStatus":"activated","description":"Monthly bundle","amount":"1200","quantity":5,"modified":"2019-08-25T02:17:40.080Z","customerId":"C005","firstName":"Jane","lastName":"Doe","currency":"USD"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/orders", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcID\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"name\":\"New order\",\"orderDate\":\"2019-08-25T02:17:40.080Z\",\"orderStatus\":\"activated\",\"description\":\"Monthly bundle\",\"amount\":\"1200\",\"quantity\":5,\"modified\":\"2019-08-25T02:17:40.080Z\",\"customerId\":\"C005\",\"firstName\":\"Jane\",\"lastName\":\"Doe\",\"currency\":\"USD\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/orders") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcID\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"name\":\"New order\",\"orderDate\":\"2019-08-25T02:17:40.080Z\",\"orderStatus\":\"activated\",\"description\":\"Monthly bundle\",\"amount\":\"1200\",\"quantity\":5,\"modified\":\"2019-08-25T02:17:40.080Z\",\"customerId\":\"C005\",\"firstName\":\"Jane\",\"lastName\":\"Doe\",\"currency\":\"USD\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcID\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"name\":\"New order\",\"orderDate\":\"2019-08-25T02:17:40.080Z\",\"orderStatus\":\"activated\",\"description\":\"Monthly bundle\",\"amount\":\"1200\",\"quantity\":5,\"modified\":\"2019-08-25T02:17:40.080Z\",\"customerId\":\"C005\",\"firstName\":\"Jane\",\"lastName\":\"Doe\",\"currency\":\"USD\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/orders", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/orders\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcID\\\":\\\"GH2JK-67283H-YW82KHX-2883KK-KS78S\\\",\\\"name\\\":\\\"New order\\\",\\\"orderDate\\\":\\\"2019-08-25T02:17:40.080Z\\\",\\\"orderStatus\\\":\\\"activated\\\",\\\"description\\\":\\\"Monthly bundle\\\",\\\"amount\\\":\\\"1200\\\",\\\"quantity\\\":5,\\\"modified\\\":\\\"2019-08-25T02:17:40.080Z\\\",\\\"customerId\\\":\\\"C005\\\",\\\"firstName\\\":\\\"Jane\\\",\\\"lastName\\\":\\\"Doe\\\",\\\"currency\\\":\\\"USD\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/orders", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcID\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"name\":\"New order\",\"orderDate\":\"2019-08-25T02:17:40.080Z\",\"orderStatus\":\"activated\",\"description\":\"Monthly bundle\",\"amount\":\"1200\",\"quantity\":5,\"modified\":\"2019-08-25T02:17:40.080Z\",\"customerId\":\"C005\",\"firstName\":\"Jane\",\"lastName\":\"Doe\",\"currency\":\"USD\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/orders", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcID: 'GH2JK-67283H-YW82KHX-2883KK-KS78S', name: 'New order', orderDate: '2019-08-25T02:17:40.080Z', orderStatus: 'activated', description: 'Monthly bundle', amount: '1200', quantity: 5, modified: '2019-08-25T02:17:40.080Z', customerId: 'C005', firstName: 'Jane', lastName: 'Doe', currency: 'USD' })); req.end(); /orders/{id}: parameters: [] get: tags: - Order summary: Retrieves a Order resource. operationId: Order_getResource description: Retrieves a Order resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Order resource content: application/json: schema: $ref: '#/components/schemas/OrderGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/OrderGetResource200Response' text/xml: schema: $ref: '#/components/schemas/OrderGetResource200Response' text/csv: schema: $ref: '#/components/schemas/OrderGetResource200Response' text/html: schema: $ref: '#/components/schemas/OrderGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/orders/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/orders/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/orders/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/orders/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/orders/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/orders/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/orders/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/orders/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/orders/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - Order summary: Replaces the Order resource. operationId: Order_replaceResource description: Replaces the Order resource. parameters: - description: Resource identifier name: id in: path 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/OrderReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/OrderReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/OrderReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/OrderReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/OrderReplaceResourceRequest4' required: true responses: '200': description: Order resource updated content: application/json: schema: $ref: '#/components/schemas/OrderReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/OrderReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/OrderReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/OrderReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/OrderReplaceResource200Response' links: GetOrderItem: operationId: getOrderItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /orders/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcID\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"name\":\"New order\",\"orderDate\":\"2019-08-25T02:17:40.080Z\",\"orderStatus\":\"activated\",\"description\":\"Monthly bundle\",\"amount\":\"1200\",\"quantity\":5,\"modified\":\"2019-08-25T02:17:40.080Z\",\"customerId\":\"C005\",\"firstName\":\"Jane\",\"lastName\":\"Doe\",\"currency\":\"USD\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/orders/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/orders/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcID\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"name\":\"New order\",\"orderDate\":\"2019-08-25T02:17:40.080Z\",\"orderStatus\":\"activated\",\"description\":\"Monthly bundle\",\"amount\":\"1200\",\"quantity\":5,\"modified\":\"2019-08-25T02:17:40.080Z\",\"customerId\":\"C005\",\"firstName\":\"Jane\",\"lastName\":\"Doe\",\"currency\":\"USD\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/orders/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcID":"GH2JK-67283H-YW82KHX-2883KK-KS78S","name":"New order","orderDate":"2019-08-25T02:17:40.080Z","orderStatus":"activated","description":"Monthly bundle","amount":"1200","quantity":5,"modified":"2019-08-25T02:17:40.080Z","customerId":"C005","firstName":"Jane","lastName":"Doe","currency":"USD"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/orders/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcID\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"name\":\"New order\",\"orderDate\":\"2019-08-25T02:17:40.080Z\",\"orderStatus\":\"activated\",\"description\":\"Monthly bundle\",\"amount\":\"1200\",\"quantity\":5,\"modified\":\"2019-08-25T02:17:40.080Z\",\"customerId\":\"C005\",\"firstName\":\"Jane\",\"lastName\":\"Doe\",\"currency\":\"USD\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/orders/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcID\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"name\":\"New order\",\"orderDate\":\"2019-08-25T02:17:40.080Z\",\"orderStatus\":\"activated\",\"description\":\"Monthly bundle\",\"amount\":\"1200\",\"quantity\":5,\"modified\":\"2019-08-25T02:17:40.080Z\",\"customerId\":\"C005\",\"firstName\":\"Jane\",\"lastName\":\"Doe\",\"currency\":\"USD\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcID\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"name\":\"New order\",\"orderDate\":\"2019-08-25T02:17:40.080Z\",\"orderStatus\":\"activated\",\"description\":\"Monthly bundle\",\"amount\":\"1200\",\"quantity\":5,\"modified\":\"2019-08-25T02:17:40.080Z\",\"customerId\":\"C005\",\"firstName\":\"Jane\",\"lastName\":\"Doe\",\"currency\":\"USD\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/orders/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/orders/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcID\\\":\\\"GH2JK-67283H-YW82KHX-2883KK-KS78S\\\",\\\"name\\\":\\\"New order\\\",\\\"orderDate\\\":\\\"2019-08-25T02:17:40.080Z\\\",\\\"orderStatus\\\":\\\"activated\\\",\\\"description\\\":\\\"Monthly bundle\\\",\\\"amount\\\":\\\"1200\\\",\\\"quantity\\\":5,\\\"modified\\\":\\\"2019-08-25T02:17:40.080Z\\\",\\\"customerId\\\":\\\"C005\\\",\\\"firstName\\\":\\\"Jane\\\",\\\"lastName\\\":\\\"Doe\\\",\\\"currency\\\":\\\"USD\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/orders/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcID\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"name\":\"New order\",\"orderDate\":\"2019-08-25T02:17:40.080Z\",\"orderStatus\":\"activated\",\"description\":\"Monthly bundle\",\"amount\":\"1200\",\"quantity\":5,\"modified\":\"2019-08-25T02:17:40.080Z\",\"customerId\":\"C005\",\"firstName\":\"Jane\",\"lastName\":\"Doe\",\"currency\":\"USD\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/orders/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcID: 'GH2JK-67283H-YW82KHX-2883KK-KS78S', name: 'New order', orderDate: '2019-08-25T02:17:40.080Z', orderStatus: 'activated', description: 'Monthly bundle', amount: '1200', quantity: 5, modified: '2019-08-25T02:17:40.080Z', customerId: 'C005', firstName: 'Jane', lastName: 'Doe', currency: 'USD' })); req.end(); delete: tags: - Order summary: Removes the Order resource. operationId: Order_removeResource description: Removes the Order resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: Order resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/orders/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/orders/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/orders/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/orders/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/orders/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/orders/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/orders/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/orders/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/orders/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /organizations: parameters: [] get: tags: - Organization summary: Retrieves the collection of Organization resources. operationId: Organization_getCollection description: Retrieves the collection of Organization resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Organization collection content: application/json: schema: $ref: '#/components/schemas/OrganizationGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/OrganizationGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/OrganizationGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/OrganizationGetCollection200Response' text/html: schema: $ref: '#/components/schemas/OrganizationGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/organizations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/organizations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/organizations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/organizations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/organizations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/organizations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/organizations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/organizations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/organizations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /organizations/{id}: parameters: [] get: tags: - Organization summary: Retrieves a Organization resource. operationId: Organization_getResource description: Retrieves a Organization resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Organization resource content: application/json: schema: $ref: '#/components/schemas/OrganizationGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/OrganizationGetResource200Response' text/xml: schema: $ref: '#/components/schemas/OrganizationGetResource200Response' text/csv: schema: $ref: '#/components/schemas/OrganizationGetResource200Response' text/html: schema: $ref: '#/components/schemas/OrganizationGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/organizations/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/organizations/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/organizations/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/organizations/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/organizations/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/organizations/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/organizations/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/organizations/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/organizations/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /other_incomes: parameters: [] get: tags: - OtherIncome summary: Retrieves the collection of OtherIncome resources. operationId: OtherIncome_getCollection description: Retrieves the collection of OtherIncome resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: OtherIncome collection content: application/json: schema: $ref: '#/components/schemas/OtherIncomeGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/OtherIncomeGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/OtherIncomeGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/OtherIncomeGetCollection200Response' text/html: schema: $ref: '#/components/schemas/OtherIncomeGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/other_incomes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/other_incomes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/other_incomes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/other_incomes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/other_incomes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/other_incomes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/other_incomes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/other_incomes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/other_incomes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /other_incomes/{id}: parameters: [] get: tags: - OtherIncome summary: Retrieves a OtherIncome resource. operationId: OtherIncome_getResource description: Retrieves a OtherIncome resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: OtherIncome resource content: application/json: schema: $ref: '#/components/schemas/OtherIncomeGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/OtherIncomeGetResource200Response' text/xml: schema: $ref: '#/components/schemas/OtherIncomeGetResource200Response' text/csv: schema: $ref: '#/components/schemas/OtherIncomeGetResource200Response' text/html: schema: $ref: '#/components/schemas/OtherIncomeGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/other_incomes/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/other_incomes/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/other_incomes/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/other_incomes/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/other_incomes/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/other_incomes/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/other_incomes/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/other_incomes/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/other_incomes/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /owners: parameters: [] get: tags: - Owner summary: Retrieves the collection of Owner resources. operationId: Owner_getCollection description: Retrieves the collection of Owner resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Owner collection content: application/json: schema: $ref: '#/components/schemas/OwnerGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/OwnerGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/OwnerGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/OwnerGetCollection200Response' text/html: schema: $ref: '#/components/schemas/OwnerGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/owners?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/owners?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/owners?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/owners?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/owners?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/owners?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/owners?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/owners?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/owners?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /owners/{id}: parameters: [] get: tags: - Owner summary: Retrieves a Owner resource. operationId: Owner_getResource description: Retrieves a Owner resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Owner resource content: application/json: schema: $ref: '#/components/schemas/OwnerGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/OwnerGetResource200Response' text/xml: schema: $ref: '#/components/schemas/OwnerGetResource200Response' text/csv: schema: $ref: '#/components/schemas/OwnerGetResource200Response' text/html: schema: $ref: '#/components/schemas/OwnerGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/owners/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/owners/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/owners/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/owners/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/owners/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/owners/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/owners/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/owners/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/owners/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /payment_intents: parameters: [] get: tags: - PaymentIntent summary: Retrieves the collection of PaymentIntent resources. operationId: PaymentIntent_getCollection description: Retrieves the collection of PaymentIntent resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: PaymentIntent collection content: application/json: schema: $ref: '#/components/schemas/PaymentIntentGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/PaymentIntentGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/PaymentIntentGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/PaymentIntentGetCollection200Response' text/html: schema: $ref: '#/components/schemas/PaymentIntentGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payment_intents?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payment_intents?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/payment_intents?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payment_intents?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payment_intents?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/payment_intents?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payment_intents?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payment_intents?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payment_intents?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /payment_intents/{id}: parameters: [] get: tags: - PaymentIntent summary: Retrieves a PaymentIntent resource. operationId: PaymentIntent_getResource description: Retrieves a PaymentIntent resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: PaymentIntent resource content: application/json: schema: $ref: '#/components/schemas/PaymentIntentGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/PaymentIntentGetResource200Response' text/xml: schema: $ref: '#/components/schemas/PaymentIntentGetResource200Response' text/csv: schema: $ref: '#/components/schemas/PaymentIntentGetResource200Response' text/html: schema: $ref: '#/components/schemas/PaymentIntentGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payment_intents/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payment_intents/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/payment_intents/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payment_intents/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payment_intents/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/payment_intents/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payment_intents/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payment_intents/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payment_intents/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /payment_methods: parameters: [] get: tags: - PaymentMethod summary: Retrieves the collection of PaymentMethod resources. operationId: PaymentMethod_getCollection description: Retrieves the collection of PaymentMethod resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: PaymentMethod collection content: application/json: schema: $ref: '#/components/schemas/PaymentMethodGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/PaymentMethodGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/PaymentMethodGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/PaymentMethodGetCollection200Response' text/html: schema: $ref: '#/components/schemas/PaymentMethodGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payment_methods?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payment_methods?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/payment_methods?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payment_methods?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payment_methods?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/payment_methods?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payment_methods?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payment_methods?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payment_methods?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - PaymentMethod summary: Creates a PaymentMethod resource. operationId: PaymentMethod_createResource description: Creates a PaymentMethod resource. parameters: [] requestBody: description: The new PaymentMethod resource content: application/json: schema: $ref: '#/components/schemas/PaymentMethodCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/PaymentMethodCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/PaymentMethodCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/PaymentMethodCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/PaymentMethodCreateResourceRequest4' required: true responses: '201': description: PaymentMethod resource created content: application/json: schema: $ref: '#/components/schemas/PaymentMethodCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/PaymentMethodCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/PaymentMethodCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/PaymentMethodCreateResource201Response' text/html: schema: $ref: '#/components/schemas/PaymentMethodCreateResource201Response' links: GetPaymentMethodItem: operationId: getPaymentMethodItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /payment_methods/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"name\":\"Diners Club\",\"type\":\"CREDIT_CARD\",\"created\":\"2021-10-22 19:30:17\",\"modified\":\"2021-10-22 19:30:17\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payment_methods") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payment_methods"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"name\":\"Diners Club\",\"type\":\"CREDIT_CARD\",\"created\":\"2021-10-22 19:30:17\",\"modified\":\"2021-10-22 19:30:17\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/payment_methods \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"706f68c5-46b2-43d8-9aa8-41d1cc2a317f","name":"Diners Club","type":"CREDIT_CARD","created":"2021-10-22 19:30:17","modified":"2021-10-22 19:30:17"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payment_methods", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"name\":\"Diners Club\",\"type\":\"CREDIT_CARD\",\"created\":\"2021-10-22 19:30:17\",\"modified\":\"2021-10-22 19:30:17\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payment_methods") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"name\":\"Diners Club\",\"type\":\"CREDIT_CARD\",\"created\":\"2021-10-22 19:30:17\",\"modified\":\"2021-10-22 19:30:17\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"name\":\"Diners Club\",\"type\":\"CREDIT_CARD\",\"created\":\"2021-10-22 19:30:17\",\"modified\":\"2021-10-22 19:30:17\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/payment_methods", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payment_methods\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\\\",\\\"name\\\":\\\"Diners Club\\\",\\\"type\\\":\\\"CREDIT_CARD\\\",\\\"created\\\":\\\"2021-10-22 19:30:17\\\",\\\"modified\\\":\\\"2021-10-22 19:30:17\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payment_methods", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"name\":\"Diners Club\",\"type\":\"CREDIT_CARD\",\"created\":\"2021-10-22 19:30:17\",\"modified\":\"2021-10-22 19:30:17\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payment_methods", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '706f68c5-46b2-43d8-9aa8-41d1cc2a317f', name: 'Diners Club', type: 'CREDIT_CARD', created: '2021-10-22 19:30:17', modified: '2021-10-22 19:30:17' })); req.end(); /payment_methods/{id}: parameters: [] get: tags: - PaymentMethod summary: Retrieves a PaymentMethod resource. operationId: PaymentMethod_getResource description: Retrieves a PaymentMethod resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: PaymentMethod resource content: application/json: schema: $ref: '#/components/schemas/PaymentMethodGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/PaymentMethodGetResource200Response' text/xml: schema: $ref: '#/components/schemas/PaymentMethodGetResource200Response' text/csv: schema: $ref: '#/components/schemas/PaymentMethodGetResource200Response' text/html: schema: $ref: '#/components/schemas/PaymentMethodGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payment_methods/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payment_methods/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/payment_methods/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payment_methods/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payment_methods/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/payment_methods/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payment_methods/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payment_methods/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payment_methods/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - PaymentMethod summary: Replaces the PaymentMethod resource. operationId: PaymentMethod_replaceResource description: Replaces the PaymentMethod resource. parameters: - description: Resource identifier name: id in: path 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/PaymentMethodReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/PaymentMethodReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/PaymentMethodReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/PaymentMethodReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/PaymentMethodReplaceResourceRequest4' required: true responses: '200': description: PaymentMethod resource updated content: application/json: schema: $ref: '#/components/schemas/PaymentMethodReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/PaymentMethodReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/PaymentMethodReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/PaymentMethodReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/PaymentMethodReplaceResource200Response' links: GetPaymentMethodItem: operationId: getPaymentMethodItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /payment_methods/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"name\":\"Diners Club\",\"type\":\"CREDIT_CARD\",\"created\":\"2021-10-22 19:30:17\",\"modified\":\"2021-10-22 19:30:17\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payment_methods/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payment_methods/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"name\":\"Diners Club\",\"type\":\"CREDIT_CARD\",\"created\":\"2021-10-22 19:30:17\",\"modified\":\"2021-10-22 19:30:17\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/payment_methods/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"706f68c5-46b2-43d8-9aa8-41d1cc2a317f","name":"Diners Club","type":"CREDIT_CARD","created":"2021-10-22 19:30:17","modified":"2021-10-22 19:30:17"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payment_methods/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"name\":\"Diners Club\",\"type\":\"CREDIT_CARD\",\"created\":\"2021-10-22 19:30:17\",\"modified\":\"2021-10-22 19:30:17\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payment_methods/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"name\":\"Diners Club\",\"type\":\"CREDIT_CARD\",\"created\":\"2021-10-22 19:30:17\",\"modified\":\"2021-10-22 19:30:17\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"name\":\"Diners Club\",\"type\":\"CREDIT_CARD\",\"created\":\"2021-10-22 19:30:17\",\"modified\":\"2021-10-22 19:30:17\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/payment_methods/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payment_methods/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\\\",\\\"name\\\":\\\"Diners Club\\\",\\\"type\\\":\\\"CREDIT_CARD\\\",\\\"created\\\":\\\"2021-10-22 19:30:17\\\",\\\"modified\\\":\\\"2021-10-22 19:30:17\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payment_methods/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"name\":\"Diners Club\",\"type\":\"CREDIT_CARD\",\"created\":\"2021-10-22 19:30:17\",\"modified\":\"2021-10-22 19:30:17\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payment_methods/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '706f68c5-46b2-43d8-9aa8-41d1cc2a317f', name: 'Diners Club', type: 'CREDIT_CARD', created: '2021-10-22 19:30:17', modified: '2021-10-22 19:30:17' })); req.end(); delete: tags: - PaymentMethod summary: Removes the PaymentMethod resource. operationId: PaymentMethod_removeResource description: Removes the PaymentMethod resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: PaymentMethod resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payment_methods/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payment_methods/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/payment_methods/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payment_methods/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payment_methods/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/payment_methods/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payment_methods/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payment_methods/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payment_methods/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /payment_services: parameters: [] get: tags: - PaymentService summary: Retrieves the collection of PaymentService resources. operationId: PaymentService_getCollection description: Retrieves the collection of PaymentService resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: PaymentService collection content: application/json: schema: $ref: '#/components/schemas/PaymentServiceGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/PaymentServiceGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/PaymentServiceGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/PaymentServiceGetCollection200Response' text/html: schema: $ref: '#/components/schemas/PaymentServiceGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payment_services?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payment_services?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/payment_services?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payment_services?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payment_services?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/payment_services?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payment_services?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payment_services?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payment_services?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /payment_services/{id}: parameters: [] get: tags: - PaymentService summary: Retrieves a PaymentService resource. operationId: PaymentService_getResource description: Retrieves a PaymentService resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: PaymentService resource content: application/json: schema: $ref: '#/components/schemas/PaymentServiceGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/PaymentServiceGetResource200Response' text/xml: schema: $ref: '#/components/schemas/PaymentServiceGetResource200Response' text/csv: schema: $ref: '#/components/schemas/PaymentServiceGetResource200Response' text/html: schema: $ref: '#/components/schemas/PaymentServiceGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payment_services/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payment_services/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/payment_services/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payment_services/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payment_services/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/payment_services/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payment_services/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payment_services/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payment_services/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /payments: parameters: [] get: tags: - Payment summary: Retrieves the collection of Payment resources. operationId: Payment_getCollection description: Retrieves the collection of Payment resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Payment collection content: application/json: schema: $ref: '#/components/schemas/PaymentGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/PaymentGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/PaymentGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/PaymentGetCollection200Response' text/html: schema: $ref: '#/components/schemas/PaymentGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - Payment summary: Creates a Payment resource. operationId: Payment_createResource description: Creates a Payment resource. parameters: [] requestBody: description: The new Payment resource content: application/json: schema: $ref: '#/components/schemas/PaymentCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/PaymentCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/PaymentCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/PaymentCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/PaymentCreateResourceRequest4' required: true responses: '201': description: Payment resource created content: application/json: schema: $ref: '#/components/schemas/PaymentCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/PaymentCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/PaymentCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/PaymentCreateResource201Response' text/html: schema: $ref: '#/components/schemas/PaymentCreateResource201Response' links: GetPaymentItem: operationId: getPaymentItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /payments/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"paymentDate\":\"2020-10-22T19:30:17.697Z\",\"totalAmount\":\"8750\",\"status\":\"PAID\",\"modified\":\"2020-10-09T14:52:50.550Z\",\"accountId\":\"562555f2-8cde-4ce9-8203-0363922537a4\",\"customerId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"customerName\":\"Gateway Motors\",\"linkedTxnId\":\"361a4980-7f53-4b68-820c-f6487f613284\",\"linkedTxnType\":\"Deposit\",\"created\":\"2021-10-22T19:30:17.697Z\",\"invoiceId\":\"129\",\"currencyCode\":\"USD\",\"paymentType\":\"PayPal\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payments") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payments"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"paymentDate\":\"2020-10-22T19:30:17.697Z\",\"totalAmount\":\"8750\",\"status\":\"PAID\",\"modified\":\"2020-10-09T14:52:50.550Z\",\"accountId\":\"562555f2-8cde-4ce9-8203-0363922537a4\",\"customerId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"customerName\":\"Gateway Motors\",\"linkedTxnId\":\"361a4980-7f53-4b68-820c-f6487f613284\",\"linkedTxnType\":\"Deposit\",\"created\":\"2021-10-22T19:30:17.697Z\",\"invoiceId\":\"129\",\"currencyCode\":\"USD\",\"paymentType\":\"PayPal\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/payments \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"706f68c5-46b2-43d8-9aa8-41d1cc2a317f","paymentDate":"2020-10-22T19:30:17.697Z","totalAmount":"8750","status":"PAID","modified":"2020-10-09T14:52:50.550Z","accountId":"562555f2-8cde-4ce9-8203-0363922537a4","customerId":"1d80716b-427e-4cad-80c6-c4b3a18eb23d","customerName":"Gateway Motors","linkedTxnId":"361a4980-7f53-4b68-820c-f6487f613284","linkedTxnType":"Deposit","created":"2021-10-22T19:30:17.697Z","invoiceId":"129","currencyCode":"USD","paymentType":"PayPal"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payments", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"paymentDate\":\"2020-10-22T19:30:17.697Z\",\"totalAmount\":\"8750\",\"status\":\"PAID\",\"modified\":\"2020-10-09T14:52:50.550Z\",\"accountId\":\"562555f2-8cde-4ce9-8203-0363922537a4\",\"customerId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"customerName\":\"Gateway Motors\",\"linkedTxnId\":\"361a4980-7f53-4b68-820c-f6487f613284\",\"linkedTxnType\":\"Deposit\",\"created\":\"2021-10-22T19:30:17.697Z\",\"invoiceId\":\"129\",\"currencyCode\":\"USD\",\"paymentType\":\"PayPal\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payments") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"paymentDate\":\"2020-10-22T19:30:17.697Z\",\"totalAmount\":\"8750\",\"status\":\"PAID\",\"modified\":\"2020-10-09T14:52:50.550Z\",\"accountId\":\"562555f2-8cde-4ce9-8203-0363922537a4\",\"customerId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"customerName\":\"Gateway Motors\",\"linkedTxnId\":\"361a4980-7f53-4b68-820c-f6487f613284\",\"linkedTxnType\":\"Deposit\",\"created\":\"2021-10-22T19:30:17.697Z\",\"invoiceId\":\"129\",\"currencyCode\":\"USD\",\"paymentType\":\"PayPal\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"paymentDate\":\"2020-10-22T19:30:17.697Z\",\"totalAmount\":\"8750\",\"status\":\"PAID\",\"modified\":\"2020-10-09T14:52:50.550Z\",\"accountId\":\"562555f2-8cde-4ce9-8203-0363922537a4\",\"customerId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"customerName\":\"Gateway Motors\",\"linkedTxnId\":\"361a4980-7f53-4b68-820c-f6487f613284\",\"linkedTxnType\":\"Deposit\",\"created\":\"2021-10-22T19:30:17.697Z\",\"invoiceId\":\"129\",\"currencyCode\":\"USD\",\"paymentType\":\"PayPal\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/payments", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payments\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\\\",\\\"paymentDate\\\":\\\"2020-10-22T19:30:17.697Z\\\",\\\"totalAmount\\\":\\\"8750\\\",\\\"status\\\":\\\"PAID\\\",\\\"modified\\\":\\\"2020-10-09T14:52:50.550Z\\\",\\\"accountId\\\":\\\"562555f2-8cde-4ce9-8203-0363922537a4\\\",\\\"customerId\\\":\\\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\\\",\\\"customerName\\\":\\\"Gateway Motors\\\",\\\"linkedTxnId\\\":\\\"361a4980-7f53-4b68-820c-f6487f613284\\\",\\\"linkedTxnType\\\":\\\"Deposit\\\",\\\"created\\\":\\\"2021-10-22T19:30:17.697Z\\\",\\\"invoiceId\\\":\\\"129\\\",\\\"currencyCode\\\":\\\"USD\\\",\\\"paymentType\\\":\\\"PayPal\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payments", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"paymentDate\":\"2020-10-22T19:30:17.697Z\",\"totalAmount\":\"8750\",\"status\":\"PAID\",\"modified\":\"2020-10-09T14:52:50.550Z\",\"accountId\":\"562555f2-8cde-4ce9-8203-0363922537a4\",\"customerId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"customerName\":\"Gateway Motors\",\"linkedTxnId\":\"361a4980-7f53-4b68-820c-f6487f613284\",\"linkedTxnType\":\"Deposit\",\"created\":\"2021-10-22T19:30:17.697Z\",\"invoiceId\":\"129\",\"currencyCode\":\"USD\",\"paymentType\":\"PayPal\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payments", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '706f68c5-46b2-43d8-9aa8-41d1cc2a317f', paymentDate: '2020-10-22T19:30:17.697Z', totalAmount: '8750', status: 'PAID', modified: '2020-10-09T14:52:50.550Z', accountId: '562555f2-8cde-4ce9-8203-0363922537a4', customerId: '1d80716b-427e-4cad-80c6-c4b3a18eb23d', customerName: 'Gateway Motors', linkedTxnId: '361a4980-7f53-4b68-820c-f6487f613284', linkedTxnType: 'Deposit', created: '2021-10-22T19:30:17.697Z', invoiceId: '129', currencyCode: 'USD', paymentType: 'PayPal' })); req.end(); /payments/{id}: parameters: [] get: tags: - Payment summary: Retrieves a Payment resource. operationId: Payment_getResource description: Retrieves a Payment resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Payment resource content: application/json: schema: $ref: '#/components/schemas/PaymentGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/PaymentGetResource200Response' text/xml: schema: $ref: '#/components/schemas/PaymentGetResource200Response' text/csv: schema: $ref: '#/components/schemas/PaymentGetResource200Response' text/html: schema: $ref: '#/components/schemas/PaymentGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payments/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payments/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/payments/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payments/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payments/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/payments/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payments/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payments/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payments/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - Payment summary: Replaces the Payment resource. operationId: Payment_replaceResource description: Replaces the Payment resource. parameters: - description: Resource identifier name: id in: path 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/PaymentReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/PaymentReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/PaymentReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/PaymentReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/PaymentReplaceResourceRequest4' required: true responses: '200': description: Payment resource updated content: application/json: schema: $ref: '#/components/schemas/PaymentReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/PaymentReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/PaymentReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/PaymentReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/PaymentReplaceResource200Response' links: GetPaymentItem: operationId: getPaymentItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /payments/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"paymentDate\":\"2020-10-22T19:30:17.697Z\",\"totalAmount\":\"8750\",\"status\":\"PAID\",\"modified\":\"2020-10-09T14:52:50.550Z\",\"accountId\":\"562555f2-8cde-4ce9-8203-0363922537a4\",\"customerId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"customerName\":\"Gateway Motors\",\"linkedTxnId\":\"361a4980-7f53-4b68-820c-f6487f613284\",\"linkedTxnType\":\"Deposit\",\"created\":\"2021-10-22T19:30:17.697Z\",\"invoiceId\":\"129\",\"currencyCode\":\"USD\",\"paymentType\":\"PayPal\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payments/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payments/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"paymentDate\":\"2020-10-22T19:30:17.697Z\",\"totalAmount\":\"8750\",\"status\":\"PAID\",\"modified\":\"2020-10-09T14:52:50.550Z\",\"accountId\":\"562555f2-8cde-4ce9-8203-0363922537a4\",\"customerId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"customerName\":\"Gateway Motors\",\"linkedTxnId\":\"361a4980-7f53-4b68-820c-f6487f613284\",\"linkedTxnType\":\"Deposit\",\"created\":\"2021-10-22T19:30:17.697Z\",\"invoiceId\":\"129\",\"currencyCode\":\"USD\",\"paymentType\":\"PayPal\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/payments/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"706f68c5-46b2-43d8-9aa8-41d1cc2a317f","paymentDate":"2020-10-22T19:30:17.697Z","totalAmount":"8750","status":"PAID","modified":"2020-10-09T14:52:50.550Z","accountId":"562555f2-8cde-4ce9-8203-0363922537a4","customerId":"1d80716b-427e-4cad-80c6-c4b3a18eb23d","customerName":"Gateway Motors","linkedTxnId":"361a4980-7f53-4b68-820c-f6487f613284","linkedTxnType":"Deposit","created":"2021-10-22T19:30:17.697Z","invoiceId":"129","currencyCode":"USD","paymentType":"PayPal"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payments/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"paymentDate\":\"2020-10-22T19:30:17.697Z\",\"totalAmount\":\"8750\",\"status\":\"PAID\",\"modified\":\"2020-10-09T14:52:50.550Z\",\"accountId\":\"562555f2-8cde-4ce9-8203-0363922537a4\",\"customerId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"customerName\":\"Gateway Motors\",\"linkedTxnId\":\"361a4980-7f53-4b68-820c-f6487f613284\",\"linkedTxnType\":\"Deposit\",\"created\":\"2021-10-22T19:30:17.697Z\",\"invoiceId\":\"129\",\"currencyCode\":\"USD\",\"paymentType\":\"PayPal\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payments/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"paymentDate\":\"2020-10-22T19:30:17.697Z\",\"totalAmount\":\"8750\",\"status\":\"PAID\",\"modified\":\"2020-10-09T14:52:50.550Z\",\"accountId\":\"562555f2-8cde-4ce9-8203-0363922537a4\",\"customerId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"customerName\":\"Gateway Motors\",\"linkedTxnId\":\"361a4980-7f53-4b68-820c-f6487f613284\",\"linkedTxnType\":\"Deposit\",\"created\":\"2021-10-22T19:30:17.697Z\",\"invoiceId\":\"129\",\"currencyCode\":\"USD\",\"paymentType\":\"PayPal\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"paymentDate\":\"2020-10-22T19:30:17.697Z\",\"totalAmount\":\"8750\",\"status\":\"PAID\",\"modified\":\"2020-10-09T14:52:50.550Z\",\"accountId\":\"562555f2-8cde-4ce9-8203-0363922537a4\",\"customerId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"customerName\":\"Gateway Motors\",\"linkedTxnId\":\"361a4980-7f53-4b68-820c-f6487f613284\",\"linkedTxnType\":\"Deposit\",\"created\":\"2021-10-22T19:30:17.697Z\",\"invoiceId\":\"129\",\"currencyCode\":\"USD\",\"paymentType\":\"PayPal\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/payments/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payments/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\\\",\\\"paymentDate\\\":\\\"2020-10-22T19:30:17.697Z\\\",\\\"totalAmount\\\":\\\"8750\\\",\\\"status\\\":\\\"PAID\\\",\\\"modified\\\":\\\"2020-10-09T14:52:50.550Z\\\",\\\"accountId\\\":\\\"562555f2-8cde-4ce9-8203-0363922537a4\\\",\\\"customerId\\\":\\\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\\\",\\\"customerName\\\":\\\"Gateway Motors\\\",\\\"linkedTxnId\\\":\\\"361a4980-7f53-4b68-820c-f6487f613284\\\",\\\"linkedTxnType\\\":\\\"Deposit\\\",\\\"created\\\":\\\"2021-10-22T19:30:17.697Z\\\",\\\"invoiceId\\\":\\\"129\\\",\\\"currencyCode\\\":\\\"USD\\\",\\\"paymentType\\\":\\\"PayPal\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payments/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"706f68c5-46b2-43d8-9aa8-41d1cc2a317f\",\"paymentDate\":\"2020-10-22T19:30:17.697Z\",\"totalAmount\":\"8750\",\"status\":\"PAID\",\"modified\":\"2020-10-09T14:52:50.550Z\",\"accountId\":\"562555f2-8cde-4ce9-8203-0363922537a4\",\"customerId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"customerName\":\"Gateway Motors\",\"linkedTxnId\":\"361a4980-7f53-4b68-820c-f6487f613284\",\"linkedTxnType\":\"Deposit\",\"created\":\"2021-10-22T19:30:17.697Z\",\"invoiceId\":\"129\",\"currencyCode\":\"USD\",\"paymentType\":\"PayPal\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payments/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '706f68c5-46b2-43d8-9aa8-41d1cc2a317f', paymentDate: '2020-10-22T19:30:17.697Z', totalAmount: '8750', status: 'PAID', modified: '2020-10-09T14:52:50.550Z', accountId: '562555f2-8cde-4ce9-8203-0363922537a4', customerId: '1d80716b-427e-4cad-80c6-c4b3a18eb23d', customerName: 'Gateway Motors', linkedTxnId: '361a4980-7f53-4b68-820c-f6487f613284', linkedTxnType: 'Deposit', created: '2021-10-22T19:30:17.697Z', invoiceId: '129', currencyCode: 'USD', paymentType: 'PayPal' })); req.end(); delete: tags: - Payment summary: Removes the Payment resource. operationId: Payment_removeResource description: Removes the Payment resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: Payment resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payments/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payments/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/payments/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payments/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payments/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/payments/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payments/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payments/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payments/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /payouts: parameters: [] get: tags: - Payout summary: Retrieves the collection of Payout resources. operationId: Payout_getCollection description: Retrieves the collection of Payout resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Payout collection content: application/json: schema: $ref: '#/components/schemas/PayoutGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/PayoutGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/PayoutGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/PayoutGetCollection200Response' text/html: schema: $ref: '#/components/schemas/PayoutGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payouts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payouts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/payouts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payouts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payouts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/payouts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payouts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payouts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payouts?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - Payout summary: Creates a Payout resource. operationId: Payout_createResource description: Creates a Payout resource. parameters: [] requestBody: description: The new Payout resource content: application/json: schema: $ref: '#/components/schemas/PayoutCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/PayoutCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/PayoutCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/PayoutCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/PayoutCreateResourceRequest4' required: true responses: '201': description: Payout resource created content: application/json: schema: $ref: '#/components/schemas/PayoutCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/PayoutCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/PayoutCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/PayoutCreateResource201Response' text/html: schema: $ref: '#/components/schemas/PayoutCreateResource201Response' links: GetPayoutItem: operationId: getPayoutItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /payouts/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"amount\":74753,\"arrivalDate\":\"2020-11-03T02:17:40.080Z\",\"automatic\":\"true\",\"balanceTransactionId\":\"7464\",\"created\":\"2020-11-03\",\"currency\":\"USD\",\"payoutDescription\":\"Payout description\",\"destinationId\":\"44\",\"failureBalanceTransactionId\":\"py_1L9D8G2eZgTElo2CaKQjce77\",\"failureCode\":\"error 43\",\"failureMessage\":\"payment failed\",\"method\":\"Standard\",\"sourceType\":\"card\",\"status\":\"pending\",\"payoutType\":\"card\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payouts") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payouts"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"amount\":74753,\"arrivalDate\":\"2020-11-03T02:17:40.080Z\",\"automatic\":\"true\",\"balanceTransactionId\":\"7464\",\"created\":\"2020-11-03\",\"currency\":\"USD\",\"payoutDescription\":\"Payout description\",\"destinationId\":\"44\",\"failureBalanceTransactionId\":\"py_1L9D8G2eZgTElo2CaKQjce77\",\"failureCode\":\"error 43\",\"failureMessage\":\"payment failed\",\"method\":\"Standard\",\"sourceType\":\"card\",\"status\":\"pending\",\"payoutType\":\"card\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/payouts \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"GH2JK-67283H-YW82KHX-2883KK-KS78S","amount":74753,"arrivalDate":"2020-11-03T02:17:40.080Z","automatic":"true","balanceTransactionId":"7464","created":"2020-11-03","currency":"USD","payoutDescription":"Payout description","destinationId":"44","failureBalanceTransactionId":"py_1L9D8G2eZgTElo2CaKQjce77","failureCode":"error 43","failureMessage":"payment failed","method":"Standard","sourceType":"card","status":"pending","payoutType":"card"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payouts", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"amount\":74753,\"arrivalDate\":\"2020-11-03T02:17:40.080Z\",\"automatic\":\"true\",\"balanceTransactionId\":\"7464\",\"created\":\"2020-11-03\",\"currency\":\"USD\",\"payoutDescription\":\"Payout description\",\"destinationId\":\"44\",\"failureBalanceTransactionId\":\"py_1L9D8G2eZgTElo2CaKQjce77\",\"failureCode\":\"error 43\",\"failureMessage\":\"payment failed\",\"method\":\"Standard\",\"sourceType\":\"card\",\"status\":\"pending\",\"payoutType\":\"card\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payouts") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"amount\":74753,\"arrivalDate\":\"2020-11-03T02:17:40.080Z\",\"automatic\":\"true\",\"balanceTransactionId\":\"7464\",\"created\":\"2020-11-03\",\"currency\":\"USD\",\"payoutDescription\":\"Payout description\",\"destinationId\":\"44\",\"failureBalanceTransactionId\":\"py_1L9D8G2eZgTElo2CaKQjce77\",\"failureCode\":\"error 43\",\"failureMessage\":\"payment failed\",\"method\":\"Standard\",\"sourceType\":\"card\",\"status\":\"pending\",\"payoutType\":\"card\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"amount\":74753,\"arrivalDate\":\"2020-11-03T02:17:40.080Z\",\"automatic\":\"true\",\"balanceTransactionId\":\"7464\",\"created\":\"2020-11-03\",\"currency\":\"USD\",\"payoutDescription\":\"Payout description\",\"destinationId\":\"44\",\"failureBalanceTransactionId\":\"py_1L9D8G2eZgTElo2CaKQjce77\",\"failureCode\":\"error 43\",\"failureMessage\":\"payment failed\",\"method\":\"Standard\",\"sourceType\":\"card\",\"status\":\"pending\",\"payoutType\":\"card\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/payouts", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payouts\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"GH2JK-67283H-YW82KHX-2883KK-KS78S\\\",\\\"amount\\\":74753,\\\"arrivalDate\\\":\\\"2020-11-03T02:17:40.080Z\\\",\\\"automatic\\\":\\\"true\\\",\\\"balanceTransactionId\\\":\\\"7464\\\",\\\"created\\\":\\\"2020-11-03\\\",\\\"currency\\\":\\\"USD\\\",\\\"payoutDescription\\\":\\\"Payout description\\\",\\\"destinationId\\\":\\\"44\\\",\\\"failureBalanceTransactionId\\\":\\\"py_1L9D8G2eZgTElo2CaKQjce77\\\",\\\"failureCode\\\":\\\"error 43\\\",\\\"failureMessage\\\":\\\"payment failed\\\",\\\"method\\\":\\\"Standard\\\",\\\"sourceType\\\":\\\"card\\\",\\\"status\\\":\\\"pending\\\",\\\"payoutType\\\":\\\"card\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payouts", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"amount\":74753,\"arrivalDate\":\"2020-11-03T02:17:40.080Z\",\"automatic\":\"true\",\"balanceTransactionId\":\"7464\",\"created\":\"2020-11-03\",\"currency\":\"USD\",\"payoutDescription\":\"Payout description\",\"destinationId\":\"44\",\"failureBalanceTransactionId\":\"py_1L9D8G2eZgTElo2CaKQjce77\",\"failureCode\":\"error 43\",\"failureMessage\":\"payment failed\",\"method\":\"Standard\",\"sourceType\":\"card\",\"status\":\"pending\",\"payoutType\":\"card\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payouts", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: 'GH2JK-67283H-YW82KHX-2883KK-KS78S', amount: 74753, arrivalDate: '2020-11-03T02:17:40.080Z', automatic: 'true', balanceTransactionId: '7464', created: '2020-11-03', currency: 'USD', payoutDescription: 'Payout description', destinationId: '44', failureBalanceTransactionId: 'py_1L9D8G2eZgTElo2CaKQjce77', failureCode: 'error 43', failureMessage: 'payment failed', method: 'Standard', sourceType: 'card', status: 'pending', payoutType: 'card' })); req.end(); /payouts/{id}: parameters: [] get: tags: - Payout summary: Retrieves a Payout resource. operationId: Payout_getResource description: Retrieves a Payout resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Payout resource content: application/json: schema: $ref: '#/components/schemas/PayoutGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/PayoutGetResource200Response' text/xml: schema: $ref: '#/components/schemas/PayoutGetResource200Response' text/csv: schema: $ref: '#/components/schemas/PayoutGetResource200Response' text/html: schema: $ref: '#/components/schemas/PayoutGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payouts/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payouts/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/payouts/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payouts/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payouts/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/payouts/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payouts/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payouts/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payouts/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - Payout summary: Replaces the Payout resource. operationId: Payout_replaceResource description: Replaces the Payout resource. parameters: - description: Resource identifier name: id in: path 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/PayoutReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/PayoutReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/PayoutReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/PayoutReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/PayoutReplaceResourceRequest4' required: true responses: '200': description: Payout resource updated content: application/json: schema: $ref: '#/components/schemas/PayoutReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/PayoutReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/PayoutReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/PayoutReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/PayoutReplaceResource200Response' links: GetPayoutItem: operationId: getPayoutItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /payouts/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"amount\":74753,\"arrivalDate\":\"2020-11-03T02:17:40.080Z\",\"automatic\":\"true\",\"balanceTransactionId\":\"7464\",\"created\":\"2020-11-03\",\"currency\":\"USD\",\"payoutDescription\":\"Payout description\",\"destinationId\":\"44\",\"failureBalanceTransactionId\":\"py_1L9D8G2eZgTElo2CaKQjce77\",\"failureCode\":\"error 43\",\"failureMessage\":\"payment failed\",\"method\":\"Standard\",\"sourceType\":\"card\",\"status\":\"pending\",\"payoutType\":\"card\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payouts/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payouts/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"amount\":74753,\"arrivalDate\":\"2020-11-03T02:17:40.080Z\",\"automatic\":\"true\",\"balanceTransactionId\":\"7464\",\"created\":\"2020-11-03\",\"currency\":\"USD\",\"payoutDescription\":\"Payout description\",\"destinationId\":\"44\",\"failureBalanceTransactionId\":\"py_1L9D8G2eZgTElo2CaKQjce77\",\"failureCode\":\"error 43\",\"failureMessage\":\"payment failed\",\"method\":\"Standard\",\"sourceType\":\"card\",\"status\":\"pending\",\"payoutType\":\"card\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/payouts/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"GH2JK-67283H-YW82KHX-2883KK-KS78S","amount":74753,"arrivalDate":"2020-11-03T02:17:40.080Z","automatic":"true","balanceTransactionId":"7464","created":"2020-11-03","currency":"USD","payoutDescription":"Payout description","destinationId":"44","failureBalanceTransactionId":"py_1L9D8G2eZgTElo2CaKQjce77","failureCode":"error 43","failureMessage":"payment failed","method":"Standard","sourceType":"card","status":"pending","payoutType":"card"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payouts/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"amount\":74753,\"arrivalDate\":\"2020-11-03T02:17:40.080Z\",\"automatic\":\"true\",\"balanceTransactionId\":\"7464\",\"created\":\"2020-11-03\",\"currency\":\"USD\",\"payoutDescription\":\"Payout description\",\"destinationId\":\"44\",\"failureBalanceTransactionId\":\"py_1L9D8G2eZgTElo2CaKQjce77\",\"failureCode\":\"error 43\",\"failureMessage\":\"payment failed\",\"method\":\"Standard\",\"sourceType\":\"card\",\"status\":\"pending\",\"payoutType\":\"card\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payouts/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"amount\":74753,\"arrivalDate\":\"2020-11-03T02:17:40.080Z\",\"automatic\":\"true\",\"balanceTransactionId\":\"7464\",\"created\":\"2020-11-03\",\"currency\":\"USD\",\"payoutDescription\":\"Payout description\",\"destinationId\":\"44\",\"failureBalanceTransactionId\":\"py_1L9D8G2eZgTElo2CaKQjce77\",\"failureCode\":\"error 43\",\"failureMessage\":\"payment failed\",\"method\":\"Standard\",\"sourceType\":\"card\",\"status\":\"pending\",\"payoutType\":\"card\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"amount\":74753,\"arrivalDate\":\"2020-11-03T02:17:40.080Z\",\"automatic\":\"true\",\"balanceTransactionId\":\"7464\",\"created\":\"2020-11-03\",\"currency\":\"USD\",\"payoutDescription\":\"Payout description\",\"destinationId\":\"44\",\"failureBalanceTransactionId\":\"py_1L9D8G2eZgTElo2CaKQjce77\",\"failureCode\":\"error 43\",\"failureMessage\":\"payment failed\",\"method\":\"Standard\",\"sourceType\":\"card\",\"status\":\"pending\",\"payoutType\":\"card\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/payouts/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payouts/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"GH2JK-67283H-YW82KHX-2883KK-KS78S\\\",\\\"amount\\\":74753,\\\"arrivalDate\\\":\\\"2020-11-03T02:17:40.080Z\\\",\\\"automatic\\\":\\\"true\\\",\\\"balanceTransactionId\\\":\\\"7464\\\",\\\"created\\\":\\\"2020-11-03\\\",\\\"currency\\\":\\\"USD\\\",\\\"payoutDescription\\\":\\\"Payout description\\\",\\\"destinationId\\\":\\\"44\\\",\\\"failureBalanceTransactionId\\\":\\\"py_1L9D8G2eZgTElo2CaKQjce77\\\",\\\"failureCode\\\":\\\"error 43\\\",\\\"failureMessage\\\":\\\"payment failed\\\",\\\"method\\\":\\\"Standard\\\",\\\"sourceType\\\":\\\"card\\\",\\\"status\\\":\\\"pending\\\",\\\"payoutType\\\":\\\"card\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payouts/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"amount\":74753,\"arrivalDate\":\"2020-11-03T02:17:40.080Z\",\"automatic\":\"true\",\"balanceTransactionId\":\"7464\",\"created\":\"2020-11-03\",\"currency\":\"USD\",\"payoutDescription\":\"Payout description\",\"destinationId\":\"44\",\"failureBalanceTransactionId\":\"py_1L9D8G2eZgTElo2CaKQjce77\",\"failureCode\":\"error 43\",\"failureMessage\":\"payment failed\",\"method\":\"Standard\",\"sourceType\":\"card\",\"status\":\"pending\",\"payoutType\":\"card\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payouts/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: 'GH2JK-67283H-YW82KHX-2883KK-KS78S', amount: 74753, arrivalDate: '2020-11-03T02:17:40.080Z', automatic: 'true', balanceTransactionId: '7464', created: '2020-11-03', currency: 'USD', payoutDescription: 'Payout description', destinationId: '44', failureBalanceTransactionId: 'py_1L9D8G2eZgTElo2CaKQjce77', failureCode: 'error 43', failureMessage: 'payment failed', method: 'Standard', sourceType: 'card', status: 'pending', payoutType: 'card' })); req.end(); delete: tags: - Payout summary: Removes the Payout resource. operationId: Payout_removeResource description: Removes the Payout resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: Payout resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payouts/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payouts/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/payouts/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payouts/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payouts/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/payouts/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payouts/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payouts/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payouts/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /payroll: parameters: [] get: tags: - Payroll summary: Retrieves the collection of Payroll resources. operationId: Payroll_getCollection description: Retrieves the collection of Payroll resources. parameters: [] responses: '200': description: Payroll collection content: application/json: schema: $ref: '#/components/schemas/PayrollGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/PayrollGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/PayrollGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/PayrollGetCollection200Response' text/html: schema: $ref: '#/components/schemas/PayrollGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/payroll") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/payroll"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/payroll \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/payroll", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/payroll") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/payroll", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/payroll\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/payroll", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/payroll", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /plans: parameters: [] get: tags: - Plan summary: Retrieves the collection of Plan resources. operationId: Plan_getCollection description: Retrieves the collection of Plan resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Plan collection content: application/json: schema: $ref: '#/components/schemas/PlanGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/PlanGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/PlanGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/PlanGetCollection200Response' text/html: schema: $ref: '#/components/schemas/PlanGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/plans?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/plans?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/plans?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/plans?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/plans?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/plans?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/plans?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/plans?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/plans?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /plans/{id}: parameters: [] get: tags: - Plan summary: Retrieves a Plan resource. operationId: Plan_getResource description: Retrieves a Plan resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Plan resource content: application/json: schema: $ref: '#/components/schemas/PlanGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/PlanGetResource200Response' text/xml: schema: $ref: '#/components/schemas/PlanGetResource200Response' text/csv: schema: $ref: '#/components/schemas/PlanGetResource200Response' text/html: schema: $ref: '#/components/schemas/PlanGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/plans/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/plans/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/plans/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/plans/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/plans/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/plans/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/plans/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/plans/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/plans/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /products: parameters: [] get: tags: - Product summary: Retrieves the collection of Product resources. operationId: Product_getCollection description: Retrieves the collection of Product resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Product collection content: application/json: schema: $ref: '#/components/schemas/ProductGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/ProductGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/ProductGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/ProductGetCollection200Response' text/html: schema: $ref: '#/components/schemas/ProductGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/products?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/products?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/products?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/products?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/products?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/products?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/products?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/products?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/products?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - Product summary: Creates a Product resource. operationId: Product_createResource description: Creates a Product resource. parameters: [] requestBody: description: The new Product resource content: application/json: schema: $ref: '#/components/schemas/ProductCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/ProductCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/ProductCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/ProductCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/ProductCreateResourceRequest4' required: true responses: '201': description: Product resource created content: application/json: schema: $ref: '#/components/schemas/ProductCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/ProductCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/ProductCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/ProductCreateResource201Response' text/html: schema: $ref: '#/components/schemas/ProductCreateResource201Response' links: GetProductItem: operationId: getProductItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /products/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"additionalType\":\"string\",\"alternateName\":\"string\",\"award\":\"string\",\"categories\":[\"string\"],\"color\":\"string\",\"description\":\"string\",\"disambiguatingDescription\":\"string\",\"gtin12\":\"string\",\"gtin13s\":[\"string\"],\"gtin14s\":[\"string\"],\"gtin8s\":[\"string\"],\"image\":\"string\",\"isAccessoryOrSparePartFors\":[\"/entity/1\"],\"isConsumableFors\":[\"/entity/1\"],\"isRelatedTo\":\"/entity/1\",\"isSimilarTos\":[\"/entity/1\"],\"itemCondition\":\"string\",\"model\":\"string\",\"mpns\":[\"string\"],\"manufacturer\":\"string\",\"name\":\"string\",\"productID\":\"string\",\"releaseDate\":\"2019-08-24T14:15:22Z\",\"sameA\":\"string\",\"skus\":[\"string\"],\"url\":\"string\",\"material\":\"string\",\"productionDate\":\"2019-08-24T14:15:22Z\",\"purchaseDate\":\"2019-08-24T14:15:22Z\",\"identifier\":\"string\",\"srcId\":\"string\",\"isActive\":\"string\",\"height\":0,\"width\":0,\"weight\":0,\"quantity\":0,\"availableForPurchase\":true,\"updated\":\"string\",\"price\":0,\"weightUnit\":\"string\",\"heightUnit\":\"string\",\"widthUnit\":\"string\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/products") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/products"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"additionalType\":\"string\",\"alternateName\":\"string\",\"award\":\"string\",\"categories\":[\"string\"],\"color\":\"string\",\"description\":\"string\",\"disambiguatingDescription\":\"string\",\"gtin12\":\"string\",\"gtin13s\":[\"string\"],\"gtin14s\":[\"string\"],\"gtin8s\":[\"string\"],\"image\":\"string\",\"isAccessoryOrSparePartFors\":[\"/entity/1\"],\"isConsumableFors\":[\"/entity/1\"],\"isRelatedTo\":\"/entity/1\",\"isSimilarTos\":[\"/entity/1\"],\"itemCondition\":\"string\",\"model\":\"string\",\"mpns\":[\"string\"],\"manufacturer\":\"string\",\"name\":\"string\",\"productID\":\"string\",\"releaseDate\":\"2019-08-24T14:15:22Z\",\"sameA\":\"string\",\"skus\":[\"string\"],\"url\":\"string\",\"material\":\"string\",\"productionDate\":\"2019-08-24T14:15:22Z\",\"purchaseDate\":\"2019-08-24T14:15:22Z\",\"identifier\":\"string\",\"srcId\":\"string\",\"isActive\":\"string\",\"height\":0,\"width\":0,\"weight\":0,\"quantity\":0,\"availableForPurchase\":true,\"updated\":\"string\",\"price\":0,\"weightUnit\":\"string\",\"heightUnit\":\"string\",\"widthUnit\":\"string\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/products \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","additionalType":"string","alternateName":"string","award":"string","categories":["string"],"color":"string","description":"string","disambiguatingDescription":"string","gtin12":"string","gtin13s":["string"],"gtin14s":["string"],"gtin8s":["string"],"image":"string","isAccessoryOrSparePartFors":["/entity/1"],"isConsumableFors":["/entity/1"],"isRelatedTo":"/entity/1","isSimilarTos":["/entity/1"],"itemCondition":"string","model":"string","mpns":["string"],"manufacturer":"string","name":"string","productID":"string","releaseDate":"2019-08-24T14:15:22Z","sameA":"string","skus":["string"],"url":"string","material":"string","productionDate":"2019-08-24T14:15:22Z","purchaseDate":"2019-08-24T14:15:22Z","identifier":"string","srcId":"string","isActive":"string","height":0,"width":0,"weight":0,"quantity":0,"availableForPurchase":true,"updated":"string","price":0,"weightUnit":"string","heightUnit":"string","widthUnit":"string"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/products", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"additionalType\":\"string\",\"alternateName\":\"string\",\"award\":\"string\",\"categories\":[\"string\"],\"color\":\"string\",\"description\":\"string\",\"disambiguatingDescription\":\"string\",\"gtin12\":\"string\",\"gtin13s\":[\"string\"],\"gtin14s\":[\"string\"],\"gtin8s\":[\"string\"],\"image\":\"string\",\"isAccessoryOrSparePartFors\":[\"/entity/1\"],\"isConsumableFors\":[\"/entity/1\"],\"isRelatedTo\":\"/entity/1\",\"isSimilarTos\":[\"/entity/1\"],\"itemCondition\":\"string\",\"model\":\"string\",\"mpns\":[\"string\"],\"manufacturer\":\"string\",\"name\":\"string\",\"productID\":\"string\",\"releaseDate\":\"2019-08-24T14:15:22Z\",\"sameA\":\"string\",\"skus\":[\"string\"],\"url\":\"string\",\"material\":\"string\",\"productionDate\":\"2019-08-24T14:15:22Z\",\"purchaseDate\":\"2019-08-24T14:15:22Z\",\"identifier\":\"string\",\"srcId\":\"string\",\"isActive\":\"string\",\"height\":0,\"width\":0,\"weight\":0,\"quantity\":0,\"availableForPurchase\":true,\"updated\":\"string\",\"price\":0,\"weightUnit\":\"string\",\"heightUnit\":\"string\",\"widthUnit\":\"string\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/products") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"additionalType\":\"string\",\"alternateName\":\"string\",\"award\":\"string\",\"categories\":[\"string\"],\"color\":\"string\",\"description\":\"string\",\"disambiguatingDescription\":\"string\",\"gtin12\":\"string\",\"gtin13s\":[\"string\"],\"gtin14s\":[\"string\"],\"gtin8s\":[\"string\"],\"image\":\"string\",\"isAccessoryOrSparePartFors\":[\"/entity/1\"],\"isConsumableFors\":[\"/entity/1\"],\"isRelatedTo\":\"/entity/1\",\"isSimilarTos\":[\"/entity/1\"],\"itemCondition\":\"string\",\"model\":\"string\",\"mpns\":[\"string\"],\"manufacturer\":\"string\",\"name\":\"string\",\"productID\":\"string\",\"releaseDate\":\"2019-08-24T14:15:22Z\",\"sameA\":\"string\",\"skus\":[\"string\"],\"url\":\"string\",\"material\":\"string\",\"productionDate\":\"2019-08-24T14:15:22Z\",\"purchaseDate\":\"2019-08-24T14:15:22Z\",\"identifier\":\"string\",\"srcId\":\"string\",\"isActive\":\"string\",\"height\":0,\"width\":0,\"weight\":0,\"quantity\":0,\"availableForPurchase\":true,\"updated\":\"string\",\"price\":0,\"weightUnit\":\"string\",\"heightUnit\":\"string\",\"widthUnit\":\"string\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"additionalType\":\"string\",\"alternateName\":\"string\",\"award\":\"string\",\"categories\":[\"string\"],\"color\":\"string\",\"description\":\"string\",\"disambiguatingDescription\":\"string\",\"gtin12\":\"string\",\"gtin13s\":[\"string\"],\"gtin14s\":[\"string\"],\"gtin8s\":[\"string\"],\"image\":\"string\",\"isAccessoryOrSparePartFors\":[\"/entity/1\"],\"isConsumableFors\":[\"/entity/1\"],\"isRelatedTo\":\"/entity/1\",\"isSimilarTos\":[\"/entity/1\"],\"itemCondition\":\"string\",\"model\":\"string\",\"mpns\":[\"string\"],\"manufacturer\":\"string\",\"name\":\"string\",\"productID\":\"string\",\"releaseDate\":\"2019-08-24T14:15:22Z\",\"sameA\":\"string\",\"skus\":[\"string\"],\"url\":\"string\",\"material\":\"string\",\"productionDate\":\"2019-08-24T14:15:22Z\",\"purchaseDate\":\"2019-08-24T14:15:22Z\",\"identifier\":\"string\",\"srcId\":\"string\",\"isActive\":\"string\",\"height\":0,\"width\":0,\"weight\":0,\"quantity\":0,\"availableForPurchase\":true,\"updated\":\"string\",\"price\":0,\"weightUnit\":\"string\",\"heightUnit\":\"string\",\"widthUnit\":\"string\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/products", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/products\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"additionalType\\\":\\\"string\\\",\\\"alternateName\\\":\\\"string\\\",\\\"award\\\":\\\"string\\\",\\\"categories\\\":[\\\"string\\\"],\\\"color\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"disambiguatingDescription\\\":\\\"string\\\",\\\"gtin12\\\":\\\"string\\\",\\\"gtin13s\\\":[\\\"string\\\"],\\\"gtin14s\\\":[\\\"string\\\"],\\\"gtin8s\\\":[\\\"string\\\"],\\\"image\\\":\\\"string\\\",\\\"isAccessoryOrSparePartFors\\\":[\\\"/entity/1\\\"],\\\"isConsumableFors\\\":[\\\"/entity/1\\\"],\\\"isRelatedTo\\\":\\\"/entity/1\\\",\\\"isSimilarTos\\\":[\\\"/entity/1\\\"],\\\"itemCondition\\\":\\\"string\\\",\\\"model\\\":\\\"string\\\",\\\"mpns\\\":[\\\"string\\\"],\\\"manufacturer\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"productID\\\":\\\"string\\\",\\\"releaseDate\\\":\\\"2019-08-24T14:15:22Z\\\",\\\"sameA\\\":\\\"string\\\",\\\"skus\\\":[\\\"string\\\"],\\\"url\\\":\\\"string\\\",\\\"material\\\":\\\"string\\\",\\\"productionDate\\\":\\\"2019-08-24T14:15:22Z\\\",\\\"purchaseDate\\\":\\\"2019-08-24T14:15:22Z\\\",\\\"identifier\\\":\\\"string\\\",\\\"srcId\\\":\\\"string\\\",\\\"isActive\\\":\\\"string\\\",\\\"height\\\":0,\\\"width\\\":0,\\\"weight\\\":0,\\\"quantity\\\":0,\\\"availableForPurchase\\\":true,\\\"updated\\\":\\\"string\\\",\\\"price\\\":0,\\\"weightUnit\\\":\\\"string\\\",\\\"heightUnit\\\":\\\"string\\\",\\\"widthUnit\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/products", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"additionalType\":\"string\",\"alternateName\":\"string\",\"award\":\"string\",\"categories\":[\"string\"],\"color\":\"string\",\"description\":\"string\",\"disambiguatingDescription\":\"string\",\"gtin12\":\"string\",\"gtin13s\":[\"string\"],\"gtin14s\":[\"string\"],\"gtin8s\":[\"string\"],\"image\":\"string\",\"isAccessoryOrSparePartFors\":[\"/entity/1\"],\"isConsumableFors\":[\"/entity/1\"],\"isRelatedTo\":\"/entity/1\",\"isSimilarTos\":[\"/entity/1\"],\"itemCondition\":\"string\",\"model\":\"string\",\"mpns\":[\"string\"],\"manufacturer\":\"string\",\"name\":\"string\",\"productID\":\"string\",\"releaseDate\":\"2019-08-24T14:15:22Z\",\"sameA\":\"string\",\"skus\":[\"string\"],\"url\":\"string\",\"material\":\"string\",\"productionDate\":\"2019-08-24T14:15:22Z\",\"purchaseDate\":\"2019-08-24T14:15:22Z\",\"identifier\":\"string\",\"srcId\":\"string\",\"isActive\":\"string\",\"height\":0,\"width\":0,\"weight\":0,\"quantity\":0,\"availableForPurchase\":true,\"updated\":\"string\",\"price\":0,\"weightUnit\":\"string\",\"heightUnit\":\"string\",\"widthUnit\":\"string\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/products", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', additionalType: 'string', alternateName: 'string', award: 'string', categories: ['string'], color: 'string', description: 'string', disambiguatingDescription: 'string', gtin12: 'string', gtin13s: ['string'], gtin14s: ['string'], gtin8s: ['string'], image: 'string', isAccessoryOrSparePartFors: ['/entity/1'], isConsumableFors: ['/entity/1'], isRelatedTo: '/entity/1', isSimilarTos: ['/entity/1'], itemCondition: 'string', model: 'string', mpns: ['string'], manufacturer: 'string', name: 'string', productID: 'string', releaseDate: '2019-08-24T14:15:22Z', sameA: 'string', skus: ['string'], url: 'string', material: 'string', productionDate: '2019-08-24T14:15:22Z', purchaseDate: '2019-08-24T14:15:22Z', identifier: 'string', srcId: 'string', isActive: 'string', height: 0, width: 0, weight: 0, quantity: 0, availableForPurchase: true, updated: 'string', price: 0, weightUnit: 'string', heightUnit: 'string', widthUnit: 'string' })); req.end(); /products/{id}: parameters: [] get: tags: - Product summary: Retrieves a Product resource. operationId: Product_getResource description: Retrieves a Product resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Product resource content: application/json: schema: $ref: '#/components/schemas/ProductGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/ProductGetResource200Response' text/xml: schema: $ref: '#/components/schemas/ProductGetResource200Response' text/csv: schema: $ref: '#/components/schemas/ProductGetResource200Response' text/html: schema: $ref: '#/components/schemas/ProductGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/products/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/products/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/products/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/products/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/products/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/products/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/products/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/products/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/products/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - Product summary: Replaces the Product resource. operationId: Product_replaceResource description: Replaces the Product resource. parameters: - description: Resource identifier name: id in: path 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/ProductReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/ProductReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/ProductReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/ProductReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/ProductReplaceResourceRequest4' required: true responses: '200': description: Product resource updated content: application/json: schema: $ref: '#/components/schemas/ProductReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/ProductReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/ProductReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/ProductReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/ProductReplaceResource200Response' links: GetProductItem: operationId: getProductItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /products/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"additionalType\":\"string\",\"alternateName\":\"string\",\"award\":\"string\",\"categories\":[\"string\"],\"color\":\"string\",\"description\":\"string\",\"disambiguatingDescription\":\"string\",\"gtin12\":\"string\",\"gtin13s\":[\"string\"],\"gtin14s\":[\"string\"],\"gtin8s\":[\"string\"],\"image\":\"string\",\"isAccessoryOrSparePartFors\":[\"/entity/1\"],\"isConsumableFors\":[\"/entity/1\"],\"isRelatedTo\":\"/entity/1\",\"isSimilarTos\":[\"/entity/1\"],\"itemCondition\":\"string\",\"model\":\"string\",\"mpns\":[\"string\"],\"manufacturer\":\"string\",\"name\":\"string\",\"productID\":\"string\",\"releaseDate\":\"2019-08-24T14:15:22Z\",\"sameA\":\"string\",\"skus\":[\"string\"],\"url\":\"string\",\"material\":\"string\",\"productionDate\":\"2019-08-24T14:15:22Z\",\"purchaseDate\":\"2019-08-24T14:15:22Z\",\"identifier\":\"string\",\"srcId\":\"string\",\"isActive\":\"string\",\"height\":0,\"width\":0,\"weight\":0,\"quantity\":0,\"availableForPurchase\":true,\"updated\":\"string\",\"price\":0,\"weightUnit\":\"string\",\"heightUnit\":\"string\",\"widthUnit\":\"string\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/products/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/products/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"additionalType\":\"string\",\"alternateName\":\"string\",\"award\":\"string\",\"categories\":[\"string\"],\"color\":\"string\",\"description\":\"string\",\"disambiguatingDescription\":\"string\",\"gtin12\":\"string\",\"gtin13s\":[\"string\"],\"gtin14s\":[\"string\"],\"gtin8s\":[\"string\"],\"image\":\"string\",\"isAccessoryOrSparePartFors\":[\"/entity/1\"],\"isConsumableFors\":[\"/entity/1\"],\"isRelatedTo\":\"/entity/1\",\"isSimilarTos\":[\"/entity/1\"],\"itemCondition\":\"string\",\"model\":\"string\",\"mpns\":[\"string\"],\"manufacturer\":\"string\",\"name\":\"string\",\"productID\":\"string\",\"releaseDate\":\"2019-08-24T14:15:22Z\",\"sameA\":\"string\",\"skus\":[\"string\"],\"url\":\"string\",\"material\":\"string\",\"productionDate\":\"2019-08-24T14:15:22Z\",\"purchaseDate\":\"2019-08-24T14:15:22Z\",\"identifier\":\"string\",\"srcId\":\"string\",\"isActive\":\"string\",\"height\":0,\"width\":0,\"weight\":0,\"quantity\":0,\"availableForPurchase\":true,\"updated\":\"string\",\"price\":0,\"weightUnit\":\"string\",\"heightUnit\":\"string\",\"widthUnit\":\"string\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/products/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","additionalType":"string","alternateName":"string","award":"string","categories":["string"],"color":"string","description":"string","disambiguatingDescription":"string","gtin12":"string","gtin13s":["string"],"gtin14s":["string"],"gtin8s":["string"],"image":"string","isAccessoryOrSparePartFors":["/entity/1"],"isConsumableFors":["/entity/1"],"isRelatedTo":"/entity/1","isSimilarTos":["/entity/1"],"itemCondition":"string","model":"string","mpns":["string"],"manufacturer":"string","name":"string","productID":"string","releaseDate":"2019-08-24T14:15:22Z","sameA":"string","skus":["string"],"url":"string","material":"string","productionDate":"2019-08-24T14:15:22Z","purchaseDate":"2019-08-24T14:15:22Z","identifier":"string","srcId":"string","isActive":"string","height":0,"width":0,"weight":0,"quantity":0,"availableForPurchase":true,"updated":"string","price":0,"weightUnit":"string","heightUnit":"string","widthUnit":"string"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/products/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"additionalType\":\"string\",\"alternateName\":\"string\",\"award\":\"string\",\"categories\":[\"string\"],\"color\":\"string\",\"description\":\"string\",\"disambiguatingDescription\":\"string\",\"gtin12\":\"string\",\"gtin13s\":[\"string\"],\"gtin14s\":[\"string\"],\"gtin8s\":[\"string\"],\"image\":\"string\",\"isAccessoryOrSparePartFors\":[\"/entity/1\"],\"isConsumableFors\":[\"/entity/1\"],\"isRelatedTo\":\"/entity/1\",\"isSimilarTos\":[\"/entity/1\"],\"itemCondition\":\"string\",\"model\":\"string\",\"mpns\":[\"string\"],\"manufacturer\":\"string\",\"name\":\"string\",\"productID\":\"string\",\"releaseDate\":\"2019-08-24T14:15:22Z\",\"sameA\":\"string\",\"skus\":[\"string\"],\"url\":\"string\",\"material\":\"string\",\"productionDate\":\"2019-08-24T14:15:22Z\",\"purchaseDate\":\"2019-08-24T14:15:22Z\",\"identifier\":\"string\",\"srcId\":\"string\",\"isActive\":\"string\",\"height\":0,\"width\":0,\"weight\":0,\"quantity\":0,\"availableForPurchase\":true,\"updated\":\"string\",\"price\":0,\"weightUnit\":\"string\",\"heightUnit\":\"string\",\"widthUnit\":\"string\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/products/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"additionalType\":\"string\",\"alternateName\":\"string\",\"award\":\"string\",\"categories\":[\"string\"],\"color\":\"string\",\"description\":\"string\",\"disambiguatingDescription\":\"string\",\"gtin12\":\"string\",\"gtin13s\":[\"string\"],\"gtin14s\":[\"string\"],\"gtin8s\":[\"string\"],\"image\":\"string\",\"isAccessoryOrSparePartFors\":[\"/entity/1\"],\"isConsumableFors\":[\"/entity/1\"],\"isRelatedTo\":\"/entity/1\",\"isSimilarTos\":[\"/entity/1\"],\"itemCondition\":\"string\",\"model\":\"string\",\"mpns\":[\"string\"],\"manufacturer\":\"string\",\"name\":\"string\",\"productID\":\"string\",\"releaseDate\":\"2019-08-24T14:15:22Z\",\"sameA\":\"string\",\"skus\":[\"string\"],\"url\":\"string\",\"material\":\"string\",\"productionDate\":\"2019-08-24T14:15:22Z\",\"purchaseDate\":\"2019-08-24T14:15:22Z\",\"identifier\":\"string\",\"srcId\":\"string\",\"isActive\":\"string\",\"height\":0,\"width\":0,\"weight\":0,\"quantity\":0,\"availableForPurchase\":true,\"updated\":\"string\",\"price\":0,\"weightUnit\":\"string\",\"heightUnit\":\"string\",\"widthUnit\":\"string\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"additionalType\":\"string\",\"alternateName\":\"string\",\"award\":\"string\",\"categories\":[\"string\"],\"color\":\"string\",\"description\":\"string\",\"disambiguatingDescription\":\"string\",\"gtin12\":\"string\",\"gtin13s\":[\"string\"],\"gtin14s\":[\"string\"],\"gtin8s\":[\"string\"],\"image\":\"string\",\"isAccessoryOrSparePartFors\":[\"/entity/1\"],\"isConsumableFors\":[\"/entity/1\"],\"isRelatedTo\":\"/entity/1\",\"isSimilarTos\":[\"/entity/1\"],\"itemCondition\":\"string\",\"model\":\"string\",\"mpns\":[\"string\"],\"manufacturer\":\"string\",\"name\":\"string\",\"productID\":\"string\",\"releaseDate\":\"2019-08-24T14:15:22Z\",\"sameA\":\"string\",\"skus\":[\"string\"],\"url\":\"string\",\"material\":\"string\",\"productionDate\":\"2019-08-24T14:15:22Z\",\"purchaseDate\":\"2019-08-24T14:15:22Z\",\"identifier\":\"string\",\"srcId\":\"string\",\"isActive\":\"string\",\"height\":0,\"width\":0,\"weight\":0,\"quantity\":0,\"availableForPurchase\":true,\"updated\":\"string\",\"price\":0,\"weightUnit\":\"string\",\"heightUnit\":\"string\",\"widthUnit\":\"string\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/products/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/products/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"additionalType\\\":\\\"string\\\",\\\"alternateName\\\":\\\"string\\\",\\\"award\\\":\\\"string\\\",\\\"categories\\\":[\\\"string\\\"],\\\"color\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"disambiguatingDescription\\\":\\\"string\\\",\\\"gtin12\\\":\\\"string\\\",\\\"gtin13s\\\":[\\\"string\\\"],\\\"gtin14s\\\":[\\\"string\\\"],\\\"gtin8s\\\":[\\\"string\\\"],\\\"image\\\":\\\"string\\\",\\\"isAccessoryOrSparePartFors\\\":[\\\"/entity/1\\\"],\\\"isConsumableFors\\\":[\\\"/entity/1\\\"],\\\"isRelatedTo\\\":\\\"/entity/1\\\",\\\"isSimilarTos\\\":[\\\"/entity/1\\\"],\\\"itemCondition\\\":\\\"string\\\",\\\"model\\\":\\\"string\\\",\\\"mpns\\\":[\\\"string\\\"],\\\"manufacturer\\\":\\\"string\\\",\\\"name\\\":\\\"string\\\",\\\"productID\\\":\\\"string\\\",\\\"releaseDate\\\":\\\"2019-08-24T14:15:22Z\\\",\\\"sameA\\\":\\\"string\\\",\\\"skus\\\":[\\\"string\\\"],\\\"url\\\":\\\"string\\\",\\\"material\\\":\\\"string\\\",\\\"productionDate\\\":\\\"2019-08-24T14:15:22Z\\\",\\\"purchaseDate\\\":\\\"2019-08-24T14:15:22Z\\\",\\\"identifier\\\":\\\"string\\\",\\\"srcId\\\":\\\"string\\\",\\\"isActive\\\":\\\"string\\\",\\\"height\\\":0,\\\"width\\\":0,\\\"weight\\\":0,\\\"quantity\\\":0,\\\"availableForPurchase\\\":true,\\\"updated\\\":\\\"string\\\",\\\"price\\\":0,\\\"weightUnit\\\":\\\"string\\\",\\\"heightUnit\\\":\\\"string\\\",\\\"widthUnit\\\":\\\"string\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/products/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"additionalType\":\"string\",\"alternateName\":\"string\",\"award\":\"string\",\"categories\":[\"string\"],\"color\":\"string\",\"description\":\"string\",\"disambiguatingDescription\":\"string\",\"gtin12\":\"string\",\"gtin13s\":[\"string\"],\"gtin14s\":[\"string\"],\"gtin8s\":[\"string\"],\"image\":\"string\",\"isAccessoryOrSparePartFors\":[\"/entity/1\"],\"isConsumableFors\":[\"/entity/1\"],\"isRelatedTo\":\"/entity/1\",\"isSimilarTos\":[\"/entity/1\"],\"itemCondition\":\"string\",\"model\":\"string\",\"mpns\":[\"string\"],\"manufacturer\":\"string\",\"name\":\"string\",\"productID\":\"string\",\"releaseDate\":\"2019-08-24T14:15:22Z\",\"sameA\":\"string\",\"skus\":[\"string\"],\"url\":\"string\",\"material\":\"string\",\"productionDate\":\"2019-08-24T14:15:22Z\",\"purchaseDate\":\"2019-08-24T14:15:22Z\",\"identifier\":\"string\",\"srcId\":\"string\",\"isActive\":\"string\",\"height\":0,\"width\":0,\"weight\":0,\"quantity\":0,\"availableForPurchase\":true,\"updated\":\"string\",\"price\":0,\"weightUnit\":\"string\",\"heightUnit\":\"string\",\"widthUnit\":\"string\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/products/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', additionalType: 'string', alternateName: 'string', award: 'string', categories: ['string'], color: 'string', description: 'string', disambiguatingDescription: 'string', gtin12: 'string', gtin13s: ['string'], gtin14s: ['string'], gtin8s: ['string'], image: 'string', isAccessoryOrSparePartFors: ['/entity/1'], isConsumableFors: ['/entity/1'], isRelatedTo: '/entity/1', isSimilarTos: ['/entity/1'], itemCondition: 'string', model: 'string', mpns: ['string'], manufacturer: 'string', name: 'string', productID: 'string', releaseDate: '2019-08-24T14:15:22Z', sameA: 'string', skus: ['string'], url: 'string', material: 'string', productionDate: '2019-08-24T14:15:22Z', purchaseDate: '2019-08-24T14:15:22Z', identifier: 'string', srcId: 'string', isActive: 'string', height: 0, width: 0, weight: 0, quantity: 0, availableForPurchase: true, updated: 'string', price: 0, weightUnit: 'string', heightUnit: 'string', widthUnit: 'string' })); req.end(); delete: tags: - Product summary: Removes the Product resource. operationId: Product_removeResource description: Removes the Product resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: Product resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/products/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/products/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/products/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/products/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/products/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/products/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/products/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/products/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/products/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /profit_and_loss: parameters: [] get: tags: - ProfitAndLoss summary: Retrieves a ProfitAndLoss resource. operationId: ProfitAndLoss_getResource description: Retrieves a ProfitAndLoss resource. parameters: - description: YYYY-MM-DD name: start in: query required: true deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-11-01' - description: YYYY-MM-DD name: end in: query required: true deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-11-30' - description: The Accounting Method name: accounting_method in: query required: true deprecated: false allowEmptyValue: false schema: type: string enum: - cash - accrual style: form explode: false allowReserved: false example: accrual responses: '200': description: ProfitAndLoss resource content: application/json: schema: $ref: '#/components/schemas/ProfitAndLossGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/ProfitAndLossGetResource200Response' text/xml: schema: $ref: '#/components/schemas/ProfitAndLossGetResource200Response' text/csv: schema: $ref: '#/components/schemas/ProfitAndLossGetResource200Response' text/html: schema: $ref: '#/components/schemas/ProfitAndLossGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/profit_and_loss?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/profit_and_loss?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/profit_and_loss?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/profit_and_loss?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/profit_and_loss?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/profit_and_loss?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/profit_and_loss?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/profit_and_loss?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/profit_and_loss?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /profit_and_loss_excel: parameters: [] get: tags: - ProfitAndLossExcel summary: Retrieves an excel workbook of a series of profit and loss reports operationId: ProfitAndLossExcel_getWorkbook description: Retrieves an excel workbook of a series of profit and loss reports parameters: - description: YYYY-MM-DD name: start in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-07-01' - description: YYYY-MM-DD name: end in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-08-31' - description: >- If refresh is set, data will be fetched from the source application even when cached data is available name: refresh in: query required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false example: 'true' responses: '200': description: ProfitAndLossExcel resource content: application/json: schema: $ref: '#/components/schemas/ProfitAndLossExcelGetWorkbookResponse' application/xml: schema: $ref: '#/components/schemas/ProfitAndLossExcelGetWorkbook200Response' text/xml: schema: $ref: '#/components/schemas/ProfitAndLossExcelGetWorkbook200Response' text/csv: schema: $ref: '#/components/schemas/ProfitAndLossExcelGetWorkbook200Response' text/html: schema: $ref: '#/components/schemas/ProfitAndLossExcelGetWorkbook200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/profit_and_loss_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/profit_and_loss_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/profit_and_loss_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/profit_and_loss_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/profit_and_loss_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/profit_and_loss_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/profit_and_loss_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/profit_and_loss_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/profit_and_loss_excel?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /profit_and_loss_report: parameters: [] get: tags: - ProfitAndLossReport summary: Retrieves a mapped profit and loss report operationId: ProfitAndLossReport_getMappedReport description: Retrieves a mapped profit and loss report parameters: - description: YYYY-MM-DD name: start in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-01-01' - description: YYYY-MM-DD name: end in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-01-31' - description: >- If refresh is set, data will be fetched from the source application even when cached data is available name: refresh in: query required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false example: 'true' responses: '200': description: ProfitAndLossReport resource content: application/json: schema: $ref: >- #/components/schemas/ProfitAndLossReportGetMappedReportResponse application/xml: schema: $ref: >- #/components/schemas/ProfitAndLossReportGetMappedReport200Response text/xml: schema: $ref: >- #/components/schemas/ProfitAndLossReportGetMappedReport200Response text/csv: schema: $ref: >- #/components/schemas/ProfitAndLossReportGetMappedReport200Response text/html: schema: $ref: >- #/components/schemas/ProfitAndLossReportGetMappedReport200Response '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/profit_and_loss_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/profit_and_loss_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/profit_and_loss_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/profit_and_loss_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/profit_and_loss_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/profit_and_loss_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/profit_and_loss_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/profit_and_loss_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/profit_and_loss_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /projects: parameters: [] get: tags: - Project summary: Retrieves the collection of Project resources. operationId: Project_getCollection description: Retrieves the collection of Project resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Project collection content: application/json: schema: $ref: '#/components/schemas/ProjectGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/ProjectGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/ProjectGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/ProjectGetCollection200Response' text/html: schema: $ref: '#/components/schemas/ProjectGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/projects?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/projects?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/projects?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/projects?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/projects?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/projects?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/projects?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/projects?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/projects?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /projects/{id}: parameters: [] get: tags: - Project summary: Retrieves a Project resource. operationId: Project_getResource description: Retrieves a Project resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Project resource content: application/json: schema: $ref: '#/components/schemas/ProjectGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/ProjectGetResource200Response' text/xml: schema: $ref: '#/components/schemas/ProjectGetResource200Response' text/csv: schema: $ref: '#/components/schemas/ProjectGetResource200Response' text/html: schema: $ref: '#/components/schemas/ProjectGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/projects/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/projects/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/projects/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/projects/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/projects/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/projects/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/projects/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/projects/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/projects/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /proxy_request: parameters: [] get: tags: - ProxyRequest summary: make a GET request to a specific API endpoint operationId: ProxyRequest_getCollection description: Retrieves the collection of ProxyRequest resources. parameters: - description: 'The key of the application you would like to request. ' name: key in: query required: true deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false example: quickbooks - description: 'The url of the application you would like to request. ' name: url in: query 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 responses: '200': description: ProxyRequest collection content: application/json: schema: $ref: '#/components/schemas/ProxyRequestGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/ProxyRequestGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/ProxyRequestGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/ProxyRequestGetCollection200Response' text/html: schema: $ref: '#/components/schemas/ProxyRequestGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - ProxyRequest summary: make a POST request to a specific API endpoint operationId: ProxyRequest_sendRequest description: Creates a ProxyRequest resource. parameters: - description: 'The key of the application you would like to request. ' name: key in: query required: true deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false example: quickbooks - description: 'The url of the application endpoint you would like to request. ' name: url in: query 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/ProxyRequestSendRequestRequest' application/xml: schema: $ref: '#/components/schemas/ProxyRequestSendRequestRequest1' text/xml: schema: $ref: '#/components/schemas/ProxyRequestSendRequestRequest2' text/csv: schema: $ref: '#/components/schemas/ProxyRequestSendRequestRequest3' text/html: schema: $ref: '#/components/schemas/ProxyRequestSendRequestRequest4' required: true responses: '201': description: ProxyRequest resource created content: application/json: schema: $ref: '#/components/schemas/ProxyRequestSendRequestResponse' application/xml: schema: $ref: '#/components/schemas/ProxyRequestSendRequest201Response' text/xml: schema: $ref: '#/components/schemas/ProxyRequestSendRequest201Response' text/csv: schema: $ref: '#/components/schemas/ProxyRequestSendRequest201Response' text/html: schema: $ref: '#/components/schemas/ProxyRequestSendRequest201Response' links: {} '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url 'https://example.myintranetapps.com/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE\"\n\n\tpayload := strings.NewReader(\"{}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/proxy_request?key=SOME_STRING_VALUE&url=SOME_STRING_VALUE", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({})); req.end(); /publishing_channels: parameters: [] get: tags: - PublishingChannel summary: Retrieves the collection of PublishingChannel resources. operationId: PublishingChannel_listResources description: Retrieves the collection of PublishingChannel resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: PublishingChannel collection content: application/json: schema: $ref: '#/components/schemas/PublishingChannelListResourcesResponse' application/xml: schema: $ref: '#/components/schemas/PublishingChannelListResources200Response' text/xml: schema: $ref: '#/components/schemas/PublishingChannelListResources200Response' text/csv: schema: $ref: '#/components/schemas/PublishingChannelListResources200Response' text/html: schema: $ref: '#/components/schemas/PublishingChannelListResources200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/publishing_channels?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/publishing_channels?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/publishing_channels?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/publishing_channels?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/publishing_channels?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/publishing_channels?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/publishing_channels?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/publishing_channels?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/publishing_channels?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /publishing_channels/{id}: parameters: [] get: tags: - PublishingChannel summary: Retrieves a PublishingChannel resource. operationId: PublishingChannel_getResource description: Retrieves a PublishingChannel resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: PublishingChannel resource content: application/json: schema: $ref: '#/components/schemas/PublishingChannelGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/PublishingChannelGetResource200Response' text/xml: schema: $ref: '#/components/schemas/PublishingChannelGetResource200Response' text/csv: schema: $ref: '#/components/schemas/PublishingChannelGetResource200Response' text/html: schema: $ref: '#/components/schemas/PublishingChannelGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/publishing_channels/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/publishing_channels/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/publishing_channels/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/publishing_channels/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/publishing_channels/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/publishing_channels/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/publishing_channels/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/publishing_channels/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/publishing_channels/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /purchase_credit_notes: parameters: [] get: tags: - PurchaseCreditNote summary: Retrieves the collection of PurchaseCreditNote resources. operationId: PurchaseCreditNote_listRetrieval description: Retrieves the collection of PurchaseCreditNote resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: PurchaseCreditNote collection content: application/json: schema: $ref: '#/components/schemas/PurchaseCreditNoteListRetrievalResponse' application/xml: schema: $ref: >- #/components/schemas/PurchaseCreditNoteListRetrieval200Response text/xml: schema: $ref: >- #/components/schemas/PurchaseCreditNoteListRetrieval200Response text/csv: schema: $ref: >- #/components/schemas/PurchaseCreditNoteListRetrieval200Response text/html: schema: $ref: >- #/components/schemas/PurchaseCreditNoteListRetrieval200Response deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/purchase_credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/purchase_credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/purchase_credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/purchase_credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/purchase_credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/purchase_credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/purchase_credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/purchase_credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/purchase_credit_notes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /purchase_credit_notes/{id}: parameters: [] get: tags: - PurchaseCreditNote summary: Retrieves a PurchaseCreditNote resource. operationId: PurchaseCreditNote_getResource description: Retrieves a PurchaseCreditNote resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: PurchaseCreditNote resource content: application/json: schema: $ref: '#/components/schemas/PurchaseCreditNoteGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/PurchaseCreditNoteGetResource200Response' text/xml: schema: $ref: '#/components/schemas/PurchaseCreditNoteGetResource200Response' text/csv: schema: $ref: '#/components/schemas/PurchaseCreditNoteGetResource200Response' text/html: schema: $ref: '#/components/schemas/PurchaseCreditNoteGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/purchase_credit_notes/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/purchase_credit_notes/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/purchase_credit_notes/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/purchase_credit_notes/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/purchase_credit_notes/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/purchase_credit_notes/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/purchase_credit_notes/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/purchase_credit_notes/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/purchase_credit_notes/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /purchase_orders: parameters: [] get: tags: - PurchaseOrder summary: Retrieves the collection of PurchaseOrder resources. operationId: PurchaseOrder_getCollection description: Retrieves the collection of PurchaseOrder resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: PurchaseOrder collection content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/PurchaseOrderGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/PurchaseOrderGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/PurchaseOrderGetCollection200Response' text/html: schema: $ref: '#/components/schemas/PurchaseOrderGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/purchase_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/purchase_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/purchase_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/purchase_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/purchase_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/purchase_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/purchase_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/purchase_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/purchase_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /purchase_orders/{id}: parameters: [] get: tags: - PurchaseOrder summary: Retrieves a PurchaseOrder resource. operationId: PurchaseOrder_getResource description: Retrieves a PurchaseOrder resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: PurchaseOrder resource content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/PurchaseOrderGetResource200Response' text/xml: schema: $ref: '#/components/schemas/PurchaseOrderGetResource200Response' text/csv: schema: $ref: '#/components/schemas/PurchaseOrderGetResource200Response' text/html: schema: $ref: '#/components/schemas/PurchaseOrderGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/purchase_orders/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/purchase_orders/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/purchase_orders/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/purchase_orders/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/purchase_orders/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/purchase_orders/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/purchase_orders/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/purchase_orders/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/purchase_orders/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /purchases: parameters: [] get: tags: - Purchase summary: Retrieves the collection of Purchase resources. operationId: Purchase_getCollection description: Retrieves the collection of Purchase resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Purchase collection content: application/json: schema: $ref: '#/components/schemas/PurchaseGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/PurchaseGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/PurchaseGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/PurchaseGetCollection200Response' text/html: schema: $ref: '#/components/schemas/PurchaseGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/purchases?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/purchases?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/purchases?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/purchases?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/purchases?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/purchases?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/purchases?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/purchases?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/purchases?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /purchases/{id}: parameters: [] get: tags: - Purchase summary: Retrieves a Purchase resource. operationId: Purchase_getResource description: Retrieves a Purchase resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Purchase resource content: application/json: schema: $ref: '#/components/schemas/PurchaseGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/PurchaseGetResource200Response' text/xml: schema: $ref: '#/components/schemas/PurchaseGetResource200Response' text/csv: schema: $ref: '#/components/schemas/PurchaseGetResource200Response' text/html: schema: $ref: '#/components/schemas/PurchaseGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/purchases/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/purchases/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/purchases/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/purchases/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/purchases/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/purchases/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/purchases/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/purchases/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/purchases/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /quotes: parameters: [] get: tags: - Quote summary: Retrieves the collection of Quote resources. operationId: Quote_getCollection description: Retrieves the collection of Quote resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Quote collection content: application/json: schema: $ref: '#/components/schemas/QuoteGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/QuoteGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/QuoteGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/QuoteGetCollection200Response' text/html: schema: $ref: '#/components/schemas/QuoteGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/quotes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/quotes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/quotes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/quotes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/quotes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/quotes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/quotes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/quotes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/quotes?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - Quote summary: Creates a Quote resource. operationId: Quote_createResource description: Creates a Quote resource. parameters: [] requestBody: description: The new Quote resource content: application/json: schema: $ref: '#/components/schemas/QuoteCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/QuoteCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/QuoteCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/QuoteCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/QuoteCreateResourceRequest4' required: true responses: '201': description: Quote resource created content: application/json: schema: $ref: '#/components/schemas/QuoteCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/QuoteCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/QuoteCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/QuoteCreateResource201Response' text/html: schema: $ref: '#/components/schemas/QuoteCreateResource201Response' links: GetQuoteItem: operationId: getQuoteItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /quotes/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\",\"customerId\":\"0124\",\"customerName\":\"John Doe\",\"quoteNumber\":\"99\",\"txnDate\":\"2021-07-28 00:00:00\",\"billingCity\":\"Toronto\",\"billingPostalcode\":\"H6F0R3\",\"billingCountry\":\"Canada\",\"shippingCity\":\"Vancouver\",\"shippingCountry\":\"Canada\",\"totalAmount\":5000000,\"currency\":\"CAD\",\"txnStatus\":\"2021-09-15 00:00:00\",\"shippingPostalcode\":\"V5N7G4\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/quotes") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/quotes"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\",\"customerId\":\"0124\",\"customerName\":\"John Doe\",\"quoteNumber\":\"99\",\"txnDate\":\"2021-07-28 00:00:00\",\"billingCity\":\"Toronto\",\"billingPostalcode\":\"H6F0R3\",\"billingCountry\":\"Canada\",\"shippingCity\":\"Vancouver\",\"shippingCountry\":\"Canada\",\"totalAmount\":5000000,\"currency\":\"CAD\",\"txnStatus\":\"2021-09-15 00:00:00\",\"shippingPostalcode\":\"V5N7G4\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/quotes \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"90300000072369","created":"2021-07-28 00:00:00","modified":"2021-09-15 00:00:00","customerId":"0124","customerName":"John Doe","quoteNumber":"99","txnDate":"2021-07-28 00:00:00","billingCity":"Toronto","billingPostalcode":"H6F0R3","billingCountry":"Canada","shippingCity":"Vancouver","shippingCountry":"Canada","totalAmount":5000000,"currency":"CAD","txnStatus":"2021-09-15 00:00:00","shippingPostalcode":"V5N7G4"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/quotes", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\",\"customerId\":\"0124\",\"customerName\":\"John Doe\",\"quoteNumber\":\"99\",\"txnDate\":\"2021-07-28 00:00:00\",\"billingCity\":\"Toronto\",\"billingPostalcode\":\"H6F0R3\",\"billingCountry\":\"Canada\",\"shippingCity\":\"Vancouver\",\"shippingCountry\":\"Canada\",\"totalAmount\":5000000,\"currency\":\"CAD\",\"txnStatus\":\"2021-09-15 00:00:00\",\"shippingPostalcode\":\"V5N7G4\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/quotes") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\",\"customerId\":\"0124\",\"customerName\":\"John Doe\",\"quoteNumber\":\"99\",\"txnDate\":\"2021-07-28 00:00:00\",\"billingCity\":\"Toronto\",\"billingPostalcode\":\"H6F0R3\",\"billingCountry\":\"Canada\",\"shippingCity\":\"Vancouver\",\"shippingCountry\":\"Canada\",\"totalAmount\":5000000,\"currency\":\"CAD\",\"txnStatus\":\"2021-09-15 00:00:00\",\"shippingPostalcode\":\"V5N7G4\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\",\"customerId\":\"0124\",\"customerName\":\"John Doe\",\"quoteNumber\":\"99\",\"txnDate\":\"2021-07-28 00:00:00\",\"billingCity\":\"Toronto\",\"billingPostalcode\":\"H6F0R3\",\"billingCountry\":\"Canada\",\"shippingCity\":\"Vancouver\",\"shippingCountry\":\"Canada\",\"totalAmount\":5000000,\"currency\":\"CAD\",\"txnStatus\":\"2021-09-15 00:00:00\",\"shippingPostalcode\":\"V5N7G4\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/quotes", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/quotes\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"90300000072369\\\",\\\"created\\\":\\\"2021-07-28 00:00:00\\\",\\\"modified\\\":\\\"2021-09-15 00:00:00\\\",\\\"customerId\\\":\\\"0124\\\",\\\"customerName\\\":\\\"John Doe\\\",\\\"quoteNumber\\\":\\\"99\\\",\\\"txnDate\\\":\\\"2021-07-28 00:00:00\\\",\\\"billingCity\\\":\\\"Toronto\\\",\\\"billingPostalcode\\\":\\\"H6F0R3\\\",\\\"billingCountry\\\":\\\"Canada\\\",\\\"shippingCity\\\":\\\"Vancouver\\\",\\\"shippingCountry\\\":\\\"Canada\\\",\\\"totalAmount\\\":5000000,\\\"currency\\\":\\\"CAD\\\",\\\"txnStatus\\\":\\\"2021-09-15 00:00:00\\\",\\\"shippingPostalcode\\\":\\\"V5N7G4\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/quotes", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\",\"customerId\":\"0124\",\"customerName\":\"John Doe\",\"quoteNumber\":\"99\",\"txnDate\":\"2021-07-28 00:00:00\",\"billingCity\":\"Toronto\",\"billingPostalcode\":\"H6F0R3\",\"billingCountry\":\"Canada\",\"shippingCity\":\"Vancouver\",\"shippingCountry\":\"Canada\",\"totalAmount\":5000000,\"currency\":\"CAD\",\"txnStatus\":\"2021-09-15 00:00:00\",\"shippingPostalcode\":\"V5N7G4\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/quotes", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '90300000072369', created: '2021-07-28 00:00:00', modified: '2021-09-15 00:00:00', customerId: '0124', customerName: 'John Doe', quoteNumber: '99', txnDate: '2021-07-28 00:00:00', billingCity: 'Toronto', billingPostalcode: 'H6F0R3', billingCountry: 'Canada', shippingCity: 'Vancouver', shippingCountry: 'Canada', totalAmount: 5000000, currency: 'CAD', txnStatus: '2021-09-15 00:00:00', shippingPostalcode: 'V5N7G4' })); req.end(); /quotes/{id}: parameters: [] get: tags: - Quote summary: Retrieves a Quote resource. operationId: Quote_getQuoteResource description: Retrieves a Quote resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Quote resource content: application/json: schema: $ref: '#/components/schemas/QuoteGetQuoteResourceResponse' application/xml: schema: $ref: '#/components/schemas/QuoteGetQuoteResource200Response' text/xml: schema: $ref: '#/components/schemas/QuoteGetQuoteResource200Response' text/csv: schema: $ref: '#/components/schemas/QuoteGetQuoteResource200Response' text/html: schema: $ref: '#/components/schemas/QuoteGetQuoteResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/quotes/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/quotes/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/quotes/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/quotes/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/quotes/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/quotes/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/quotes/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/quotes/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/quotes/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - Quote summary: Replaces the Quote resource. operationId: Quote_replaceResource description: Replaces the Quote resource. parameters: - description: Resource identifier name: id in: path 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/QuoteReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/QuoteReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/QuoteReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/QuoteReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/QuoteReplaceResourceRequest4' required: true responses: '200': description: Quote resource updated content: application/json: schema: $ref: '#/components/schemas/QuoteReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/QuoteReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/QuoteReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/QuoteReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/QuoteReplaceResource200Response' links: GetQuoteItem: operationId: getQuoteItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /quotes/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\",\"customerId\":\"0124\",\"customerName\":\"John Doe\",\"quoteNumber\":\"99\",\"txnDate\":\"2021-07-28 00:00:00\",\"billingCity\":\"Toronto\",\"billingPostalcode\":\"H6F0R3\",\"billingCountry\":\"Canada\",\"shippingCity\":\"Vancouver\",\"shippingCountry\":\"Canada\",\"totalAmount\":5000000,\"currency\":\"CAD\",\"txnStatus\":\"2021-09-15 00:00:00\",\"shippingPostalcode\":\"V5N7G4\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/quotes/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/quotes/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\",\"customerId\":\"0124\",\"customerName\":\"John Doe\",\"quoteNumber\":\"99\",\"txnDate\":\"2021-07-28 00:00:00\",\"billingCity\":\"Toronto\",\"billingPostalcode\":\"H6F0R3\",\"billingCountry\":\"Canada\",\"shippingCity\":\"Vancouver\",\"shippingCountry\":\"Canada\",\"totalAmount\":5000000,\"currency\":\"CAD\",\"txnStatus\":\"2021-09-15 00:00:00\",\"shippingPostalcode\":\"V5N7G4\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/quotes/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"90300000072369","created":"2021-07-28 00:00:00","modified":"2021-09-15 00:00:00","customerId":"0124","customerName":"John Doe","quoteNumber":"99","txnDate":"2021-07-28 00:00:00","billingCity":"Toronto","billingPostalcode":"H6F0R3","billingCountry":"Canada","shippingCity":"Vancouver","shippingCountry":"Canada","totalAmount":5000000,"currency":"CAD","txnStatus":"2021-09-15 00:00:00","shippingPostalcode":"V5N7G4"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/quotes/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\",\"customerId\":\"0124\",\"customerName\":\"John Doe\",\"quoteNumber\":\"99\",\"txnDate\":\"2021-07-28 00:00:00\",\"billingCity\":\"Toronto\",\"billingPostalcode\":\"H6F0R3\",\"billingCountry\":\"Canada\",\"shippingCity\":\"Vancouver\",\"shippingCountry\":\"Canada\",\"totalAmount\":5000000,\"currency\":\"CAD\",\"txnStatus\":\"2021-09-15 00:00:00\",\"shippingPostalcode\":\"V5N7G4\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/quotes/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\",\"customerId\":\"0124\",\"customerName\":\"John Doe\",\"quoteNumber\":\"99\",\"txnDate\":\"2021-07-28 00:00:00\",\"billingCity\":\"Toronto\",\"billingPostalcode\":\"H6F0R3\",\"billingCountry\":\"Canada\",\"shippingCity\":\"Vancouver\",\"shippingCountry\":\"Canada\",\"totalAmount\":5000000,\"currency\":\"CAD\",\"txnStatus\":\"2021-09-15 00:00:00\",\"shippingPostalcode\":\"V5N7G4\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\",\"customerId\":\"0124\",\"customerName\":\"John Doe\",\"quoteNumber\":\"99\",\"txnDate\":\"2021-07-28 00:00:00\",\"billingCity\":\"Toronto\",\"billingPostalcode\":\"H6F0R3\",\"billingCountry\":\"Canada\",\"shippingCity\":\"Vancouver\",\"shippingCountry\":\"Canada\",\"totalAmount\":5000000,\"currency\":\"CAD\",\"txnStatus\":\"2021-09-15 00:00:00\",\"shippingPostalcode\":\"V5N7G4\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/quotes/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/quotes/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"90300000072369\\\",\\\"created\\\":\\\"2021-07-28 00:00:00\\\",\\\"modified\\\":\\\"2021-09-15 00:00:00\\\",\\\"customerId\\\":\\\"0124\\\",\\\"customerName\\\":\\\"John Doe\\\",\\\"quoteNumber\\\":\\\"99\\\",\\\"txnDate\\\":\\\"2021-07-28 00:00:00\\\",\\\"billingCity\\\":\\\"Toronto\\\",\\\"billingPostalcode\\\":\\\"H6F0R3\\\",\\\"billingCountry\\\":\\\"Canada\\\",\\\"shippingCity\\\":\\\"Vancouver\\\",\\\"shippingCountry\\\":\\\"Canada\\\",\\\"totalAmount\\\":5000000,\\\"currency\\\":\\\"CAD\\\",\\\"txnStatus\\\":\\\"2021-09-15 00:00:00\\\",\\\"shippingPostalcode\\\":\\\"V5N7G4\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/quotes/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"90300000072369\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\",\"customerId\":\"0124\",\"customerName\":\"John Doe\",\"quoteNumber\":\"99\",\"txnDate\":\"2021-07-28 00:00:00\",\"billingCity\":\"Toronto\",\"billingPostalcode\":\"H6F0R3\",\"billingCountry\":\"Canada\",\"shippingCity\":\"Vancouver\",\"shippingCountry\":\"Canada\",\"totalAmount\":5000000,\"currency\":\"CAD\",\"txnStatus\":\"2021-09-15 00:00:00\",\"shippingPostalcode\":\"V5N7G4\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/quotes/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '90300000072369', created: '2021-07-28 00:00:00', modified: '2021-09-15 00:00:00', customerId: '0124', customerName: 'John Doe', quoteNumber: '99', txnDate: '2021-07-28 00:00:00', billingCity: 'Toronto', billingPostalcode: 'H6F0R3', billingCountry: 'Canada', shippingCity: 'Vancouver', shippingCountry: 'Canada', totalAmount: 5000000, currency: 'CAD', txnStatus: '2021-09-15 00:00:00', shippingPostalcode: 'V5N7G4' })); req.end(); delete: tags: - Quote summary: Removes the Quote resource. operationId: Quote_removeResource description: Removes the Quote resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: Quote resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/quotes/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/quotes/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/quotes/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/quotes/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/quotes/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/quotes/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/quotes/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/quotes/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/quotes/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /recurring_charges: parameters: [] get: tags: - RecurringCharge summary: Retrieves the collection of RecurringCharge resources. operationId: RecurringCharge_listResources description: Retrieves the collection of RecurringCharge resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: RecurringCharge collection content: application/json: schema: $ref: '#/components/schemas/RecurringChargeListResourcesResponse' application/xml: schema: $ref: '#/components/schemas/RecurringChargeListResources200Response' text/xml: schema: $ref: '#/components/schemas/RecurringChargeListResources200Response' text/csv: schema: $ref: '#/components/schemas/RecurringChargeListResources200Response' text/html: schema: $ref: '#/components/schemas/RecurringChargeListResources200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/recurring_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/recurring_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/recurring_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/recurring_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/recurring_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/recurring_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/recurring_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/recurring_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/recurring_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - RecurringCharge summary: Creates a RecurringCharge resource. operationId: RecurringCharge_createResource description: Creates a RecurringCharge resource. parameters: [] requestBody: description: The new RecurringCharge resource content: application/json: schema: $ref: '#/components/schemas/RecurringChargeCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/RecurringChargeCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/RecurringChargeCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/RecurringChargeCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/RecurringChargeCreateResourceRequest4' required: true responses: '201': description: RecurringCharge resource created content: application/json: schema: $ref: '#/components/schemas/RecurringChargeCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/RecurringChargeCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/RecurringChargeCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/RecurringChargeCreateResource201Response' text/html: schema: $ref: '#/components/schemas/RecurringChargeCreateResource201Response' links: GetRecurringChargeItem: operationId: getRecurringChargeItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /recurring_charges/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"name\":\"Monthly Rental\",\"srcId\":\"982000000567240\",\"apiClientId\":\"aa2e-87c43f2a32a9\",\"price\":1200,\"status\":\"Pending\",\"returnUrl\":\"www.example.com\",\"billingDate\":\"2021-07-28\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-07-28 00:00:00\",\"activationDate\":\"2021-06-28\",\"cancellationDate\":\"2021-08-28\",\"trialDays\":12,\"trialEndsOn\":\"2021-07-09\",\"decoratedReturnUrl\":\"https://www.example.com\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/recurring_charges") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/recurring_charges"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"name\":\"Monthly Rental\",\"srcId\":\"982000000567240\",\"apiClientId\":\"aa2e-87c43f2a32a9\",\"price\":1200,\"status\":\"Pending\",\"returnUrl\":\"www.example.com\",\"billingDate\":\"2021-07-28\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-07-28 00:00:00\",\"activationDate\":\"2021-06-28\",\"cancellationDate\":\"2021-08-28\",\"trialDays\":12,\"trialEndsOn\":\"2021-07-09\",\"decoratedReturnUrl\":\"https://www.example.com\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/recurring_charges \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","name":"Monthly Rental","srcId":"982000000567240","apiClientId":"aa2e-87c43f2a32a9","price":1200,"status":"Pending","returnUrl":"www.example.com","billingDate":"2021-07-28","created":"2021-07-28 00:00:00","modified":"2021-07-28 00:00:00","activationDate":"2021-06-28","cancellationDate":"2021-08-28","trialDays":12,"trialEndsOn":"2021-07-09","decoratedReturnUrl":"https://www.example.com"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/recurring_charges", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"name\":\"Monthly Rental\",\"srcId\":\"982000000567240\",\"apiClientId\":\"aa2e-87c43f2a32a9\",\"price\":1200,\"status\":\"Pending\",\"returnUrl\":\"www.example.com\",\"billingDate\":\"2021-07-28\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-07-28 00:00:00\",\"activationDate\":\"2021-06-28\",\"cancellationDate\":\"2021-08-28\",\"trialDays\":12,\"trialEndsOn\":\"2021-07-09\",\"decoratedReturnUrl\":\"https://www.example.com\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/recurring_charges") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"name\":\"Monthly Rental\",\"srcId\":\"982000000567240\",\"apiClientId\":\"aa2e-87c43f2a32a9\",\"price\":1200,\"status\":\"Pending\",\"returnUrl\":\"www.example.com\",\"billingDate\":\"2021-07-28\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-07-28 00:00:00\",\"activationDate\":\"2021-06-28\",\"cancellationDate\":\"2021-08-28\",\"trialDays\":12,\"trialEndsOn\":\"2021-07-09\",\"decoratedReturnUrl\":\"https://www.example.com\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"name\":\"Monthly Rental\",\"srcId\":\"982000000567240\",\"apiClientId\":\"aa2e-87c43f2a32a9\",\"price\":1200,\"status\":\"Pending\",\"returnUrl\":\"www.example.com\",\"billingDate\":\"2021-07-28\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-07-28 00:00:00\",\"activationDate\":\"2021-06-28\",\"cancellationDate\":\"2021-08-28\",\"trialDays\":12,\"trialEndsOn\":\"2021-07-09\",\"decoratedReturnUrl\":\"https://www.example.com\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/recurring_charges", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/recurring_charges\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"name\\\":\\\"Monthly Rental\\\",\\\"srcId\\\":\\\"982000000567240\\\",\\\"apiClientId\\\":\\\"aa2e-87c43f2a32a9\\\",\\\"price\\\":1200,\\\"status\\\":\\\"Pending\\\",\\\"returnUrl\\\":\\\"www.example.com\\\",\\\"billingDate\\\":\\\"2021-07-28\\\",\\\"created\\\":\\\"2021-07-28 00:00:00\\\",\\\"modified\\\":\\\"2021-07-28 00:00:00\\\",\\\"activationDate\\\":\\\"2021-06-28\\\",\\\"cancellationDate\\\":\\\"2021-08-28\\\",\\\"trialDays\\\":12,\\\"trialEndsOn\\\":\\\"2021-07-09\\\",\\\"decoratedReturnUrl\\\":\\\"https://www.example.com\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/recurring_charges", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"name\":\"Monthly Rental\",\"srcId\":\"982000000567240\",\"apiClientId\":\"aa2e-87c43f2a32a9\",\"price\":1200,\"status\":\"Pending\",\"returnUrl\":\"www.example.com\",\"billingDate\":\"2021-07-28\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-07-28 00:00:00\",\"activationDate\":\"2021-06-28\",\"cancellationDate\":\"2021-08-28\",\"trialDays\":12,\"trialEndsOn\":\"2021-07-09\",\"decoratedReturnUrl\":\"https://www.example.com\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/recurring_charges", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', name: 'Monthly Rental', srcId: '982000000567240', apiClientId: 'aa2e-87c43f2a32a9', price: 1200, status: 'Pending', returnUrl: 'www.example.com', billingDate: '2021-07-28', created: '2021-07-28 00:00:00', modified: '2021-07-28 00:00:00', activationDate: '2021-06-28', cancellationDate: '2021-08-28', trialDays: 12, trialEndsOn: '2021-07-09', decoratedReturnUrl: 'https://www.example.com' })); req.end(); /recurring_charges/{id}: parameters: [] get: tags: - RecurringCharge summary: Retrieves a RecurringCharge resource. operationId: RecurringCharge_getResource description: Retrieves a RecurringCharge resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: RecurringCharge resource content: application/json: schema: $ref: '#/components/schemas/RecurringChargeGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/RecurringChargeGetResource200Response' text/xml: schema: $ref: '#/components/schemas/RecurringChargeGetResource200Response' text/csv: schema: $ref: '#/components/schemas/RecurringChargeGetResource200Response' text/html: schema: $ref: '#/components/schemas/RecurringChargeGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/recurring_charges/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/recurring_charges/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - RecurringCharge summary: Replaces the RecurringCharge resource. operationId: RecurringCharge_replaceResource description: Replaces the RecurringCharge resource. parameters: - description: Resource identifier name: id in: path 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/RecurringChargeReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/RecurringChargeReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/RecurringChargeReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/RecurringChargeReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/RecurringChargeReplaceResourceRequest4' required: true responses: '200': description: RecurringCharge resource updated content: application/json: schema: $ref: '#/components/schemas/RecurringChargeReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/RecurringChargeReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/RecurringChargeReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/RecurringChargeReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/RecurringChargeReplaceResource200Response' links: GetRecurringChargeItem: operationId: getRecurringChargeItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /recurring_charges/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"name\":\"Monthly Rental\",\"srcId\":\"982000000567240\",\"apiClientId\":\"aa2e-87c43f2a32a9\",\"price\":1200,\"status\":\"Pending\",\"returnUrl\":\"www.example.com\",\"billingDate\":\"2021-07-28\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-07-28 00:00:00\",\"activationDate\":\"2021-06-28\",\"cancellationDate\":\"2021-08-28\",\"trialDays\":12,\"trialEndsOn\":\"2021-07-09\",\"decoratedReturnUrl\":\"https://www.example.com\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"name\":\"Monthly Rental\",\"srcId\":\"982000000567240\",\"apiClientId\":\"aa2e-87c43f2a32a9\",\"price\":1200,\"status\":\"Pending\",\"returnUrl\":\"www.example.com\",\"billingDate\":\"2021-07-28\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-07-28 00:00:00\",\"activationDate\":\"2021-06-28\",\"cancellationDate\":\"2021-08-28\",\"trialDays\":12,\"trialEndsOn\":\"2021-07-09\",\"decoratedReturnUrl\":\"https://www.example.com\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","name":"Monthly Rental","srcId":"982000000567240","apiClientId":"aa2e-87c43f2a32a9","price":1200,"status":"Pending","returnUrl":"www.example.com","billingDate":"2021-07-28","created":"2021-07-28 00:00:00","modified":"2021-07-28 00:00:00","activationDate":"2021-06-28","cancellationDate":"2021-08-28","trialDays":12,"trialEndsOn":"2021-07-09","decoratedReturnUrl":"https://www.example.com"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"name\":\"Monthly Rental\",\"srcId\":\"982000000567240\",\"apiClientId\":\"aa2e-87c43f2a32a9\",\"price\":1200,\"status\":\"Pending\",\"returnUrl\":\"www.example.com\",\"billingDate\":\"2021-07-28\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-07-28 00:00:00\",\"activationDate\":\"2021-06-28\",\"cancellationDate\":\"2021-08-28\",\"trialDays\":12,\"trialEndsOn\":\"2021-07-09\",\"decoratedReturnUrl\":\"https://www.example.com\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"name\":\"Monthly Rental\",\"srcId\":\"982000000567240\",\"apiClientId\":\"aa2e-87c43f2a32a9\",\"price\":1200,\"status\":\"Pending\",\"returnUrl\":\"www.example.com\",\"billingDate\":\"2021-07-28\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-07-28 00:00:00\",\"activationDate\":\"2021-06-28\",\"cancellationDate\":\"2021-08-28\",\"trialDays\":12,\"trialEndsOn\":\"2021-07-09\",\"decoratedReturnUrl\":\"https://www.example.com\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"name\":\"Monthly Rental\",\"srcId\":\"982000000567240\",\"apiClientId\":\"aa2e-87c43f2a32a9\",\"price\":1200,\"status\":\"Pending\",\"returnUrl\":\"www.example.com\",\"billingDate\":\"2021-07-28\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-07-28 00:00:00\",\"activationDate\":\"2021-06-28\",\"cancellationDate\":\"2021-08-28\",\"trialDays\":12,\"trialEndsOn\":\"2021-07-09\",\"decoratedReturnUrl\":\"https://www.example.com\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/recurring_charges/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"name\\\":\\\"Monthly Rental\\\",\\\"srcId\\\":\\\"982000000567240\\\",\\\"apiClientId\\\":\\\"aa2e-87c43f2a32a9\\\",\\\"price\\\":1200,\\\"status\\\":\\\"Pending\\\",\\\"returnUrl\\\":\\\"www.example.com\\\",\\\"billingDate\\\":\\\"2021-07-28\\\",\\\"created\\\":\\\"2021-07-28 00:00:00\\\",\\\"modified\\\":\\\"2021-07-28 00:00:00\\\",\\\"activationDate\\\":\\\"2021-06-28\\\",\\\"cancellationDate\\\":\\\"2021-08-28\\\",\\\"trialDays\\\":12,\\\"trialEndsOn\\\":\\\"2021-07-09\\\",\\\"decoratedReturnUrl\\\":\\\"https://www.example.com\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"name\":\"Monthly Rental\",\"srcId\":\"982000000567240\",\"apiClientId\":\"aa2e-87c43f2a32a9\",\"price\":1200,\"status\":\"Pending\",\"returnUrl\":\"www.example.com\",\"billingDate\":\"2021-07-28\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-07-28 00:00:00\",\"activationDate\":\"2021-06-28\",\"cancellationDate\":\"2021-08-28\",\"trialDays\":12,\"trialEndsOn\":\"2021-07-09\",\"decoratedReturnUrl\":\"https://www.example.com\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/recurring_charges/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', name: 'Monthly Rental', srcId: '982000000567240', apiClientId: 'aa2e-87c43f2a32a9', price: 1200, status: 'Pending', returnUrl: 'www.example.com', billingDate: '2021-07-28', created: '2021-07-28 00:00:00', modified: '2021-07-28 00:00:00', activationDate: '2021-06-28', cancellationDate: '2021-08-28', trialDays: 12, trialEndsOn: '2021-07-09', decoratedReturnUrl: 'https://www.example.com' })); req.end(); delete: tags: - RecurringCharge summary: Removes the RecurringCharge resource. operationId: RecurringCharge_removeResource description: Removes the RecurringCharge resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: RecurringCharge resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/recurring_charges/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/recurring_charges/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/recurring_charges/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /recurring_expenses: parameters: [] get: tags: - RecurringExpense summary: Retrieves the collection of RecurringExpense resources. operationId: RecurringExpense_listResources description: Retrieves the collection of RecurringExpense resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: RecurringExpense collection content: application/json: schema: $ref: '#/components/schemas/RecurringExpenseListResourcesResponse' application/xml: schema: $ref: '#/components/schemas/RecurringExpenseListResources200Response' text/xml: schema: $ref: '#/components/schemas/RecurringExpenseListResources200Response' text/csv: schema: $ref: '#/components/schemas/RecurringExpenseListResources200Response' text/html: schema: $ref: '#/components/schemas/RecurringExpenseListResources200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/recurring_expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/recurring_expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/recurring_expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/recurring_expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/recurring_expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/recurring_expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/recurring_expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/recurring_expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/recurring_expenses?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - RecurringExpense summary: Creates a RecurringExpense resource. operationId: RecurringExpense_createResource description: Creates a RecurringExpense resource. parameters: [] requestBody: description: The new RecurringExpense resource content: application/json: schema: $ref: '#/components/schemas/RecurringExpenseCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/RecurringExpenseCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/RecurringExpenseCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/RecurringExpenseCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/RecurringExpenseCreateResourceRequest4' required: true responses: '201': description: RecurringExpense resource created content: application/json: schema: $ref: '#/components/schemas/RecurringExpenseCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/RecurringExpenseCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/RecurringExpenseCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/RecurringExpenseCreateResource201Response' text/html: schema: $ref: '#/components/schemas/RecurringExpenseCreateResource201Response' links: GetRecurringExpenseItem: operationId: getRecurringExpenseItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /recurring_expenses/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"982000000567240\",\"recurrenceName\":\"Monthly Rental\",\"startDate\":\"2020-11-19T00:00:00.000Z\",\"endDate\":\"2024-11-19T00:00:00.000Z\",\"lastCreatedDate\":\"2021-11-18T00:00:00.000Z\",\"recurrenceFrequency\":\"months\",\"repeatEvery\":\"2\",\"nextExpenseDate\":\"2021-12-18T00:00:00.000Z\",\"accountId\":\"982000000561057\",\"accountName\":\"Rent\",\"currency\":\"USD\",\"total\":100,\"customerId\":\"982000000567001\",\"status\":\"active\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/recurring_expenses") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/recurring_expenses"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"982000000567240\",\"recurrenceName\":\"Monthly Rental\",\"startDate\":\"2020-11-19T00:00:00.000Z\",\"endDate\":\"2024-11-19T00:00:00.000Z\",\"lastCreatedDate\":\"2021-11-18T00:00:00.000Z\",\"recurrenceFrequency\":\"months\",\"repeatEvery\":\"2\",\"nextExpenseDate\":\"2021-12-18T00:00:00.000Z\",\"accountId\":\"982000000561057\",\"accountName\":\"Rent\",\"currency\":\"USD\",\"total\":100,\"customerId\":\"982000000567001\",\"status\":\"active\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/recurring_expenses \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"982000000567240","recurrenceName":"Monthly Rental","startDate":"2020-11-19T00:00:00.000Z","endDate":"2024-11-19T00:00:00.000Z","lastCreatedDate":"2021-11-18T00:00:00.000Z","recurrenceFrequency":"months","repeatEvery":"2","nextExpenseDate":"2021-12-18T00:00:00.000Z","accountId":"982000000561057","accountName":"Rent","currency":"USD","total":100,"customerId":"982000000567001","status":"active","created":"2021-07-28 00:00:00","modified":"2021-09-15 00:00:00"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/recurring_expenses", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"982000000567240\",\"recurrenceName\":\"Monthly Rental\",\"startDate\":\"2020-11-19T00:00:00.000Z\",\"endDate\":\"2024-11-19T00:00:00.000Z\",\"lastCreatedDate\":\"2021-11-18T00:00:00.000Z\",\"recurrenceFrequency\":\"months\",\"repeatEvery\":\"2\",\"nextExpenseDate\":\"2021-12-18T00:00:00.000Z\",\"accountId\":\"982000000561057\",\"accountName\":\"Rent\",\"currency\":\"USD\",\"total\":100,\"customerId\":\"982000000567001\",\"status\":\"active\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/recurring_expenses") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"982000000567240\",\"recurrenceName\":\"Monthly Rental\",\"startDate\":\"2020-11-19T00:00:00.000Z\",\"endDate\":\"2024-11-19T00:00:00.000Z\",\"lastCreatedDate\":\"2021-11-18T00:00:00.000Z\",\"recurrenceFrequency\":\"months\",\"repeatEvery\":\"2\",\"nextExpenseDate\":\"2021-12-18T00:00:00.000Z\",\"accountId\":\"982000000561057\",\"accountName\":\"Rent\",\"currency\":\"USD\",\"total\":100,\"customerId\":\"982000000567001\",\"status\":\"active\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"982000000567240\",\"recurrenceName\":\"Monthly Rental\",\"startDate\":\"2020-11-19T00:00:00.000Z\",\"endDate\":\"2024-11-19T00:00:00.000Z\",\"lastCreatedDate\":\"2021-11-18T00:00:00.000Z\",\"recurrenceFrequency\":\"months\",\"repeatEvery\":\"2\",\"nextExpenseDate\":\"2021-12-18T00:00:00.000Z\",\"accountId\":\"982000000561057\",\"accountName\":\"Rent\",\"currency\":\"USD\",\"total\":100,\"customerId\":\"982000000567001\",\"status\":\"active\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/recurring_expenses", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/recurring_expenses\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"982000000567240\\\",\\\"recurrenceName\\\":\\\"Monthly Rental\\\",\\\"startDate\\\":\\\"2020-11-19T00:00:00.000Z\\\",\\\"endDate\\\":\\\"2024-11-19T00:00:00.000Z\\\",\\\"lastCreatedDate\\\":\\\"2021-11-18T00:00:00.000Z\\\",\\\"recurrenceFrequency\\\":\\\"months\\\",\\\"repeatEvery\\\":\\\"2\\\",\\\"nextExpenseDate\\\":\\\"2021-12-18T00:00:00.000Z\\\",\\\"accountId\\\":\\\"982000000561057\\\",\\\"accountName\\\":\\\"Rent\\\",\\\"currency\\\":\\\"USD\\\",\\\"total\\\":100,\\\"customerId\\\":\\\"982000000567001\\\",\\\"status\\\":\\\"active\\\",\\\"created\\\":\\\"2021-07-28 00:00:00\\\",\\\"modified\\\":\\\"2021-09-15 00:00:00\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/recurring_expenses", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"982000000567240\",\"recurrenceName\":\"Monthly Rental\",\"startDate\":\"2020-11-19T00:00:00.000Z\",\"endDate\":\"2024-11-19T00:00:00.000Z\",\"lastCreatedDate\":\"2021-11-18T00:00:00.000Z\",\"recurrenceFrequency\":\"months\",\"repeatEvery\":\"2\",\"nextExpenseDate\":\"2021-12-18T00:00:00.000Z\",\"accountId\":\"982000000561057\",\"accountName\":\"Rent\",\"currency\":\"USD\",\"total\":100,\"customerId\":\"982000000567001\",\"status\":\"active\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/recurring_expenses", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '982000000567240', recurrenceName: 'Monthly Rental', startDate: '2020-11-19T00:00:00.000Z', endDate: '2024-11-19T00:00:00.000Z', lastCreatedDate: '2021-11-18T00:00:00.000Z', recurrenceFrequency: 'months', repeatEvery: '2', nextExpenseDate: '2021-12-18T00:00:00.000Z', accountId: '982000000561057', accountName: 'Rent', currency: 'USD', total: 100, customerId: '982000000567001', status: 'active', created: '2021-07-28 00:00:00', modified: '2021-09-15 00:00:00' })); req.end(); /recurring_expenses/{id}: parameters: [] get: tags: - RecurringExpense summary: Retrieves a RecurringExpense resource. operationId: RecurringExpense_getResource description: Retrieves a RecurringExpense resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: RecurringExpense resource content: application/json: schema: $ref: '#/components/schemas/RecurringExpenseGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/RecurringExpenseGetResource200Response' text/xml: schema: $ref: '#/components/schemas/RecurringExpenseGetResource200Response' text/csv: schema: $ref: '#/components/schemas/RecurringExpenseGetResource200Response' text/html: schema: $ref: '#/components/schemas/RecurringExpenseGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/recurring_expenses/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/recurring_expenses/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - RecurringExpense summary: Replaces the RecurringExpense resource. operationId: RecurringExpense_replaceResource description: Replaces the RecurringExpense resource. parameters: - description: Resource identifier name: id in: path 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/RecurringExpenseReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/RecurringExpenseReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/RecurringExpenseReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/RecurringExpenseReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/RecurringExpenseReplaceResourceRequest4' required: true responses: '200': description: RecurringExpense resource updated content: application/json: schema: $ref: '#/components/schemas/RecurringExpenseReplaceResourceResponse' application/xml: schema: $ref: >- #/components/schemas/RecurringExpenseReplaceResource200Response text/xml: schema: $ref: >- #/components/schemas/RecurringExpenseReplaceResource200Response text/csv: schema: $ref: >- #/components/schemas/RecurringExpenseReplaceResource200Response text/html: schema: $ref: >- #/components/schemas/RecurringExpenseReplaceResource200Response links: GetRecurringExpenseItem: operationId: getRecurringExpenseItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /recurring_expenses/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"982000000567240\",\"recurrenceName\":\"Monthly Rental\",\"startDate\":\"2020-11-19T00:00:00.000Z\",\"endDate\":\"2024-11-19T00:00:00.000Z\",\"lastCreatedDate\":\"2021-11-18T00:00:00.000Z\",\"recurrenceFrequency\":\"months\",\"repeatEvery\":\"2\",\"nextExpenseDate\":\"2021-12-18T00:00:00.000Z\",\"accountId\":\"982000000561057\",\"accountName\":\"Rent\",\"currency\":\"USD\",\"total\":100,\"customerId\":\"982000000567001\",\"status\":\"active\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"982000000567240\",\"recurrenceName\":\"Monthly Rental\",\"startDate\":\"2020-11-19T00:00:00.000Z\",\"endDate\":\"2024-11-19T00:00:00.000Z\",\"lastCreatedDate\":\"2021-11-18T00:00:00.000Z\",\"recurrenceFrequency\":\"months\",\"repeatEvery\":\"2\",\"nextExpenseDate\":\"2021-12-18T00:00:00.000Z\",\"accountId\":\"982000000561057\",\"accountName\":\"Rent\",\"currency\":\"USD\",\"total\":100,\"customerId\":\"982000000567001\",\"status\":\"active\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"982000000567240","recurrenceName":"Monthly Rental","startDate":"2020-11-19T00:00:00.000Z","endDate":"2024-11-19T00:00:00.000Z","lastCreatedDate":"2021-11-18T00:00:00.000Z","recurrenceFrequency":"months","repeatEvery":"2","nextExpenseDate":"2021-12-18T00:00:00.000Z","accountId":"982000000561057","accountName":"Rent","currency":"USD","total":100,"customerId":"982000000567001","status":"active","created":"2021-07-28 00:00:00","modified":"2021-09-15 00:00:00"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"982000000567240\",\"recurrenceName\":\"Monthly Rental\",\"startDate\":\"2020-11-19T00:00:00.000Z\",\"endDate\":\"2024-11-19T00:00:00.000Z\",\"lastCreatedDate\":\"2021-11-18T00:00:00.000Z\",\"recurrenceFrequency\":\"months\",\"repeatEvery\":\"2\",\"nextExpenseDate\":\"2021-12-18T00:00:00.000Z\",\"accountId\":\"982000000561057\",\"accountName\":\"Rent\",\"currency\":\"USD\",\"total\":100,\"customerId\":\"982000000567001\",\"status\":\"active\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"982000000567240\",\"recurrenceName\":\"Monthly Rental\",\"startDate\":\"2020-11-19T00:00:00.000Z\",\"endDate\":\"2024-11-19T00:00:00.000Z\",\"lastCreatedDate\":\"2021-11-18T00:00:00.000Z\",\"recurrenceFrequency\":\"months\",\"repeatEvery\":\"2\",\"nextExpenseDate\":\"2021-12-18T00:00:00.000Z\",\"accountId\":\"982000000561057\",\"accountName\":\"Rent\",\"currency\":\"USD\",\"total\":100,\"customerId\":\"982000000567001\",\"status\":\"active\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"982000000567240\",\"recurrenceName\":\"Monthly Rental\",\"startDate\":\"2020-11-19T00:00:00.000Z\",\"endDate\":\"2024-11-19T00:00:00.000Z\",\"lastCreatedDate\":\"2021-11-18T00:00:00.000Z\",\"recurrenceFrequency\":\"months\",\"repeatEvery\":\"2\",\"nextExpenseDate\":\"2021-12-18T00:00:00.000Z\",\"accountId\":\"982000000561057\",\"accountName\":\"Rent\",\"currency\":\"USD\",\"total\":100,\"customerId\":\"982000000567001\",\"status\":\"active\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/recurring_expenses/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"982000000567240\\\",\\\"recurrenceName\\\":\\\"Monthly Rental\\\",\\\"startDate\\\":\\\"2020-11-19T00:00:00.000Z\\\",\\\"endDate\\\":\\\"2024-11-19T00:00:00.000Z\\\",\\\"lastCreatedDate\\\":\\\"2021-11-18T00:00:00.000Z\\\",\\\"recurrenceFrequency\\\":\\\"months\\\",\\\"repeatEvery\\\":\\\"2\\\",\\\"nextExpenseDate\\\":\\\"2021-12-18T00:00:00.000Z\\\",\\\"accountId\\\":\\\"982000000561057\\\",\\\"accountName\\\":\\\"Rent\\\",\\\"currency\\\":\\\"USD\\\",\\\"total\\\":100,\\\"customerId\\\":\\\"982000000567001\\\",\\\"status\\\":\\\"active\\\",\\\"created\\\":\\\"2021-07-28 00:00:00\\\",\\\"modified\\\":\\\"2021-09-15 00:00:00\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"982000000567240\",\"recurrenceName\":\"Monthly Rental\",\"startDate\":\"2020-11-19T00:00:00.000Z\",\"endDate\":\"2024-11-19T00:00:00.000Z\",\"lastCreatedDate\":\"2021-11-18T00:00:00.000Z\",\"recurrenceFrequency\":\"months\",\"repeatEvery\":\"2\",\"nextExpenseDate\":\"2021-12-18T00:00:00.000Z\",\"accountId\":\"982000000561057\",\"accountName\":\"Rent\",\"currency\":\"USD\",\"total\":100,\"customerId\":\"982000000567001\",\"status\":\"active\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/recurring_expenses/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '982000000567240', recurrenceName: 'Monthly Rental', startDate: '2020-11-19T00:00:00.000Z', endDate: '2024-11-19T00:00:00.000Z', lastCreatedDate: '2021-11-18T00:00:00.000Z', recurrenceFrequency: 'months', repeatEvery: '2', nextExpenseDate: '2021-12-18T00:00:00.000Z', accountId: '982000000561057', accountName: 'Rent', currency: 'USD', total: 100, customerId: '982000000567001', status: 'active', created: '2021-07-28 00:00:00', modified: '2021-09-15 00:00:00' })); req.end(); delete: tags: - RecurringExpense summary: Removes the RecurringExpense resource. operationId: RecurringExpense_removeResource description: Removes the RecurringExpense resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: RecurringExpense resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/recurring_expenses/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/recurring_expenses/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/recurring_expenses/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /refunds: parameters: [] get: tags: - Refund summary: Retrieves the collection of Refund resources. operationId: Refund_getCollection description: Retrieves the collection of Refund resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Refund collection content: application/json: schema: $ref: '#/components/schemas/RefundGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/RefundGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/RefundGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/RefundGetCollection200Response' text/html: schema: $ref: '#/components/schemas/RefundGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/refunds?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/refunds?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/refunds?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/refunds?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/refunds?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/refunds?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/refunds?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/refunds?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/refunds?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - Refund summary: Creates a Refund resource. operationId: Refund_createResource description: Creates a Refund resource. parameters: [] requestBody: description: The new Refund resource content: application/json: schema: $ref: '#/components/schemas/RefundCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/RefundCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/RefundCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/RefundCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/RefundCreateResourceRequest4' required: true responses: '201': description: Refund resource created content: application/json: schema: $ref: '#/components/schemas/RefundCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/RefundCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/RefundCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/RefundCreateResource201Response' text/html: schema: $ref: '#/components/schemas/RefundCreateResource201Response' links: GetRefundItem: operationId: getRefundItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /refunds/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"accountId\":\"35\",\"currency\":\"USD\",\"paymentRef\":\"USD\",\"txnDate\":\"2021-06-24\",\"totalAmount\":8750,\"balance\":0,\"customerId\":\"15\",\"created\":\"2021-06-24T22:35:07+00:00\",\"modified\":\"2021-06-24T22:35:07+00:00\",\"srcId\":\"66\",\"reason\":\"bad item\",\"status\":\"succeeded\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/refunds") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/refunds"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"accountId\":\"35\",\"currency\":\"USD\",\"paymentRef\":\"USD\",\"txnDate\":\"2021-06-24\",\"totalAmount\":8750,\"balance\":0,\"customerId\":\"15\",\"created\":\"2021-06-24T22:35:07+00:00\",\"modified\":\"2021-06-24T22:35:07+00:00\",\"srcId\":\"66\",\"reason\":\"bad item\",\"status\":\"succeeded\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/refunds \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","accountId":"35","currency":"USD","paymentRef":"USD","txnDate":"2021-06-24","totalAmount":8750,"balance":0,"customerId":"15","created":"2021-06-24T22:35:07+00:00","modified":"2021-06-24T22:35:07+00:00","srcId":"66","reason":"bad item","status":"succeeded"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/refunds", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"accountId\":\"35\",\"currency\":\"USD\",\"paymentRef\":\"USD\",\"txnDate\":\"2021-06-24\",\"totalAmount\":8750,\"balance\":0,\"customerId\":\"15\",\"created\":\"2021-06-24T22:35:07+00:00\",\"modified\":\"2021-06-24T22:35:07+00:00\",\"srcId\":\"66\",\"reason\":\"bad item\",\"status\":\"succeeded\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/refunds") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"accountId\":\"35\",\"currency\":\"USD\",\"paymentRef\":\"USD\",\"txnDate\":\"2021-06-24\",\"totalAmount\":8750,\"balance\":0,\"customerId\":\"15\",\"created\":\"2021-06-24T22:35:07+00:00\",\"modified\":\"2021-06-24T22:35:07+00:00\",\"srcId\":\"66\",\"reason\":\"bad item\",\"status\":\"succeeded\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"accountId\":\"35\",\"currency\":\"USD\",\"paymentRef\":\"USD\",\"txnDate\":\"2021-06-24\",\"totalAmount\":8750,\"balance\":0,\"customerId\":\"15\",\"created\":\"2021-06-24T22:35:07+00:00\",\"modified\":\"2021-06-24T22:35:07+00:00\",\"srcId\":\"66\",\"reason\":\"bad item\",\"status\":\"succeeded\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/refunds", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/refunds\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"accountId\\\":\\\"35\\\",\\\"currency\\\":\\\"USD\\\",\\\"paymentRef\\\":\\\"USD\\\",\\\"txnDate\\\":\\\"2021-06-24\\\",\\\"totalAmount\\\":8750,\\\"balance\\\":0,\\\"customerId\\\":\\\"15\\\",\\\"created\\\":\\\"2021-06-24T22:35:07+00:00\\\",\\\"modified\\\":\\\"2021-06-24T22:35:07+00:00\\\",\\\"srcId\\\":\\\"66\\\",\\\"reason\\\":\\\"bad item\\\",\\\"status\\\":\\\"succeeded\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/refunds", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"accountId\":\"35\",\"currency\":\"USD\",\"paymentRef\":\"USD\",\"txnDate\":\"2021-06-24\",\"totalAmount\":8750,\"balance\":0,\"customerId\":\"15\",\"created\":\"2021-06-24T22:35:07+00:00\",\"modified\":\"2021-06-24T22:35:07+00:00\",\"srcId\":\"66\",\"reason\":\"bad item\",\"status\":\"succeeded\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/refunds", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', accountId: '35', currency: 'USD', paymentRef: 'USD', txnDate: '2021-06-24', totalAmount: 8750, balance: 0, customerId: '15', created: '2021-06-24T22:35:07+00:00', modified: '2021-06-24T22:35:07+00:00', srcId: '66', reason: 'bad item', status: 'succeeded' })); req.end(); /refunds/{id}: parameters: [] get: tags: - Refund summary: Retrieves a Refund resource. operationId: Refund_getResource description: Retrieves a Refund resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Refund resource content: application/json: schema: $ref: '#/components/schemas/RefundGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/RefundGetResource200Response' text/xml: schema: $ref: '#/components/schemas/RefundGetResource200Response' text/csv: schema: $ref: '#/components/schemas/RefundGetResource200Response' text/html: schema: $ref: '#/components/schemas/RefundGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/refunds/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/refunds/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/refunds/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/refunds/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/refunds/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/refunds/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/refunds/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/refunds/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/refunds/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - Refund summary: Replaces the Refund resource. operationId: Refund_replaceResource description: Replaces the Refund resource. parameters: - description: Resource identifier name: id in: path 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/RefundReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/RefundReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/RefundReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/RefundReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/RefundReplaceResourceRequest4' required: true responses: '200': description: Refund resource updated content: application/json: schema: $ref: '#/components/schemas/RefundReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/RefundReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/RefundReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/RefundReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/RefundReplaceResource200Response' links: GetRefundItem: operationId: getRefundItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /refunds/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"accountId\":\"35\",\"currency\":\"USD\",\"paymentRef\":\"USD\",\"txnDate\":\"2021-06-24\",\"totalAmount\":8750,\"balance\":0,\"customerId\":\"15\",\"created\":\"2021-06-24T22:35:07+00:00\",\"modified\":\"2021-06-24T22:35:07+00:00\",\"srcId\":\"66\",\"reason\":\"bad item\",\"status\":\"succeeded\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/refunds/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/refunds/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"accountId\":\"35\",\"currency\":\"USD\",\"paymentRef\":\"USD\",\"txnDate\":\"2021-06-24\",\"totalAmount\":8750,\"balance\":0,\"customerId\":\"15\",\"created\":\"2021-06-24T22:35:07+00:00\",\"modified\":\"2021-06-24T22:35:07+00:00\",\"srcId\":\"66\",\"reason\":\"bad item\",\"status\":\"succeeded\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/refunds/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","accountId":"35","currency":"USD","paymentRef":"USD","txnDate":"2021-06-24","totalAmount":8750,"balance":0,"customerId":"15","created":"2021-06-24T22:35:07+00:00","modified":"2021-06-24T22:35:07+00:00","srcId":"66","reason":"bad item","status":"succeeded"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/refunds/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"accountId\":\"35\",\"currency\":\"USD\",\"paymentRef\":\"USD\",\"txnDate\":\"2021-06-24\",\"totalAmount\":8750,\"balance\":0,\"customerId\":\"15\",\"created\":\"2021-06-24T22:35:07+00:00\",\"modified\":\"2021-06-24T22:35:07+00:00\",\"srcId\":\"66\",\"reason\":\"bad item\",\"status\":\"succeeded\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/refunds/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"accountId\":\"35\",\"currency\":\"USD\",\"paymentRef\":\"USD\",\"txnDate\":\"2021-06-24\",\"totalAmount\":8750,\"balance\":0,\"customerId\":\"15\",\"created\":\"2021-06-24T22:35:07+00:00\",\"modified\":\"2021-06-24T22:35:07+00:00\",\"srcId\":\"66\",\"reason\":\"bad item\",\"status\":\"succeeded\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"accountId\":\"35\",\"currency\":\"USD\",\"paymentRef\":\"USD\",\"txnDate\":\"2021-06-24\",\"totalAmount\":8750,\"balance\":0,\"customerId\":\"15\",\"created\":\"2021-06-24T22:35:07+00:00\",\"modified\":\"2021-06-24T22:35:07+00:00\",\"srcId\":\"66\",\"reason\":\"bad item\",\"status\":\"succeeded\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/refunds/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/refunds/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"accountId\\\":\\\"35\\\",\\\"currency\\\":\\\"USD\\\",\\\"paymentRef\\\":\\\"USD\\\",\\\"txnDate\\\":\\\"2021-06-24\\\",\\\"totalAmount\\\":8750,\\\"balance\\\":0,\\\"customerId\\\":\\\"15\\\",\\\"created\\\":\\\"2021-06-24T22:35:07+00:00\\\",\\\"modified\\\":\\\"2021-06-24T22:35:07+00:00\\\",\\\"srcId\\\":\\\"66\\\",\\\"reason\\\":\\\"bad item\\\",\\\"status\\\":\\\"succeeded\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/refunds/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"accountId\":\"35\",\"currency\":\"USD\",\"paymentRef\":\"USD\",\"txnDate\":\"2021-06-24\",\"totalAmount\":8750,\"balance\":0,\"customerId\":\"15\",\"created\":\"2021-06-24T22:35:07+00:00\",\"modified\":\"2021-06-24T22:35:07+00:00\",\"srcId\":\"66\",\"reason\":\"bad item\",\"status\":\"succeeded\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/refunds/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', accountId: '35', currency: 'USD', paymentRef: 'USD', txnDate: '2021-06-24', totalAmount: 8750, balance: 0, customerId: '15', created: '2021-06-24T22:35:07+00:00', modified: '2021-06-24T22:35:07+00:00', srcId: '66', reason: 'bad item', status: 'succeeded' })); req.end(); delete: tags: - Refund summary: Removes the Refund resource. operationId: Refund_removeResource description: Removes the Refund resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: Refund resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/refunds/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/refunds/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/refunds/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/refunds/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/refunds/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/refunds/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/refunds/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/refunds/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/refunds/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /repeating_invoices: parameters: [] get: tags: - RepeatingInvoice summary: Retrieves the collection of RepeatingInvoice resources. operationId: RepeatingInvoice_listResources description: Retrieves the collection of RepeatingInvoice resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: RepeatingInvoice collection content: application/json: schema: $ref: '#/components/schemas/RepeatingInvoiceListResourcesResponse' application/xml: schema: $ref: '#/components/schemas/RepeatingInvoiceListResources200Response' text/xml: schema: $ref: '#/components/schemas/RepeatingInvoiceListResources200Response' text/csv: schema: $ref: '#/components/schemas/RepeatingInvoiceListResources200Response' text/html: schema: $ref: '#/components/schemas/RepeatingInvoiceListResources200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/repeating_invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/repeating_invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/repeating_invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/repeating_invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/repeating_invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/repeating_invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/repeating_invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/repeating_invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/repeating_invoices?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - RepeatingInvoice summary: Creates a RepeatingInvoice resource. operationId: RepeatingInvoice_createResource description: Creates a RepeatingInvoice resource. parameters: [] requestBody: description: The new RepeatingInvoice resource content: application/json: schema: $ref: '#/components/schemas/RepeatingInvoiceCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/RepeatingInvoiceCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/RepeatingInvoiceCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/RepeatingInvoiceCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/RepeatingInvoiceCreateResourceRequest4' required: true responses: '201': description: RepeatingInvoice resource created content: application/json: schema: $ref: '#/components/schemas/RepeatingInvoiceCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/RepeatingInvoiceCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/RepeatingInvoiceCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/RepeatingInvoiceCreateResource201Response' text/html: schema: $ref: '#/components/schemas/RepeatingInvoiceCreateResource201Response' links: GetRepeatingInvoiceItem: operationId: getRepeatingInvoiceItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /repeating_invoices/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"01e01427-6b48-4d5f-aa2e-87c43f2a32a9\",\"period\":1,\"unit\":\"MONTHLY\",\"dueDate\":\"0\",\"dueDateType\":\"DAYSAFTERBILLDATE\",\"startDate\":\"2021-02-27 00:00:00\",\"nextScheduledDate\":\"2021-07-28 00:00:00\",\"type\":\"ACCPAY\",\"reference\":\"AP\",\"hasAttachments\":false,\"contactId\":\"3b30a108-9156-4a42-a893-3bbbe7af1ef8\",\"contactName\":\"Xero\",\"status\":\"AUTHORISED\",\"lineAmountTypes\":\"Exclusive\",\"lineItemDescription\":\"Monthly subscription\",\"lineItemUnitAmount\":29,\"lineItemTaxType\":\"INPUT\",\"lineAmount\":29,\"lineItemAccountCode\":\"412\",\"lineItemQuantity\":1,\"lineItemId\":\"304e5b38-d62f-4c43-91d2-24786154c3c0\",\"subTotal\":2900,\"totalTax\":239,\"total\":3139,\"currencyCode\":\"USD\",\"recurrenceName\":\"412\",\"endDate\":\"2022-07-28 00:00:00\",\"lastSentDate\":\"2021-08-28 00:00:00\",\"paidInvoicesTotal\":1000,\"unpaidInvoicesBalance\":2139,\"discount\":412,\"billingStreet\":\"123 lonecrest drive\",\"billingStreet2\":\"412 fuller cres\",\"billingCity\":\"Toronto\",\"billingState\":\"Ontario\",\"billingPostalCode\":\"H6F 3F6\",\"billingCountry\":\"Canada\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/repeating_invoices") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/repeating_invoices"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"01e01427-6b48-4d5f-aa2e-87c43f2a32a9\",\"period\":1,\"unit\":\"MONTHLY\",\"dueDate\":\"0\",\"dueDateType\":\"DAYSAFTERBILLDATE\",\"startDate\":\"2021-02-27 00:00:00\",\"nextScheduledDate\":\"2021-07-28 00:00:00\",\"type\":\"ACCPAY\",\"reference\":\"AP\",\"hasAttachments\":false,\"contactId\":\"3b30a108-9156-4a42-a893-3bbbe7af1ef8\",\"contactName\":\"Xero\",\"status\":\"AUTHORISED\",\"lineAmountTypes\":\"Exclusive\",\"lineItemDescription\":\"Monthly subscription\",\"lineItemUnitAmount\":29,\"lineItemTaxType\":\"INPUT\",\"lineAmount\":29,\"lineItemAccountCode\":\"412\",\"lineItemQuantity\":1,\"lineItemId\":\"304e5b38-d62f-4c43-91d2-24786154c3c0\",\"subTotal\":2900,\"totalTax\":239,\"total\":3139,\"currencyCode\":\"USD\",\"recurrenceName\":\"412\",\"endDate\":\"2022-07-28 00:00:00\",\"lastSentDate\":\"2021-08-28 00:00:00\",\"paidInvoicesTotal\":1000,\"unpaidInvoicesBalance\":2139,\"discount\":412,\"billingStreet\":\"123 lonecrest drive\",\"billingStreet2\":\"412 fuller cres\",\"billingCity\":\"Toronto\",\"billingState\":\"Ontario\",\"billingPostalCode\":\"H6F 3F6\",\"billingCountry\":\"Canada\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/repeating_invoices \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"01e01427-6b48-4d5f-aa2e-87c43f2a32a9","period":1,"unit":"MONTHLY","dueDate":"0","dueDateType":"DAYSAFTERBILLDATE","startDate":"2021-02-27 00:00:00","nextScheduledDate":"2021-07-28 00:00:00","type":"ACCPAY","reference":"AP","hasAttachments":false,"contactId":"3b30a108-9156-4a42-a893-3bbbe7af1ef8","contactName":"Xero","status":"AUTHORISED","lineAmountTypes":"Exclusive","lineItemDescription":"Monthly subscription","lineItemUnitAmount":29,"lineItemTaxType":"INPUT","lineAmount":29,"lineItemAccountCode":"412","lineItemQuantity":1,"lineItemId":"304e5b38-d62f-4c43-91d2-24786154c3c0","subTotal":2900,"totalTax":239,"total":3139,"currencyCode":"USD","recurrenceName":"412","endDate":"2022-07-28 00:00:00","lastSentDate":"2021-08-28 00:00:00","paidInvoicesTotal":1000,"unpaidInvoicesBalance":2139,"discount":412,"billingStreet":"123 lonecrest drive","billingStreet2":"412 fuller cres","billingCity":"Toronto","billingState":"Ontario","billingPostalCode":"H6F 3F6","billingCountry":"Canada","created":"2021-07-28 00:00:00","modified":"2021-09-15 00:00:00"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/repeating_invoices", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"01e01427-6b48-4d5f-aa2e-87c43f2a32a9\",\"period\":1,\"unit\":\"MONTHLY\",\"dueDate\":\"0\",\"dueDateType\":\"DAYSAFTERBILLDATE\",\"startDate\":\"2021-02-27 00:00:00\",\"nextScheduledDate\":\"2021-07-28 00:00:00\",\"type\":\"ACCPAY\",\"reference\":\"AP\",\"hasAttachments\":false,\"contactId\":\"3b30a108-9156-4a42-a893-3bbbe7af1ef8\",\"contactName\":\"Xero\",\"status\":\"AUTHORISED\",\"lineAmountTypes\":\"Exclusive\",\"lineItemDescription\":\"Monthly subscription\",\"lineItemUnitAmount\":29,\"lineItemTaxType\":\"INPUT\",\"lineAmount\":29,\"lineItemAccountCode\":\"412\",\"lineItemQuantity\":1,\"lineItemId\":\"304e5b38-d62f-4c43-91d2-24786154c3c0\",\"subTotal\":2900,\"totalTax\":239,\"total\":3139,\"currencyCode\":\"USD\",\"recurrenceName\":\"412\",\"endDate\":\"2022-07-28 00:00:00\",\"lastSentDate\":\"2021-08-28 00:00:00\",\"paidInvoicesTotal\":1000,\"unpaidInvoicesBalance\":2139,\"discount\":412,\"billingStreet\":\"123 lonecrest drive\",\"billingStreet2\":\"412 fuller cres\",\"billingCity\":\"Toronto\",\"billingState\":\"Ontario\",\"billingPostalCode\":\"H6F 3F6\",\"billingCountry\":\"Canada\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/repeating_invoices") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"01e01427-6b48-4d5f-aa2e-87c43f2a32a9\",\"period\":1,\"unit\":\"MONTHLY\",\"dueDate\":\"0\",\"dueDateType\":\"DAYSAFTERBILLDATE\",\"startDate\":\"2021-02-27 00:00:00\",\"nextScheduledDate\":\"2021-07-28 00:00:00\",\"type\":\"ACCPAY\",\"reference\":\"AP\",\"hasAttachments\":false,\"contactId\":\"3b30a108-9156-4a42-a893-3bbbe7af1ef8\",\"contactName\":\"Xero\",\"status\":\"AUTHORISED\",\"lineAmountTypes\":\"Exclusive\",\"lineItemDescription\":\"Monthly subscription\",\"lineItemUnitAmount\":29,\"lineItemTaxType\":\"INPUT\",\"lineAmount\":29,\"lineItemAccountCode\":\"412\",\"lineItemQuantity\":1,\"lineItemId\":\"304e5b38-d62f-4c43-91d2-24786154c3c0\",\"subTotal\":2900,\"totalTax\":239,\"total\":3139,\"currencyCode\":\"USD\",\"recurrenceName\":\"412\",\"endDate\":\"2022-07-28 00:00:00\",\"lastSentDate\":\"2021-08-28 00:00:00\",\"paidInvoicesTotal\":1000,\"unpaidInvoicesBalance\":2139,\"discount\":412,\"billingStreet\":\"123 lonecrest drive\",\"billingStreet2\":\"412 fuller cres\",\"billingCity\":\"Toronto\",\"billingState\":\"Ontario\",\"billingPostalCode\":\"H6F 3F6\",\"billingCountry\":\"Canada\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"01e01427-6b48-4d5f-aa2e-87c43f2a32a9\",\"period\":1,\"unit\":\"MONTHLY\",\"dueDate\":\"0\",\"dueDateType\":\"DAYSAFTERBILLDATE\",\"startDate\":\"2021-02-27 00:00:00\",\"nextScheduledDate\":\"2021-07-28 00:00:00\",\"type\":\"ACCPAY\",\"reference\":\"AP\",\"hasAttachments\":false,\"contactId\":\"3b30a108-9156-4a42-a893-3bbbe7af1ef8\",\"contactName\":\"Xero\",\"status\":\"AUTHORISED\",\"lineAmountTypes\":\"Exclusive\",\"lineItemDescription\":\"Monthly subscription\",\"lineItemUnitAmount\":29,\"lineItemTaxType\":\"INPUT\",\"lineAmount\":29,\"lineItemAccountCode\":\"412\",\"lineItemQuantity\":1,\"lineItemId\":\"304e5b38-d62f-4c43-91d2-24786154c3c0\",\"subTotal\":2900,\"totalTax\":239,\"total\":3139,\"currencyCode\":\"USD\",\"recurrenceName\":\"412\",\"endDate\":\"2022-07-28 00:00:00\",\"lastSentDate\":\"2021-08-28 00:00:00\",\"paidInvoicesTotal\":1000,\"unpaidInvoicesBalance\":2139,\"discount\":412,\"billingStreet\":\"123 lonecrest drive\",\"billingStreet2\":\"412 fuller cres\",\"billingCity\":\"Toronto\",\"billingState\":\"Ontario\",\"billingPostalCode\":\"H6F 3F6\",\"billingCountry\":\"Canada\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/repeating_invoices", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/repeating_invoices\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"01e01427-6b48-4d5f-aa2e-87c43f2a32a9\\\",\\\"period\\\":1,\\\"unit\\\":\\\"MONTHLY\\\",\\\"dueDate\\\":\\\"0\\\",\\\"dueDateType\\\":\\\"DAYSAFTERBILLDATE\\\",\\\"startDate\\\":\\\"2021-02-27 00:00:00\\\",\\\"nextScheduledDate\\\":\\\"2021-07-28 00:00:00\\\",\\\"type\\\":\\\"ACCPAY\\\",\\\"reference\\\":\\\"AP\\\",\\\"hasAttachments\\\":false,\\\"contactId\\\":\\\"3b30a108-9156-4a42-a893-3bbbe7af1ef8\\\",\\\"contactName\\\":\\\"Xero\\\",\\\"status\\\":\\\"AUTHORISED\\\",\\\"lineAmountTypes\\\":\\\"Exclusive\\\",\\\"lineItemDescription\\\":\\\"Monthly subscription\\\",\\\"lineItemUnitAmount\\\":29,\\\"lineItemTaxType\\\":\\\"INPUT\\\",\\\"lineAmount\\\":29,\\\"lineItemAccountCode\\\":\\\"412\\\",\\\"lineItemQuantity\\\":1,\\\"lineItemId\\\":\\\"304e5b38-d62f-4c43-91d2-24786154c3c0\\\",\\\"subTotal\\\":2900,\\\"totalTax\\\":239,\\\"total\\\":3139,\\\"currencyCode\\\":\\\"USD\\\",\\\"recurrenceName\\\":\\\"412\\\",\\\"endDate\\\":\\\"2022-07-28 00:00:00\\\",\\\"lastSentDate\\\":\\\"2021-08-28 00:00:00\\\",\\\"paidInvoicesTotal\\\":1000,\\\"unpaidInvoicesBalance\\\":2139,\\\"discount\\\":412,\\\"billingStreet\\\":\\\"123 lonecrest drive\\\",\\\"billingStreet2\\\":\\\"412 fuller cres\\\",\\\"billingCity\\\":\\\"Toronto\\\",\\\"billingState\\\":\\\"Ontario\\\",\\\"billingPostalCode\\\":\\\"H6F 3F6\\\",\\\"billingCountry\\\":\\\"Canada\\\",\\\"created\\\":\\\"2021-07-28 00:00:00\\\",\\\"modified\\\":\\\"2021-09-15 00:00:00\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/repeating_invoices", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"01e01427-6b48-4d5f-aa2e-87c43f2a32a9\",\"period\":1,\"unit\":\"MONTHLY\",\"dueDate\":\"0\",\"dueDateType\":\"DAYSAFTERBILLDATE\",\"startDate\":\"2021-02-27 00:00:00\",\"nextScheduledDate\":\"2021-07-28 00:00:00\",\"type\":\"ACCPAY\",\"reference\":\"AP\",\"hasAttachments\":false,\"contactId\":\"3b30a108-9156-4a42-a893-3bbbe7af1ef8\",\"contactName\":\"Xero\",\"status\":\"AUTHORISED\",\"lineAmountTypes\":\"Exclusive\",\"lineItemDescription\":\"Monthly subscription\",\"lineItemUnitAmount\":29,\"lineItemTaxType\":\"INPUT\",\"lineAmount\":29,\"lineItemAccountCode\":\"412\",\"lineItemQuantity\":1,\"lineItemId\":\"304e5b38-d62f-4c43-91d2-24786154c3c0\",\"subTotal\":2900,\"totalTax\":239,\"total\":3139,\"currencyCode\":\"USD\",\"recurrenceName\":\"412\",\"endDate\":\"2022-07-28 00:00:00\",\"lastSentDate\":\"2021-08-28 00:00:00\",\"paidInvoicesTotal\":1000,\"unpaidInvoicesBalance\":2139,\"discount\":412,\"billingStreet\":\"123 lonecrest drive\",\"billingStreet2\":\"412 fuller cres\",\"billingCity\":\"Toronto\",\"billingState\":\"Ontario\",\"billingPostalCode\":\"H6F 3F6\",\"billingCountry\":\"Canada\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/repeating_invoices", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '01e01427-6b48-4d5f-aa2e-87c43f2a32a9', period: 1, unit: 'MONTHLY', dueDate: '0', dueDateType: 'DAYSAFTERBILLDATE', startDate: '2021-02-27 00:00:00', nextScheduledDate: '2021-07-28 00:00:00', type: 'ACCPAY', reference: 'AP', hasAttachments: false, contactId: '3b30a108-9156-4a42-a893-3bbbe7af1ef8', contactName: 'Xero', status: 'AUTHORISED', lineAmountTypes: 'Exclusive', lineItemDescription: 'Monthly subscription', lineItemUnitAmount: 29, lineItemTaxType: 'INPUT', lineAmount: 29, lineItemAccountCode: '412', lineItemQuantity: 1, lineItemId: '304e5b38-d62f-4c43-91d2-24786154c3c0', subTotal: 2900, totalTax: 239, total: 3139, currencyCode: 'USD', recurrenceName: '412', endDate: '2022-07-28 00:00:00', lastSentDate: '2021-08-28 00:00:00', paidInvoicesTotal: 1000, unpaidInvoicesBalance: 2139, discount: 412, billingStreet: '123 lonecrest drive', billingStreet2: '412 fuller cres', billingCity: 'Toronto', billingState: 'Ontario', billingPostalCode: 'H6F 3F6', billingCountry: 'Canada', created: '2021-07-28 00:00:00', modified: '2021-09-15 00:00:00' })); req.end(); /repeating_invoices/{id}: parameters: [] get: tags: - RepeatingInvoice summary: Retrieves a RepeatingInvoice resource. operationId: RepeatingInvoice_getResource description: Retrieves a RepeatingInvoice resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: RepeatingInvoice resource content: application/json: schema: $ref: '#/components/schemas/RepeatingInvoiceGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/RepeatingInvoiceGetResource200Response' text/xml: schema: $ref: '#/components/schemas/RepeatingInvoiceGetResource200Response' text/csv: schema: $ref: '#/components/schemas/RepeatingInvoiceGetResource200Response' text/html: schema: $ref: '#/components/schemas/RepeatingInvoiceGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/repeating_invoices/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/repeating_invoices/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - RepeatingInvoice summary: Replaces the RepeatingInvoice resource. operationId: RepeatingInvoice_replaceResource description: Replaces the RepeatingInvoice resource. parameters: - description: Resource identifier name: id in: path 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/RepeatingInvoiceReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/RepeatingInvoiceReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/RepeatingInvoiceReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/RepeatingInvoiceReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/RepeatingInvoiceReplaceResourceRequest4' required: true responses: '200': description: RepeatingInvoice resource updated content: application/json: schema: $ref: '#/components/schemas/RepeatingInvoiceReplaceResourceResponse' application/xml: schema: $ref: >- #/components/schemas/RepeatingInvoiceReplaceResource200Response text/xml: schema: $ref: >- #/components/schemas/RepeatingInvoiceReplaceResource200Response text/csv: schema: $ref: >- #/components/schemas/RepeatingInvoiceReplaceResource200Response text/html: schema: $ref: >- #/components/schemas/RepeatingInvoiceReplaceResource200Response links: GetRepeatingInvoiceItem: operationId: getRepeatingInvoiceItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /repeating_invoices/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"01e01427-6b48-4d5f-aa2e-87c43f2a32a9\",\"period\":1,\"unit\":\"MONTHLY\",\"dueDate\":\"0\",\"dueDateType\":\"DAYSAFTERBILLDATE\",\"startDate\":\"2021-02-27 00:00:00\",\"nextScheduledDate\":\"2021-07-28 00:00:00\",\"type\":\"ACCPAY\",\"reference\":\"AP\",\"hasAttachments\":false,\"contactId\":\"3b30a108-9156-4a42-a893-3bbbe7af1ef8\",\"contactName\":\"Xero\",\"status\":\"AUTHORISED\",\"lineAmountTypes\":\"Exclusive\",\"lineItemDescription\":\"Monthly subscription\",\"lineItemUnitAmount\":29,\"lineItemTaxType\":\"INPUT\",\"lineAmount\":29,\"lineItemAccountCode\":\"412\",\"lineItemQuantity\":1,\"lineItemId\":\"304e5b38-d62f-4c43-91d2-24786154c3c0\",\"subTotal\":2900,\"totalTax\":239,\"total\":3139,\"currencyCode\":\"USD\",\"recurrenceName\":\"412\",\"endDate\":\"2022-07-28 00:00:00\",\"lastSentDate\":\"2021-08-28 00:00:00\",\"paidInvoicesTotal\":1000,\"unpaidInvoicesBalance\":2139,\"discount\":412,\"billingStreet\":\"123 lonecrest drive\",\"billingStreet2\":\"412 fuller cres\",\"billingCity\":\"Toronto\",\"billingState\":\"Ontario\",\"billingPostalCode\":\"H6F 3F6\",\"billingCountry\":\"Canada\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"01e01427-6b48-4d5f-aa2e-87c43f2a32a9\",\"period\":1,\"unit\":\"MONTHLY\",\"dueDate\":\"0\",\"dueDateType\":\"DAYSAFTERBILLDATE\",\"startDate\":\"2021-02-27 00:00:00\",\"nextScheduledDate\":\"2021-07-28 00:00:00\",\"type\":\"ACCPAY\",\"reference\":\"AP\",\"hasAttachments\":false,\"contactId\":\"3b30a108-9156-4a42-a893-3bbbe7af1ef8\",\"contactName\":\"Xero\",\"status\":\"AUTHORISED\",\"lineAmountTypes\":\"Exclusive\",\"lineItemDescription\":\"Monthly subscription\",\"lineItemUnitAmount\":29,\"lineItemTaxType\":\"INPUT\",\"lineAmount\":29,\"lineItemAccountCode\":\"412\",\"lineItemQuantity\":1,\"lineItemId\":\"304e5b38-d62f-4c43-91d2-24786154c3c0\",\"subTotal\":2900,\"totalTax\":239,\"total\":3139,\"currencyCode\":\"USD\",\"recurrenceName\":\"412\",\"endDate\":\"2022-07-28 00:00:00\",\"lastSentDate\":\"2021-08-28 00:00:00\",\"paidInvoicesTotal\":1000,\"unpaidInvoicesBalance\":2139,\"discount\":412,\"billingStreet\":\"123 lonecrest drive\",\"billingStreet2\":\"412 fuller cres\",\"billingCity\":\"Toronto\",\"billingState\":\"Ontario\",\"billingPostalCode\":\"H6F 3F6\",\"billingCountry\":\"Canada\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"01e01427-6b48-4d5f-aa2e-87c43f2a32a9","period":1,"unit":"MONTHLY","dueDate":"0","dueDateType":"DAYSAFTERBILLDATE","startDate":"2021-02-27 00:00:00","nextScheduledDate":"2021-07-28 00:00:00","type":"ACCPAY","reference":"AP","hasAttachments":false,"contactId":"3b30a108-9156-4a42-a893-3bbbe7af1ef8","contactName":"Xero","status":"AUTHORISED","lineAmountTypes":"Exclusive","lineItemDescription":"Monthly subscription","lineItemUnitAmount":29,"lineItemTaxType":"INPUT","lineAmount":29,"lineItemAccountCode":"412","lineItemQuantity":1,"lineItemId":"304e5b38-d62f-4c43-91d2-24786154c3c0","subTotal":2900,"totalTax":239,"total":3139,"currencyCode":"USD","recurrenceName":"412","endDate":"2022-07-28 00:00:00","lastSentDate":"2021-08-28 00:00:00","paidInvoicesTotal":1000,"unpaidInvoicesBalance":2139,"discount":412,"billingStreet":"123 lonecrest drive","billingStreet2":"412 fuller cres","billingCity":"Toronto","billingState":"Ontario","billingPostalCode":"H6F 3F6","billingCountry":"Canada","created":"2021-07-28 00:00:00","modified":"2021-09-15 00:00:00"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"01e01427-6b48-4d5f-aa2e-87c43f2a32a9\",\"period\":1,\"unit\":\"MONTHLY\",\"dueDate\":\"0\",\"dueDateType\":\"DAYSAFTERBILLDATE\",\"startDate\":\"2021-02-27 00:00:00\",\"nextScheduledDate\":\"2021-07-28 00:00:00\",\"type\":\"ACCPAY\",\"reference\":\"AP\",\"hasAttachments\":false,\"contactId\":\"3b30a108-9156-4a42-a893-3bbbe7af1ef8\",\"contactName\":\"Xero\",\"status\":\"AUTHORISED\",\"lineAmountTypes\":\"Exclusive\",\"lineItemDescription\":\"Monthly subscription\",\"lineItemUnitAmount\":29,\"lineItemTaxType\":\"INPUT\",\"lineAmount\":29,\"lineItemAccountCode\":\"412\",\"lineItemQuantity\":1,\"lineItemId\":\"304e5b38-d62f-4c43-91d2-24786154c3c0\",\"subTotal\":2900,\"totalTax\":239,\"total\":3139,\"currencyCode\":\"USD\",\"recurrenceName\":\"412\",\"endDate\":\"2022-07-28 00:00:00\",\"lastSentDate\":\"2021-08-28 00:00:00\",\"paidInvoicesTotal\":1000,\"unpaidInvoicesBalance\":2139,\"discount\":412,\"billingStreet\":\"123 lonecrest drive\",\"billingStreet2\":\"412 fuller cres\",\"billingCity\":\"Toronto\",\"billingState\":\"Ontario\",\"billingPostalCode\":\"H6F 3F6\",\"billingCountry\":\"Canada\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"01e01427-6b48-4d5f-aa2e-87c43f2a32a9\",\"period\":1,\"unit\":\"MONTHLY\",\"dueDate\":\"0\",\"dueDateType\":\"DAYSAFTERBILLDATE\",\"startDate\":\"2021-02-27 00:00:00\",\"nextScheduledDate\":\"2021-07-28 00:00:00\",\"type\":\"ACCPAY\",\"reference\":\"AP\",\"hasAttachments\":false,\"contactId\":\"3b30a108-9156-4a42-a893-3bbbe7af1ef8\",\"contactName\":\"Xero\",\"status\":\"AUTHORISED\",\"lineAmountTypes\":\"Exclusive\",\"lineItemDescription\":\"Monthly subscription\",\"lineItemUnitAmount\":29,\"lineItemTaxType\":\"INPUT\",\"lineAmount\":29,\"lineItemAccountCode\":\"412\",\"lineItemQuantity\":1,\"lineItemId\":\"304e5b38-d62f-4c43-91d2-24786154c3c0\",\"subTotal\":2900,\"totalTax\":239,\"total\":3139,\"currencyCode\":\"USD\",\"recurrenceName\":\"412\",\"endDate\":\"2022-07-28 00:00:00\",\"lastSentDate\":\"2021-08-28 00:00:00\",\"paidInvoicesTotal\":1000,\"unpaidInvoicesBalance\":2139,\"discount\":412,\"billingStreet\":\"123 lonecrest drive\",\"billingStreet2\":\"412 fuller cres\",\"billingCity\":\"Toronto\",\"billingState\":\"Ontario\",\"billingPostalCode\":\"H6F 3F6\",\"billingCountry\":\"Canada\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"01e01427-6b48-4d5f-aa2e-87c43f2a32a9\",\"period\":1,\"unit\":\"MONTHLY\",\"dueDate\":\"0\",\"dueDateType\":\"DAYSAFTERBILLDATE\",\"startDate\":\"2021-02-27 00:00:00\",\"nextScheduledDate\":\"2021-07-28 00:00:00\",\"type\":\"ACCPAY\",\"reference\":\"AP\",\"hasAttachments\":false,\"contactId\":\"3b30a108-9156-4a42-a893-3bbbe7af1ef8\",\"contactName\":\"Xero\",\"status\":\"AUTHORISED\",\"lineAmountTypes\":\"Exclusive\",\"lineItemDescription\":\"Monthly subscription\",\"lineItemUnitAmount\":29,\"lineItemTaxType\":\"INPUT\",\"lineAmount\":29,\"lineItemAccountCode\":\"412\",\"lineItemQuantity\":1,\"lineItemId\":\"304e5b38-d62f-4c43-91d2-24786154c3c0\",\"subTotal\":2900,\"totalTax\":239,\"total\":3139,\"currencyCode\":\"USD\",\"recurrenceName\":\"412\",\"endDate\":\"2022-07-28 00:00:00\",\"lastSentDate\":\"2021-08-28 00:00:00\",\"paidInvoicesTotal\":1000,\"unpaidInvoicesBalance\":2139,\"discount\":412,\"billingStreet\":\"123 lonecrest drive\",\"billingStreet2\":\"412 fuller cres\",\"billingCity\":\"Toronto\",\"billingState\":\"Ontario\",\"billingPostalCode\":\"H6F 3F6\",\"billingCountry\":\"Canada\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/repeating_invoices/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"01e01427-6b48-4d5f-aa2e-87c43f2a32a9\\\",\\\"period\\\":1,\\\"unit\\\":\\\"MONTHLY\\\",\\\"dueDate\\\":\\\"0\\\",\\\"dueDateType\\\":\\\"DAYSAFTERBILLDATE\\\",\\\"startDate\\\":\\\"2021-02-27 00:00:00\\\",\\\"nextScheduledDate\\\":\\\"2021-07-28 00:00:00\\\",\\\"type\\\":\\\"ACCPAY\\\",\\\"reference\\\":\\\"AP\\\",\\\"hasAttachments\\\":false,\\\"contactId\\\":\\\"3b30a108-9156-4a42-a893-3bbbe7af1ef8\\\",\\\"contactName\\\":\\\"Xero\\\",\\\"status\\\":\\\"AUTHORISED\\\",\\\"lineAmountTypes\\\":\\\"Exclusive\\\",\\\"lineItemDescription\\\":\\\"Monthly subscription\\\",\\\"lineItemUnitAmount\\\":29,\\\"lineItemTaxType\\\":\\\"INPUT\\\",\\\"lineAmount\\\":29,\\\"lineItemAccountCode\\\":\\\"412\\\",\\\"lineItemQuantity\\\":1,\\\"lineItemId\\\":\\\"304e5b38-d62f-4c43-91d2-24786154c3c0\\\",\\\"subTotal\\\":2900,\\\"totalTax\\\":239,\\\"total\\\":3139,\\\"currencyCode\\\":\\\"USD\\\",\\\"recurrenceName\\\":\\\"412\\\",\\\"endDate\\\":\\\"2022-07-28 00:00:00\\\",\\\"lastSentDate\\\":\\\"2021-08-28 00:00:00\\\",\\\"paidInvoicesTotal\\\":1000,\\\"unpaidInvoicesBalance\\\":2139,\\\"discount\\\":412,\\\"billingStreet\\\":\\\"123 lonecrest drive\\\",\\\"billingStreet2\\\":\\\"412 fuller cres\\\",\\\"billingCity\\\":\\\"Toronto\\\",\\\"billingState\\\":\\\"Ontario\\\",\\\"billingPostalCode\\\":\\\"H6F 3F6\\\",\\\"billingCountry\\\":\\\"Canada\\\",\\\"created\\\":\\\"2021-07-28 00:00:00\\\",\\\"modified\\\":\\\"2021-09-15 00:00:00\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"01e01427-6b48-4d5f-aa2e-87c43f2a32a9\",\"period\":1,\"unit\":\"MONTHLY\",\"dueDate\":\"0\",\"dueDateType\":\"DAYSAFTERBILLDATE\",\"startDate\":\"2021-02-27 00:00:00\",\"nextScheduledDate\":\"2021-07-28 00:00:00\",\"type\":\"ACCPAY\",\"reference\":\"AP\",\"hasAttachments\":false,\"contactId\":\"3b30a108-9156-4a42-a893-3bbbe7af1ef8\",\"contactName\":\"Xero\",\"status\":\"AUTHORISED\",\"lineAmountTypes\":\"Exclusive\",\"lineItemDescription\":\"Monthly subscription\",\"lineItemUnitAmount\":29,\"lineItemTaxType\":\"INPUT\",\"lineAmount\":29,\"lineItemAccountCode\":\"412\",\"lineItemQuantity\":1,\"lineItemId\":\"304e5b38-d62f-4c43-91d2-24786154c3c0\",\"subTotal\":2900,\"totalTax\":239,\"total\":3139,\"currencyCode\":\"USD\",\"recurrenceName\":\"412\",\"endDate\":\"2022-07-28 00:00:00\",\"lastSentDate\":\"2021-08-28 00:00:00\",\"paidInvoicesTotal\":1000,\"unpaidInvoicesBalance\":2139,\"discount\":412,\"billingStreet\":\"123 lonecrest drive\",\"billingStreet2\":\"412 fuller cres\",\"billingCity\":\"Toronto\",\"billingState\":\"Ontario\",\"billingPostalCode\":\"H6F 3F6\",\"billingCountry\":\"Canada\",\"created\":\"2021-07-28 00:00:00\",\"modified\":\"2021-09-15 00:00:00\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/repeating_invoices/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '01e01427-6b48-4d5f-aa2e-87c43f2a32a9', period: 1, unit: 'MONTHLY', dueDate: '0', dueDateType: 'DAYSAFTERBILLDATE', startDate: '2021-02-27 00:00:00', nextScheduledDate: '2021-07-28 00:00:00', type: 'ACCPAY', reference: 'AP', hasAttachments: false, contactId: '3b30a108-9156-4a42-a893-3bbbe7af1ef8', contactName: 'Xero', status: 'AUTHORISED', lineAmountTypes: 'Exclusive', lineItemDescription: 'Monthly subscription', lineItemUnitAmount: 29, lineItemTaxType: 'INPUT', lineAmount: 29, lineItemAccountCode: '412', lineItemQuantity: 1, lineItemId: '304e5b38-d62f-4c43-91d2-24786154c3c0', subTotal: 2900, totalTax: 239, total: 3139, currencyCode: 'USD', recurrenceName: '412', endDate: '2022-07-28 00:00:00', lastSentDate: '2021-08-28 00:00:00', paidInvoicesTotal: 1000, unpaidInvoicesBalance: 2139, discount: 412, billingStreet: '123 lonecrest drive', billingStreet2: '412 fuller cres', billingCity: 'Toronto', billingState: 'Ontario', billingPostalCode: 'H6F 3F6', billingCountry: 'Canada', created: '2021-07-28 00:00:00', modified: '2021-09-15 00:00:00' })); req.end(); delete: tags: - RepeatingInvoice summary: Removes the RepeatingInvoice resource. operationId: RepeatingInvoice_removeResource description: Removes the RepeatingInvoice resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: RepeatingInvoice resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/repeating_invoices/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/repeating_invoices/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/repeating_invoices/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /reports: parameters: [] get: tags: - Report summary: Retrieves the collection of Report resources. operationId: Report_getCollection description: Retrieves the collection of Report resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Report collection content: application/json: schema: $ref: '#/components/schemas/ReportGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/ReportGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/ReportGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/ReportGetCollection200Response' text/html: schema: $ref: '#/components/schemas/ReportGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/reports?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /reports/{id}: parameters: [] get: tags: - Report summary: Retrieves a Report resource. operationId: Report_getResource description: Retrieves a Report resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Report resource content: application/json: schema: $ref: '#/components/schemas/ReportGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/ReportGetResource200Response' text/xml: schema: $ref: '#/components/schemas/ReportGetResource200Response' text/csv: schema: $ref: '#/components/schemas/ReportGetResource200Response' text/html: schema: $ref: '#/components/schemas/ReportGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/reports/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/reports/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/reports/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/reports/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/reports/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/reports/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/reports/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/reports/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/reports/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /reservations: parameters: [] get: tags: - Reservation summary: Retrieves the collection of Reservation resources. operationId: Reservation_getCollection description: Retrieves the collection of Reservation resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Reservation collection content: application/json: schema: $ref: '#/components/schemas/ReservationGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/ReservationGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/ReservationGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/ReservationGetCollection200Response' text/html: schema: $ref: '#/components/schemas/ReservationGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/reservations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/reservations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/reservations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/reservations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/reservations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/reservations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/reservations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/reservations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/reservations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /reservations/{id}: parameters: [] get: tags: - Reservation summary: Retrieves a Reservation resource. operationId: Reservation_getResource description: Retrieves a Reservation resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Reservation resource content: application/json: schema: $ref: '#/components/schemas/ReservationGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/ReservationGetResource200Response' text/xml: schema: $ref: '#/components/schemas/ReservationGetResource200Response' text/csv: schema: $ref: '#/components/schemas/ReservationGetResource200Response' text/html: schema: $ref: '#/components/schemas/ReservationGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/reservations/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/reservations/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/reservations/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/reservations/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/reservations/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/reservations/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/reservations/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/reservations/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/reservations/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /revenue_stats: parameters: [] get: tags: - RevenueStat summary: Retrieves the collection of RevenueStat resources. operationId: RevenueStat_getCollection description: Retrieves the collection of RevenueStat resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: RevenueStat collection content: application/json: schema: $ref: '#/components/schemas/RevenueStatGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/RevenueStatGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/RevenueStatGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/RevenueStatGetCollection200Response' text/html: schema: $ref: '#/components/schemas/RevenueStatGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/revenue_stats?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/revenue_stats?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/revenue_stats?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/revenue_stats?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/revenue_stats?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/revenue_stats?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/revenue_stats?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/revenue_stats?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/revenue_stats?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /revenue_stats/{id}: parameters: [] get: tags: - RevenueStat summary: Retrieves a RevenueStat resource. operationId: RevenueStat_getResource description: Retrieves a RevenueStat resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: RevenueStat resource content: application/json: schema: $ref: '#/components/schemas/RevenueStatGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/RevenueStatGetResource200Response' text/xml: schema: $ref: '#/components/schemas/RevenueStatGetResource200Response' text/csv: schema: $ref: '#/components/schemas/RevenueStatGetResource200Response' text/html: schema: $ref: '#/components/schemas/RevenueStatGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/revenue_stats/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/revenue_stats/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/revenue_stats/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/revenue_stats/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/revenue_stats/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/revenue_stats/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/revenue_stats/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/revenue_stats/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/revenue_stats/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /sales_orders: parameters: [] get: tags: - SalesOrder summary: Retrieves the collection of SalesOrder resources. operationId: SalesOrder_getCollection description: Retrieves the collection of SalesOrder resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: SalesOrder collection content: application/json: schema: $ref: '#/components/schemas/SalesOrderGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/SalesOrderGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/SalesOrderGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/SalesOrderGetCollection200Response' text/html: schema: $ref: '#/components/schemas/SalesOrderGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/sales_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/sales_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/sales_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/sales_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/sales_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/sales_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/sales_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/sales_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/sales_orders?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /sales_orders/{id}: parameters: [] get: tags: - SalesOrder summary: Retrieves a SalesOrder resource. operationId: SalesOrder_getResource description: Retrieves a SalesOrder resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: SalesOrder resource content: application/json: schema: $ref: '#/components/schemas/SalesOrderGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/SalesOrderGetResource200Response' text/xml: schema: $ref: '#/components/schemas/SalesOrderGetResource200Response' text/csv: schema: $ref: '#/components/schemas/SalesOrderGetResource200Response' text/html: schema: $ref: '#/components/schemas/SalesOrderGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/sales_orders/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/sales_orders/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/sales_orders/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/sales_orders/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/sales_orders/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/sales_orders/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/sales_orders/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/sales_orders/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/sales_orders/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /site_events: parameters: [] get: tags: - SiteEvent summary: Retrieves the collection of SiteEvent resources. operationId: SiteEvent_getCollection description: Retrieves the collection of SiteEvent resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: SiteEvent collection content: application/json: schema: $ref: '#/components/schemas/SiteEventGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/SiteEventGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/SiteEventGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/SiteEventGetCollection200Response' text/html: schema: $ref: '#/components/schemas/SiteEventGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/site_events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/site_events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/site_events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/site_events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/site_events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/site_events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/site_events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/site_events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/site_events?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /site_events/{id}: parameters: [] get: tags: - SiteEvent summary: Retrieves a SiteEvent resource. operationId: SiteEvent_getResource description: Retrieves a SiteEvent resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: SiteEvent resource content: application/json: schema: $ref: '#/components/schemas/SiteEventGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/SiteEventGetResource200Response' text/xml: schema: $ref: '#/components/schemas/SiteEventGetResource200Response' text/csv: schema: $ref: '#/components/schemas/SiteEventGetResource200Response' text/html: schema: $ref: '#/components/schemas/SiteEventGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/site_events/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/site_events/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/site_events/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/site_events/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/site_events/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/site_events/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/site_events/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/site_events/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/site_events/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /statements: parameters: [] get: tags: - Statement summary: Retrieves the collection of Statement resources. operationId: Statement_getCollection description: Retrieves the collection of Statement resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Statement collection content: application/json: schema: $ref: '#/components/schemas/StatementGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/StatementGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/StatementGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/StatementGetCollection200Response' text/html: schema: $ref: '#/components/schemas/StatementGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/statements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/statements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/statements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/statements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/statements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/statements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/statements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/statements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/statements?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /statements/{id}: parameters: [] get: tags: - Statement summary: Retrieves a Statement resource. operationId: Statement_getResource description: Retrieves a Statement resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Statement resource content: application/json: schema: $ref: '#/components/schemas/StatementGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/StatementGetResource200Response' text/xml: schema: $ref: '#/components/schemas/StatementGetResource200Response' text/csv: schema: $ref: '#/components/schemas/StatementGetResource200Response' text/html: schema: $ref: '#/components/schemas/StatementGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/statements/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/statements/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/statements/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/statements/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/statements/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/statements/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/statements/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/statements/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/statements/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /subscriber_locations: parameters: [] get: tags: - SubscriberLocation summary: Retrieves the collection of SubscriberLocation resources. operationId: SubscriberLocation_listRetrieval description: Retrieves the collection of SubscriberLocation resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: SubscriberLocation collection content: application/json: schema: $ref: '#/components/schemas/SubscriberLocationListRetrievalResponse' application/xml: schema: $ref: >- #/components/schemas/SubscriberLocationListRetrieval200Response text/xml: schema: $ref: >- #/components/schemas/SubscriberLocationListRetrieval200Response text/csv: schema: $ref: >- #/components/schemas/SubscriberLocationListRetrieval200Response text/html: schema: $ref: >- #/components/schemas/SubscriberLocationListRetrieval200Response deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/subscriber_locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/subscriber_locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/subscriber_locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/subscriber_locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/subscriber_locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/subscriber_locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/subscriber_locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/subscriber_locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/subscriber_locations?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /subscriber_locations/{id}: parameters: [] get: tags: - SubscriberLocation summary: Retrieves a SubscriberLocation resource. operationId: SubscriberLocation_getResource description: Retrieves a SubscriberLocation resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: SubscriberLocation resource content: application/json: schema: $ref: '#/components/schemas/SubscriberLocationGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/SubscriberLocationGetResource200Response' text/xml: schema: $ref: '#/components/schemas/SubscriberLocationGetResource200Response' text/csv: schema: $ref: '#/components/schemas/SubscriberLocationGetResource200Response' text/html: schema: $ref: '#/components/schemas/SubscriberLocationGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/subscriber_locations/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/subscriber_locations/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/subscriber_locations/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/subscriber_locations/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/subscriber_locations/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/subscriber_locations/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/subscriber_locations/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/subscriber_locations/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/subscriber_locations/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /subscriptions: parameters: [] get: tags: - Subscription summary: Retrieves the collection of Subscription resources. operationId: Subscription_getCollection description: Retrieves the collection of Subscription resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Subscription collection content: application/json: schema: $ref: '#/components/schemas/SubscriptionGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/SubscriptionGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/SubscriptionGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/SubscriptionGetCollection200Response' text/html: schema: $ref: '#/components/schemas/SubscriptionGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/subscriptions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/subscriptions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/subscriptions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/subscriptions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/subscriptions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/subscriptions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/subscriptions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/subscriptions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/subscriptions?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - Subscription summary: Creates a Subscription resource. operationId: Subscription_createResource description: Creates a Subscription resource. parameters: [] requestBody: description: The new Subscription resource content: application/json: schema: $ref: '#/components/schemas/SubscriptionCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/SubscriptionCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/SubscriptionCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/SubscriptionCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/SubscriptionCreateResourceRequest4' required: true responses: '201': description: Subscription resource created content: application/json: schema: $ref: '#/components/schemas/SubscriptionCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/SubscriptionCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/SubscriptionCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/SubscriptionCreateResource201Response' text/html: schema: $ref: '#/components/schemas/SubscriptionCreateResource201Response' links: GetSubscriptionItem: operationId: getSubscriptionItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /subscriptions/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":true,\"balance\":500045,\"totalRevenue\":387687,\"productPrice\":4999,\"currencyCode\":\"EUR\",\"currentPeriodStart\":\"1655792028\",\"currentPeriodEnd\":\"1653977628\",\"nextPeriodStart\":\"1653977628\",\"cancelAtEndOfPeriod\":true,\"signupId\":\"user123\",\"signupRevenue\":\"250\",\"couponCode\":\"PROMOCODE\",\"customerId\":\"123\",\"productId\":\"321\",\"creditCardId\":\"4250\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\",\"customerFirstName\":\"Jane\",\"customerLastName\":\"Doe\",\"startDate\":\"2013-11-18T02:17:40.080Z\",\"endDate\":\"2015-11-18T02:17:40.080Z\",\"planName\":\"Basic Plan\",\"activated\":\"Jan 23 2023\",\"remainingIntervals\":12,\"monthlyRevenue\":500000,\"netMonthlyRevenue\":300000,\"contractStartDate\":\"2013-11-18T02:17:40.080Z\",\"expiredTimestamp\":\"2013-11-18T02:17:40.080Z\",\"planInterval\":\"Monthly\",\"numOfIntervals\":12}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/subscriptions") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/subscriptions"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":true,\"balance\":500045,\"totalRevenue\":387687,\"productPrice\":4999,\"currencyCode\":\"EUR\",\"currentPeriodStart\":\"1655792028\",\"currentPeriodEnd\":\"1653977628\",\"nextPeriodStart\":\"1653977628\",\"cancelAtEndOfPeriod\":true,\"signupId\":\"user123\",\"signupRevenue\":\"250\",\"couponCode\":\"PROMOCODE\",\"customerId\":\"123\",\"productId\":\"321\",\"creditCardId\":\"4250\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\",\"customerFirstName\":\"Jane\",\"customerLastName\":\"Doe\",\"startDate\":\"2013-11-18T02:17:40.080Z\",\"endDate\":\"2015-11-18T02:17:40.080Z\",\"planName\":\"Basic Plan\",\"activated\":\"Jan 23 2023\",\"remainingIntervals\":12,\"monthlyRevenue\":500000,\"netMonthlyRevenue\":300000,\"contractStartDate\":\"2013-11-18T02:17:40.080Z\",\"expiredTimestamp\":\"2013-11-18T02:17:40.080Z\",\"planInterval\":\"Monthly\",\"numOfIntervals\":12}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/subscriptions \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"GH2JK-67283H-YW82KHX-2883KK-KS78S","status":true,"balance":500045,"totalRevenue":387687,"productPrice":4999,"currencyCode":"EUR","currentPeriodStart":"1655792028","currentPeriodEnd":"1653977628","nextPeriodStart":"1653977628","cancelAtEndOfPeriod":true,"signupId":"user123","signupRevenue":"250","couponCode":"PROMOCODE","customerId":"123","productId":"321","creditCardId":"4250","created":"2013-11-18T02:17:40.080Z","modified":"2013-11-18T02:17:40.080Z","customerFirstName":"Jane","customerLastName":"Doe","startDate":"2013-11-18T02:17:40.080Z","endDate":"2015-11-18T02:17:40.080Z","planName":"Basic Plan","activated":"Jan 23 2023","remainingIntervals":12,"monthlyRevenue":500000,"netMonthlyRevenue":300000,"contractStartDate":"2013-11-18T02:17:40.080Z","expiredTimestamp":"2013-11-18T02:17:40.080Z","planInterval":"Monthly","numOfIntervals":12}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/subscriptions", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":true,\"balance\":500045,\"totalRevenue\":387687,\"productPrice\":4999,\"currencyCode\":\"EUR\",\"currentPeriodStart\":\"1655792028\",\"currentPeriodEnd\":\"1653977628\",\"nextPeriodStart\":\"1653977628\",\"cancelAtEndOfPeriod\":true,\"signupId\":\"user123\",\"signupRevenue\":\"250\",\"couponCode\":\"PROMOCODE\",\"customerId\":\"123\",\"productId\":\"321\",\"creditCardId\":\"4250\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\",\"customerFirstName\":\"Jane\",\"customerLastName\":\"Doe\",\"startDate\":\"2013-11-18T02:17:40.080Z\",\"endDate\":\"2015-11-18T02:17:40.080Z\",\"planName\":\"Basic Plan\",\"activated\":\"Jan 23 2023\",\"remainingIntervals\":12,\"monthlyRevenue\":500000,\"netMonthlyRevenue\":300000,\"contractStartDate\":\"2013-11-18T02:17:40.080Z\",\"expiredTimestamp\":\"2013-11-18T02:17:40.080Z\",\"planInterval\":\"Monthly\",\"numOfIntervals\":12}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/subscriptions") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":true,\"balance\":500045,\"totalRevenue\":387687,\"productPrice\":4999,\"currencyCode\":\"EUR\",\"currentPeriodStart\":\"1655792028\",\"currentPeriodEnd\":\"1653977628\",\"nextPeriodStart\":\"1653977628\",\"cancelAtEndOfPeriod\":true,\"signupId\":\"user123\",\"signupRevenue\":\"250\",\"couponCode\":\"PROMOCODE\",\"customerId\":\"123\",\"productId\":\"321\",\"creditCardId\":\"4250\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\",\"customerFirstName\":\"Jane\",\"customerLastName\":\"Doe\",\"startDate\":\"2013-11-18T02:17:40.080Z\",\"endDate\":\"2015-11-18T02:17:40.080Z\",\"planName\":\"Basic Plan\",\"activated\":\"Jan 23 2023\",\"remainingIntervals\":12,\"monthlyRevenue\":500000,\"netMonthlyRevenue\":300000,\"contractStartDate\":\"2013-11-18T02:17:40.080Z\",\"expiredTimestamp\":\"2013-11-18T02:17:40.080Z\",\"planInterval\":\"Monthly\",\"numOfIntervals\":12}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":true,\"balance\":500045,\"totalRevenue\":387687,\"productPrice\":4999,\"currencyCode\":\"EUR\",\"currentPeriodStart\":\"1655792028\",\"currentPeriodEnd\":\"1653977628\",\"nextPeriodStart\":\"1653977628\",\"cancelAtEndOfPeriod\":true,\"signupId\":\"user123\",\"signupRevenue\":\"250\",\"couponCode\":\"PROMOCODE\",\"customerId\":\"123\",\"productId\":\"321\",\"creditCardId\":\"4250\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\",\"customerFirstName\":\"Jane\",\"customerLastName\":\"Doe\",\"startDate\":\"2013-11-18T02:17:40.080Z\",\"endDate\":\"2015-11-18T02:17:40.080Z\",\"planName\":\"Basic Plan\",\"activated\":\"Jan 23 2023\",\"remainingIntervals\":12,\"monthlyRevenue\":500000,\"netMonthlyRevenue\":300000,\"contractStartDate\":\"2013-11-18T02:17:40.080Z\",\"expiredTimestamp\":\"2013-11-18T02:17:40.080Z\",\"planInterval\":\"Monthly\",\"numOfIntervals\":12}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/subscriptions", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/subscriptions\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"GH2JK-67283H-YW82KHX-2883KK-KS78S\\\",\\\"status\\\":true,\\\"balance\\\":500045,\\\"totalRevenue\\\":387687,\\\"productPrice\\\":4999,\\\"currencyCode\\\":\\\"EUR\\\",\\\"currentPeriodStart\\\":\\\"1655792028\\\",\\\"currentPeriodEnd\\\":\\\"1653977628\\\",\\\"nextPeriodStart\\\":\\\"1653977628\\\",\\\"cancelAtEndOfPeriod\\\":true,\\\"signupId\\\":\\\"user123\\\",\\\"signupRevenue\\\":\\\"250\\\",\\\"couponCode\\\":\\\"PROMOCODE\\\",\\\"customerId\\\":\\\"123\\\",\\\"productId\\\":\\\"321\\\",\\\"creditCardId\\\":\\\"4250\\\",\\\"created\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"modified\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"customerFirstName\\\":\\\"Jane\\\",\\\"customerLastName\\\":\\\"Doe\\\",\\\"startDate\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"endDate\\\":\\\"2015-11-18T02:17:40.080Z\\\",\\\"planName\\\":\\\"Basic Plan\\\",\\\"activated\\\":\\\"Jan 23 2023\\\",\\\"remainingIntervals\\\":12,\\\"monthlyRevenue\\\":500000,\\\"netMonthlyRevenue\\\":300000,\\\"contractStartDate\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"expiredTimestamp\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"planInterval\\\":\\\"Monthly\\\",\\\"numOfIntervals\\\":12}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/subscriptions", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":true,\"balance\":500045,\"totalRevenue\":387687,\"productPrice\":4999,\"currencyCode\":\"EUR\",\"currentPeriodStart\":\"1655792028\",\"currentPeriodEnd\":\"1653977628\",\"nextPeriodStart\":\"1653977628\",\"cancelAtEndOfPeriod\":true,\"signupId\":\"user123\",\"signupRevenue\":\"250\",\"couponCode\":\"PROMOCODE\",\"customerId\":\"123\",\"productId\":\"321\",\"creditCardId\":\"4250\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\",\"customerFirstName\":\"Jane\",\"customerLastName\":\"Doe\",\"startDate\":\"2013-11-18T02:17:40.080Z\",\"endDate\":\"2015-11-18T02:17:40.080Z\",\"planName\":\"Basic Plan\",\"activated\":\"Jan 23 2023\",\"remainingIntervals\":12,\"monthlyRevenue\":500000,\"netMonthlyRevenue\":300000,\"contractStartDate\":\"2013-11-18T02:17:40.080Z\",\"expiredTimestamp\":\"2013-11-18T02:17:40.080Z\",\"planInterval\":\"Monthly\",\"numOfIntervals\":12}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/subscriptions", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: 'GH2JK-67283H-YW82KHX-2883KK-KS78S', status: true, balance: 500045, totalRevenue: 387687, productPrice: 4999, currencyCode: 'EUR', currentPeriodStart: '1655792028', currentPeriodEnd: '1653977628', nextPeriodStart: '1653977628', cancelAtEndOfPeriod: true, signupId: 'user123', signupRevenue: '250', couponCode: 'PROMOCODE', customerId: '123', productId: '321', creditCardId: '4250', created: '2013-11-18T02:17:40.080Z', modified: '2013-11-18T02:17:40.080Z', customerFirstName: 'Jane', customerLastName: 'Doe', startDate: '2013-11-18T02:17:40.080Z', endDate: '2015-11-18T02:17:40.080Z', planName: 'Basic Plan', activated: 'Jan 23 2023', remainingIntervals: 12, monthlyRevenue: 500000, netMonthlyRevenue: 300000, contractStartDate: '2013-11-18T02:17:40.080Z', expiredTimestamp: '2013-11-18T02:17:40.080Z', planInterval: 'Monthly', numOfIntervals: 12 })); req.end(); /subscriptions/{id}: parameters: [] get: tags: - Subscription summary: Retrieves a Subscription resource. operationId: Subscription_getResource description: Retrieves a Subscription resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Subscription resource content: application/json: schema: $ref: '#/components/schemas/SubscriptionGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/SubscriptionGetResource200Response' text/xml: schema: $ref: '#/components/schemas/SubscriptionGetResource200Response' text/csv: schema: $ref: '#/components/schemas/SubscriptionGetResource200Response' text/html: schema: $ref: '#/components/schemas/SubscriptionGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/subscriptions/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/subscriptions/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/subscriptions/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/subscriptions/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/subscriptions/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/subscriptions/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/subscriptions/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/subscriptions/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/subscriptions/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - Subscription summary: Replaces the Subscription resource. operationId: Subscription_replaceResource description: Replaces the Subscription resource. parameters: - description: Resource identifier name: id in: path 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/SubscriptionReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/SubscriptionReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/SubscriptionReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/SubscriptionReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/SubscriptionReplaceResourceRequest4' required: true responses: '200': description: Subscription resource updated content: application/json: schema: $ref: '#/components/schemas/SubscriptionReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/SubscriptionReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/SubscriptionReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/SubscriptionReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/SubscriptionReplaceResource200Response' links: GetSubscriptionItem: operationId: getSubscriptionItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /subscriptions/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":true,\"balance\":500045,\"totalRevenue\":387687,\"productPrice\":4999,\"currencyCode\":\"EUR\",\"currentPeriodStart\":\"1655792028\",\"currentPeriodEnd\":\"1653977628\",\"nextPeriodStart\":\"1653977628\",\"cancelAtEndOfPeriod\":true,\"signupId\":\"user123\",\"signupRevenue\":\"250\",\"couponCode\":\"PROMOCODE\",\"customerId\":\"123\",\"productId\":\"321\",\"creditCardId\":\"4250\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\",\"customerFirstName\":\"Jane\",\"customerLastName\":\"Doe\",\"startDate\":\"2013-11-18T02:17:40.080Z\",\"endDate\":\"2015-11-18T02:17:40.080Z\",\"planName\":\"Basic Plan\",\"activated\":\"Jan 23 2023\",\"remainingIntervals\":12,\"monthlyRevenue\":500000,\"netMonthlyRevenue\":300000,\"contractStartDate\":\"2013-11-18T02:17:40.080Z\",\"expiredTimestamp\":\"2013-11-18T02:17:40.080Z\",\"planInterval\":\"Monthly\",\"numOfIntervals\":12}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/subscriptions/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/subscriptions/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":true,\"balance\":500045,\"totalRevenue\":387687,\"productPrice\":4999,\"currencyCode\":\"EUR\",\"currentPeriodStart\":\"1655792028\",\"currentPeriodEnd\":\"1653977628\",\"nextPeriodStart\":\"1653977628\",\"cancelAtEndOfPeriod\":true,\"signupId\":\"user123\",\"signupRevenue\":\"250\",\"couponCode\":\"PROMOCODE\",\"customerId\":\"123\",\"productId\":\"321\",\"creditCardId\":\"4250\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\",\"customerFirstName\":\"Jane\",\"customerLastName\":\"Doe\",\"startDate\":\"2013-11-18T02:17:40.080Z\",\"endDate\":\"2015-11-18T02:17:40.080Z\",\"planName\":\"Basic Plan\",\"activated\":\"Jan 23 2023\",\"remainingIntervals\":12,\"monthlyRevenue\":500000,\"netMonthlyRevenue\":300000,\"contractStartDate\":\"2013-11-18T02:17:40.080Z\",\"expiredTimestamp\":\"2013-11-18T02:17:40.080Z\",\"planInterval\":\"Monthly\",\"numOfIntervals\":12}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/subscriptions/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"GH2JK-67283H-YW82KHX-2883KK-KS78S","status":true,"balance":500045,"totalRevenue":387687,"productPrice":4999,"currencyCode":"EUR","currentPeriodStart":"1655792028","currentPeriodEnd":"1653977628","nextPeriodStart":"1653977628","cancelAtEndOfPeriod":true,"signupId":"user123","signupRevenue":"250","couponCode":"PROMOCODE","customerId":"123","productId":"321","creditCardId":"4250","created":"2013-11-18T02:17:40.080Z","modified":"2013-11-18T02:17:40.080Z","customerFirstName":"Jane","customerLastName":"Doe","startDate":"2013-11-18T02:17:40.080Z","endDate":"2015-11-18T02:17:40.080Z","planName":"Basic Plan","activated":"Jan 23 2023","remainingIntervals":12,"monthlyRevenue":500000,"netMonthlyRevenue":300000,"contractStartDate":"2013-11-18T02:17:40.080Z","expiredTimestamp":"2013-11-18T02:17:40.080Z","planInterval":"Monthly","numOfIntervals":12}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/subscriptions/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":true,\"balance\":500045,\"totalRevenue\":387687,\"productPrice\":4999,\"currencyCode\":\"EUR\",\"currentPeriodStart\":\"1655792028\",\"currentPeriodEnd\":\"1653977628\",\"nextPeriodStart\":\"1653977628\",\"cancelAtEndOfPeriod\":true,\"signupId\":\"user123\",\"signupRevenue\":\"250\",\"couponCode\":\"PROMOCODE\",\"customerId\":\"123\",\"productId\":\"321\",\"creditCardId\":\"4250\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\",\"customerFirstName\":\"Jane\",\"customerLastName\":\"Doe\",\"startDate\":\"2013-11-18T02:17:40.080Z\",\"endDate\":\"2015-11-18T02:17:40.080Z\",\"planName\":\"Basic Plan\",\"activated\":\"Jan 23 2023\",\"remainingIntervals\":12,\"monthlyRevenue\":500000,\"netMonthlyRevenue\":300000,\"contractStartDate\":\"2013-11-18T02:17:40.080Z\",\"expiredTimestamp\":\"2013-11-18T02:17:40.080Z\",\"planInterval\":\"Monthly\",\"numOfIntervals\":12}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/subscriptions/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":true,\"balance\":500045,\"totalRevenue\":387687,\"productPrice\":4999,\"currencyCode\":\"EUR\",\"currentPeriodStart\":\"1655792028\",\"currentPeriodEnd\":\"1653977628\",\"nextPeriodStart\":\"1653977628\",\"cancelAtEndOfPeriod\":true,\"signupId\":\"user123\",\"signupRevenue\":\"250\",\"couponCode\":\"PROMOCODE\",\"customerId\":\"123\",\"productId\":\"321\",\"creditCardId\":\"4250\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\",\"customerFirstName\":\"Jane\",\"customerLastName\":\"Doe\",\"startDate\":\"2013-11-18T02:17:40.080Z\",\"endDate\":\"2015-11-18T02:17:40.080Z\",\"planName\":\"Basic Plan\",\"activated\":\"Jan 23 2023\",\"remainingIntervals\":12,\"monthlyRevenue\":500000,\"netMonthlyRevenue\":300000,\"contractStartDate\":\"2013-11-18T02:17:40.080Z\",\"expiredTimestamp\":\"2013-11-18T02:17:40.080Z\",\"planInterval\":\"Monthly\",\"numOfIntervals\":12}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":true,\"balance\":500045,\"totalRevenue\":387687,\"productPrice\":4999,\"currencyCode\":\"EUR\",\"currentPeriodStart\":\"1655792028\",\"currentPeriodEnd\":\"1653977628\",\"nextPeriodStart\":\"1653977628\",\"cancelAtEndOfPeriod\":true,\"signupId\":\"user123\",\"signupRevenue\":\"250\",\"couponCode\":\"PROMOCODE\",\"customerId\":\"123\",\"productId\":\"321\",\"creditCardId\":\"4250\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\",\"customerFirstName\":\"Jane\",\"customerLastName\":\"Doe\",\"startDate\":\"2013-11-18T02:17:40.080Z\",\"endDate\":\"2015-11-18T02:17:40.080Z\",\"planName\":\"Basic Plan\",\"activated\":\"Jan 23 2023\",\"remainingIntervals\":12,\"monthlyRevenue\":500000,\"netMonthlyRevenue\":300000,\"contractStartDate\":\"2013-11-18T02:17:40.080Z\",\"expiredTimestamp\":\"2013-11-18T02:17:40.080Z\",\"planInterval\":\"Monthly\",\"numOfIntervals\":12}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/subscriptions/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/subscriptions/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"GH2JK-67283H-YW82KHX-2883KK-KS78S\\\",\\\"status\\\":true,\\\"balance\\\":500045,\\\"totalRevenue\\\":387687,\\\"productPrice\\\":4999,\\\"currencyCode\\\":\\\"EUR\\\",\\\"currentPeriodStart\\\":\\\"1655792028\\\",\\\"currentPeriodEnd\\\":\\\"1653977628\\\",\\\"nextPeriodStart\\\":\\\"1653977628\\\",\\\"cancelAtEndOfPeriod\\\":true,\\\"signupId\\\":\\\"user123\\\",\\\"signupRevenue\\\":\\\"250\\\",\\\"couponCode\\\":\\\"PROMOCODE\\\",\\\"customerId\\\":\\\"123\\\",\\\"productId\\\":\\\"321\\\",\\\"creditCardId\\\":\\\"4250\\\",\\\"created\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"modified\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"customerFirstName\\\":\\\"Jane\\\",\\\"customerLastName\\\":\\\"Doe\\\",\\\"startDate\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"endDate\\\":\\\"2015-11-18T02:17:40.080Z\\\",\\\"planName\\\":\\\"Basic Plan\\\",\\\"activated\\\":\\\"Jan 23 2023\\\",\\\"remainingIntervals\\\":12,\\\"monthlyRevenue\\\":500000,\\\"netMonthlyRevenue\\\":300000,\\\"contractStartDate\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"expiredTimestamp\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"planInterval\\\":\\\"Monthly\\\",\\\"numOfIntervals\\\":12}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/subscriptions/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"status\":true,\"balance\":500045,\"totalRevenue\":387687,\"productPrice\":4999,\"currencyCode\":\"EUR\",\"currentPeriodStart\":\"1655792028\",\"currentPeriodEnd\":\"1653977628\",\"nextPeriodStart\":\"1653977628\",\"cancelAtEndOfPeriod\":true,\"signupId\":\"user123\",\"signupRevenue\":\"250\",\"couponCode\":\"PROMOCODE\",\"customerId\":\"123\",\"productId\":\"321\",\"creditCardId\":\"4250\",\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-18T02:17:40.080Z\",\"customerFirstName\":\"Jane\",\"customerLastName\":\"Doe\",\"startDate\":\"2013-11-18T02:17:40.080Z\",\"endDate\":\"2015-11-18T02:17:40.080Z\",\"planName\":\"Basic Plan\",\"activated\":\"Jan 23 2023\",\"remainingIntervals\":12,\"monthlyRevenue\":500000,\"netMonthlyRevenue\":300000,\"contractStartDate\":\"2013-11-18T02:17:40.080Z\",\"expiredTimestamp\":\"2013-11-18T02:17:40.080Z\",\"planInterval\":\"Monthly\",\"numOfIntervals\":12}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/subscriptions/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: 'GH2JK-67283H-YW82KHX-2883KK-KS78S', status: true, balance: 500045, totalRevenue: 387687, productPrice: 4999, currencyCode: 'EUR', currentPeriodStart: '1655792028', currentPeriodEnd: '1653977628', nextPeriodStart: '1653977628', cancelAtEndOfPeriod: true, signupId: 'user123', signupRevenue: '250', couponCode: 'PROMOCODE', customerId: '123', productId: '321', creditCardId: '4250', created: '2013-11-18T02:17:40.080Z', modified: '2013-11-18T02:17:40.080Z', customerFirstName: 'Jane', customerLastName: 'Doe', startDate: '2013-11-18T02:17:40.080Z', endDate: '2015-11-18T02:17:40.080Z', planName: 'Basic Plan', activated: 'Jan 23 2023', remainingIntervals: 12, monthlyRevenue: 500000, netMonthlyRevenue: 300000, contractStartDate: '2013-11-18T02:17:40.080Z', expiredTimestamp: '2013-11-18T02:17:40.080Z', planInterval: 'Monthly', numOfIntervals: 12 })); req.end(); delete: tags: - Subscription summary: Removes the Subscription resource. operationId: Subscription_removeResource description: Removes the Subscription resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: Subscription resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/subscriptions/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/subscriptions/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/subscriptions/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/subscriptions/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/subscriptions/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/subscriptions/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/subscriptions/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/subscriptions/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/subscriptions/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /support_tickets: parameters: [] get: tags: - SupportTicket summary: Retrieves the collection of SupportTicket resources. operationId: SupportTicket_getCollection description: Retrieves the collection of SupportTicket resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: SupportTicket collection content: application/json: schema: $ref: '#/components/schemas/SupportTicketGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/SupportTicketGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/SupportTicketGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/SupportTicketGetCollection200Response' text/html: schema: $ref: '#/components/schemas/SupportTicketGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/support_tickets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/support_tickets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/support_tickets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/support_tickets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/support_tickets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/support_tickets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/support_tickets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/support_tickets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/support_tickets?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /support_tickets/{id}: parameters: [] get: tags: - SupportTicket summary: Retrieves a SupportTicket resource. operationId: SupportTicket_getResource description: Retrieves a SupportTicket resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: SupportTicket resource content: application/json: schema: $ref: '#/components/schemas/SupportTicketGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/SupportTicketGetResource200Response' text/xml: schema: $ref: '#/components/schemas/SupportTicketGetResource200Response' text/csv: schema: $ref: '#/components/schemas/SupportTicketGetResource200Response' text/html: schema: $ref: '#/components/schemas/SupportTicketGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/support_tickets/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/support_tickets/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/support_tickets/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/support_tickets/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/support_tickets/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/support_tickets/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/support_tickets/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/support_tickets/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/support_tickets/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /tasks: parameters: [] get: tags: - Task summary: Retrieves the collection of Task resources. operationId: Task_getCollection description: Retrieves the collection of Task resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Task collection content: application/json: schema: $ref: '#/components/schemas/TaskGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/TaskGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/TaskGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/TaskGetCollection200Response' text/html: schema: $ref: '#/components/schemas/TaskGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/tasks?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/tasks?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/tasks?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/tasks?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/tasks?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/tasks?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/tasks?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/tasks?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/tasks?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /tasks/{id}: parameters: [] get: tags: - Task summary: Retrieves a Task resource. operationId: Task_getById description: Retrieves a Task resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Task resource content: application/json: schema: $ref: '#/components/schemas/TaskGetByIdResponse' application/xml: schema: $ref: '#/components/schemas/TaskGetById200Response' text/xml: schema: $ref: '#/components/schemas/TaskGetById200Response' text/csv: schema: $ref: '#/components/schemas/TaskGetById200Response' text/html: schema: $ref: '#/components/schemas/TaskGetById200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/tasks/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/tasks/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/tasks/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/tasks/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/tasks/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/tasks/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/tasks/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/tasks/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/tasks/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /tax_agencies: parameters: [] get: tags: - TaxAgency summary: Retrieves the collection of TaxAgency resources. operationId: TaxAgency_getCollection description: Retrieves the collection of TaxAgency resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: TaxAgency collection content: application/json: schema: $ref: '#/components/schemas/TaxAgencyGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/TaxAgencyGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/TaxAgencyGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/TaxAgencyGetCollection200Response' text/html: schema: $ref: '#/components/schemas/TaxAgencyGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/tax_agencies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/tax_agencies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/tax_agencies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/tax_agencies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/tax_agencies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/tax_agencies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/tax_agencies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/tax_agencies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/tax_agencies?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /tax_agencies/{id}: parameters: [] get: tags: - TaxAgency summary: Retrieves a TaxAgency resource. operationId: TaxAgency_getResource description: Retrieves a TaxAgency resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: TaxAgency resource content: application/json: schema: $ref: '#/components/schemas/TaxAgencyGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/TaxAgencyGetResource200Response' text/xml: schema: $ref: '#/components/schemas/TaxAgencyGetResource200Response' text/csv: schema: $ref: '#/components/schemas/TaxAgencyGetResource200Response' text/html: schema: $ref: '#/components/schemas/TaxAgencyGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/tax_agencies/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/tax_agencies/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/tax_agencies/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/tax_agencies/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/tax_agencies/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/tax_agencies/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/tax_agencies/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/tax_agencies/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/tax_agencies/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /tax_rates: parameters: [] get: tags: - TaxRate summary: Retrieves the collection of TaxRate resources. operationId: TaxRate_getCollection description: Retrieves the collection of TaxRate resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: TaxRate collection content: application/json: schema: $ref: '#/components/schemas/TaxRateGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/TaxRateGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/TaxRateGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/TaxRateGetCollection200Response' text/html: schema: $ref: '#/components/schemas/TaxRateGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/tax_rates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/tax_rates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/tax_rates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/tax_rates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/tax_rates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/tax_rates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/tax_rates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/tax_rates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/tax_rates?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /tax_rates/{id}: parameters: [] get: tags: - TaxRate summary: Retrieves a TaxRate resource. operationId: TaxRate_getById description: Retrieves a TaxRate resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: TaxRate resource content: application/json: schema: $ref: '#/components/schemas/TaxRateGetByIdResponse' application/xml: schema: $ref: '#/components/schemas/TaxRateGetById200Response' text/xml: schema: $ref: '#/components/schemas/TaxRateGetById200Response' text/csv: schema: $ref: '#/components/schemas/TaxRateGetById200Response' text/html: schema: $ref: '#/components/schemas/TaxRateGetById200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/tax_rates/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/tax_rates/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/tax_rates/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/tax_rates/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/tax_rates/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/tax_rates/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/tax_rates/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/tax_rates/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/tax_rates/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /terms: parameters: [] get: tags: - Term summary: Retrieves the collection of Term resources. operationId: Term_getCollection description: Retrieves the collection of Term resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Term collection content: application/json: schema: $ref: '#/components/schemas/TermGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/TermGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/TermGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/TermGetCollection200Response' text/html: schema: $ref: '#/components/schemas/TermGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/terms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/terms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/terms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/terms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/terms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/terms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/terms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/terms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/terms?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /terms/{id}: parameters: [] get: tags: - Term summary: Retrieves a Term resource. operationId: Term_getResource description: Retrieves a Term resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Term resource content: application/json: schema: $ref: '#/components/schemas/TermGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/TermGetResource200Response' text/xml: schema: $ref: '#/components/schemas/TermGetResource200Response' text/csv: schema: $ref: '#/components/schemas/TermGetResource200Response' text/html: schema: $ref: '#/components/schemas/TermGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/terms/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/terms/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/terms/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/terms/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/terms/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/terms/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/terms/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/terms/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/terms/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /tracking_categories: parameters: [] get: tags: - TrackingCategory summary: Retrieves the collection of TrackingCategory resources. operationId: TrackingCategory_listResources description: Retrieves the collection of TrackingCategory resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: TrackingCategory collection content: application/json: schema: $ref: '#/components/schemas/TrackingCategoryListResourcesResponse' application/xml: schema: $ref: '#/components/schemas/TrackingCategoryListResources200Response' text/xml: schema: $ref: '#/components/schemas/TrackingCategoryListResources200Response' text/csv: schema: $ref: '#/components/schemas/TrackingCategoryListResources200Response' text/html: schema: $ref: '#/components/schemas/TrackingCategoryListResources200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/tracking_categories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/tracking_categories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/tracking_categories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/tracking_categories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/tracking_categories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/tracking_categories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/tracking_categories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/tracking_categories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/tracking_categories?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /tracking_categories/{id}: parameters: [] get: tags: - TrackingCategory summary: Retrieves a TrackingCategory resource. operationId: TrackingCategory_getResource description: Retrieves a TrackingCategory resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: TrackingCategory resource content: application/json: schema: $ref: '#/components/schemas/TrackingCategoryGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/TrackingCategoryGetResource200Response' text/xml: schema: $ref: '#/components/schemas/TrackingCategoryGetResource200Response' text/csv: schema: $ref: '#/components/schemas/TrackingCategoryGetResource200Response' text/html: schema: $ref: '#/components/schemas/TrackingCategoryGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/tracking_categories/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/tracking_categories/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/tracking_categories/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/tracking_categories/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/tracking_categories/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/tracking_categories/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/tracking_categories/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/tracking_categories/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/tracking_categories/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /transaction_match_report: parameters: [] get: tags: - TransactionMatchReport summary: >- Retrieves a transaction match report which includes a details array and a summary operationId: TransactionMatchReport_getReport description: Retrieves a TransactionMatchReport resource. parameters: - description: YYYY-MM-DD name: start in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-07-01' - description: YYYY-MM-DD name: end in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-08-31' - description: >- If refresh is set, data will be fetched from the source application even when cached data is available name: refresh in: query required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false example: 'true' responses: '200': description: TransactionMatchReport resource content: application/json: schema: $ref: '#/components/schemas/TransactionMatchReportGetReportResponse' application/xml: schema: $ref: >- #/components/schemas/TransactionMatchReportGetReport200Response text/xml: schema: $ref: >- #/components/schemas/TransactionMatchReportGetReport200Response text/csv: schema: $ref: >- #/components/schemas/TransactionMatchReportGetReport200Response text/html: schema: $ref: >- #/components/schemas/TransactionMatchReportGetReport200Response '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/transaction_match_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/transaction_match_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/transaction_match_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/transaction_match_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/transaction_match_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/transaction_match_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/transaction_match_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/transaction_match_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/transaction_match_report?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /transaction_match_series: parameters: [] get: tags: - TransactionMatchSeries summary: >- Retrieves a monthly series of transaction match reports which include details arrays and summaries operationId: TransactionMatchSeries_getMonthlySeries description: Retrieves a TransactionMatchSeries resource. parameters: - description: YYYY-MM-DD name: start in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-07-01' - description: YYYY-MM-DD name: end in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-08-31' - description: >- If refresh is set, data will be fetched from the source application even when cached data is available name: refresh in: query required: false deprecated: false allowEmptyValue: false schema: type: string style: form explode: false allowReserved: false example: 'true' responses: '200': description: TransactionMatchSeries resource content: application/json: schema: $ref: >- #/components/schemas/TransactionMatchSeriesGetMonthlySeriesResponse application/xml: schema: $ref: >- #/components/schemas/TransactionMatchSeriesGetMonthlySeries200Response text/xml: schema: $ref: >- #/components/schemas/TransactionMatchSeriesGetMonthlySeries200Response text/csv: schema: $ref: >- #/components/schemas/TransactionMatchSeriesGetMonthlySeries200Response text/html: schema: $ref: >- #/components/schemas/TransactionMatchSeriesGetMonthlySeries200Response '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/transaction_match_series?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/transaction_match_series?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/transaction_match_series?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/transaction_match_series?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/transaction_match_series?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/transaction_match_series?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/transaction_match_series?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/transaction_match_series?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/transaction_match_series?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&refresh=SOME_STRING_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /transactions: parameters: [] get: tags: - Transaction summary: Retrieves a Collection of transaction resources operationId: Transaction_getCollection description: Retrieves a Collection of transaction resources parameters: - description: YYYY-MM-DD name: start in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-07-01' - description: YYYY-MM-DD name: end in: query required: false deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-08-31' - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Transaction collection content: application/json: schema: $ref: '#/components/schemas/TransactionGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/TransactionGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/TransactionGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/TransactionGetCollection200Response' text/html: schema: $ref: '#/components/schemas/TransactionGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/transactions?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /transactions/{id}: parameters: [] get: tags: - Transaction summary: Retrieves a Transaction resource. operationId: Transaction_getResource description: Retrieves a Transaction resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Transaction resource content: application/json: schema: $ref: '#/components/schemas/TransactionGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/TransactionGetResource200Response' text/xml: schema: $ref: '#/components/schemas/TransactionGetResource200Response' text/csv: schema: $ref: '#/components/schemas/TransactionGetResource200Response' text/html: schema: $ref: '#/components/schemas/TransactionGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/transactions/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/transactions/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/transactions/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/transactions/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/transactions/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/transactions/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/transactions/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/transactions/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/transactions/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /trial_balances: parameters: [] get: tags: - TrialBalance summary: Retrieves a TrialBalance resource. operationId: TrialBalance_getResource description: Retrieves a TrialBalance resource. parameters: - description: YYYY-MM-DD name: end in: query required: true deprecated: false allowEmptyValue: false schema: type: string format: date-time style: form explode: false allowReserved: false example: '2022-11-30' - description: The Accounting Method name: accounting_method in: query required: true deprecated: false allowEmptyValue: false schema: type: string enum: - cash - accrual style: form explode: false allowReserved: false example: accrual responses: '200': description: TrialBalance resource content: application/json: schema: $ref: '#/components/schemas/TrialBalanceGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/TrialBalanceGetResource200Response' text/xml: schema: $ref: '#/components/schemas/TrialBalanceGetResource200Response' text/csv: schema: $ref: '#/components/schemas/TrialBalanceGetResource200Response' text/html: schema: $ref: '#/components/schemas/TrialBalanceGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/trial_balances?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/trial_balances?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/trial_balances?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/trial_balances?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/trial_balances?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/trial_balances?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/trial_balances?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/trial_balances?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/trial_balances?end=SOME_STRING_VALUE&accounting_method=SOME_STRING_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /unbilled_charges: parameters: [] get: tags: - UnbilledCharge summary: Retrieves the collection of UnbilledCharge resources. operationId: UnbilledCharge_listResources description: Retrieves the collection of UnbilledCharge resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: UnbilledCharge collection content: application/json: schema: $ref: '#/components/schemas/UnbilledChargeListResourcesResponse' application/xml: schema: $ref: '#/components/schemas/UnbilledChargeListResources200Response' text/xml: schema: $ref: '#/components/schemas/UnbilledChargeListResources200Response' text/csv: schema: $ref: '#/components/schemas/UnbilledChargeListResources200Response' text/html: schema: $ref: '#/components/schemas/UnbilledChargeListResources200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/unbilled_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/unbilled_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/unbilled_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/unbilled_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/unbilled_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/unbilled_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/unbilled_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/unbilled_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/unbilled_charges?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /unbilled_charges/{id}: parameters: [] get: tags: - UnbilledCharge summary: Retrieves a UnbilledCharge resource. operationId: UnbilledCharge_getResource description: Retrieves a UnbilledCharge resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: UnbilledCharge resource content: application/json: schema: $ref: '#/components/schemas/UnbilledChargeGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/UnbilledChargeGetResource200Response' text/xml: schema: $ref: '#/components/schemas/UnbilledChargeGetResource200Response' text/csv: schema: $ref: '#/components/schemas/UnbilledChargeGetResource200Response' text/html: schema: $ref: '#/components/schemas/UnbilledChargeGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/unbilled_charges/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/unbilled_charges/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/unbilled_charges/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/unbilled_charges/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/unbilled_charges/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/unbilled_charges/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/unbilled_charges/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/unbilled_charges/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/unbilled_charges/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /users: parameters: [] get: tags: - User summary: Retrieves the collection of User resources. operationId: User_getCollection description: Retrieves the collection of User resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: User collection content: application/json: schema: $ref: '#/components/schemas/UserGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/UserGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/UserGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/UserGetCollection200Response' text/html: schema: $ref: '#/components/schemas/UserGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/users?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/users?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/users?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/users?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/users?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/users?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/users?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/users?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/users?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /users/{id}: parameters: [] get: tags: - User summary: Retrieves a User resource. operationId: User_getResource description: Retrieves a User resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: User resource content: application/json: schema: $ref: '#/components/schemas/UserGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/UserGetResource200Response' text/xml: schema: $ref: '#/components/schemas/UserGetResource200Response' text/csv: schema: $ref: '#/components/schemas/UserGetResource200Response' text/html: schema: $ref: '#/components/schemas/UserGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/users/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/users/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/users/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/users/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/users/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/users/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/users/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/users/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/users/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /vendor_credits: parameters: [] get: tags: - VendorCredit summary: Retrieves the collection of VendorCredit resources. operationId: VendorCredit_getCollection description: Retrieves the collection of VendorCredit resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: VendorCredit collection content: application/json: schema: $ref: '#/components/schemas/VendorCreditGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/VendorCreditGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/VendorCreditGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/VendorCreditGetCollection200Response' text/html: schema: $ref: '#/components/schemas/VendorCreditGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/vendor_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/vendor_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/vendor_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/vendor_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/vendor_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/vendor_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/vendor_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/vendor_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/vendor_credits?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - VendorCredit summary: Creates a VendorCredit resource. operationId: VendorCredit_createResource description: Creates a VendorCredit resource. parameters: [] requestBody: description: The new VendorCredit resource content: application/json: schema: $ref: '#/components/schemas/VendorCreditCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/VendorCreditCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/VendorCreditCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/VendorCreditCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/VendorCreditCreateResourceRequest4' required: true responses: '201': description: VendorCredit resource created content: application/json: schema: $ref: '#/components/schemas/VendorCreditCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/VendorCreditCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/VendorCreditCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/VendorCreditCreateResource201Response' text/html: schema: $ref: '#/components/schemas/VendorCreditCreateResource201Response' links: GetVendorCreditItem: operationId: getVendorCreditItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /vendor_credits/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"3000000002075\",\"date\":\"2014-08-28\",\"status\":\"open\",\"vendorId\":\"460000000020029\",\"vendorName\":\"Bowman and Co\",\"currency\":\"USD\",\"subtotal\":3000,\"totalAmount\":3500,\"balance\":2150,\"created\":\"2014-08-28T22:53:31-0700\",\"modified\":\"2014-08-28T22:53:31-0700\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/vendor_credits") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/vendor_credits"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"3000000002075\",\"date\":\"2014-08-28\",\"status\":\"open\",\"vendorId\":\"460000000020029\",\"vendorName\":\"Bowman and Co\",\"currency\":\"USD\",\"subtotal\":3000,\"totalAmount\":3500,\"balance\":2150,\"created\":\"2014-08-28T22:53:31-0700\",\"modified\":\"2014-08-28T22:53:31-0700\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/vendor_credits \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"3000000002075","date":"2014-08-28","status":"open","vendorId":"460000000020029","vendorName":"Bowman and Co","currency":"USD","subtotal":3000,"totalAmount":3500,"balance":2150,"created":"2014-08-28T22:53:31-0700","modified":"2014-08-28T22:53:31-0700"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/vendor_credits", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"3000000002075\",\"date\":\"2014-08-28\",\"status\":\"open\",\"vendorId\":\"460000000020029\",\"vendorName\":\"Bowman and Co\",\"currency\":\"USD\",\"subtotal\":3000,\"totalAmount\":3500,\"balance\":2150,\"created\":\"2014-08-28T22:53:31-0700\",\"modified\":\"2014-08-28T22:53:31-0700\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/vendor_credits") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"3000000002075\",\"date\":\"2014-08-28\",\"status\":\"open\",\"vendorId\":\"460000000020029\",\"vendorName\":\"Bowman and Co\",\"currency\":\"USD\",\"subtotal\":3000,\"totalAmount\":3500,\"balance\":2150,\"created\":\"2014-08-28T22:53:31-0700\",\"modified\":\"2014-08-28T22:53:31-0700\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"3000000002075\",\"date\":\"2014-08-28\",\"status\":\"open\",\"vendorId\":\"460000000020029\",\"vendorName\":\"Bowman and Co\",\"currency\":\"USD\",\"subtotal\":3000,\"totalAmount\":3500,\"balance\":2150,\"created\":\"2014-08-28T22:53:31-0700\",\"modified\":\"2014-08-28T22:53:31-0700\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/vendor_credits", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/vendor_credits\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"3000000002075\\\",\\\"date\\\":\\\"2014-08-28\\\",\\\"status\\\":\\\"open\\\",\\\"vendorId\\\":\\\"460000000020029\\\",\\\"vendorName\\\":\\\"Bowman and Co\\\",\\\"currency\\\":\\\"USD\\\",\\\"subtotal\\\":3000,\\\"totalAmount\\\":3500,\\\"balance\\\":2150,\\\"created\\\":\\\"2014-08-28T22:53:31-0700\\\",\\\"modified\\\":\\\"2014-08-28T22:53:31-0700\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/vendor_credits", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"3000000002075\",\"date\":\"2014-08-28\",\"status\":\"open\",\"vendorId\":\"460000000020029\",\"vendorName\":\"Bowman and Co\",\"currency\":\"USD\",\"subtotal\":3000,\"totalAmount\":3500,\"balance\":2150,\"created\":\"2014-08-28T22:53:31-0700\",\"modified\":\"2014-08-28T22:53:31-0700\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/vendor_credits", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '3000000002075', date: '2014-08-28', status: 'open', vendorId: '460000000020029', vendorName: 'Bowman and Co', currency: 'USD', subtotal: 3000, totalAmount: 3500, balance: 2150, created: '2014-08-28T22:53:31-0700', modified: '2014-08-28T22:53:31-0700' })); req.end(); /vendor_credits/{id}: parameters: [] get: tags: - VendorCredit summary: Retrieves a VendorCredit resource. operationId: VendorCredit_getResource description: Retrieves a VendorCredit resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: VendorCredit resource content: application/json: schema: $ref: '#/components/schemas/VendorCreditGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/VendorCreditGetResource200Response' text/xml: schema: $ref: '#/components/schemas/VendorCreditGetResource200Response' text/csv: schema: $ref: '#/components/schemas/VendorCreditGetResource200Response' text/html: schema: $ref: '#/components/schemas/VendorCreditGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/vendor_credits/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/vendor_credits/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - VendorCredit summary: Replaces the VendorCredit resource. operationId: VendorCredit_replaceResource description: Replaces the VendorCredit resource. parameters: - description: Resource identifier name: id in: path 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/VendorCreditReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/VendorCreditReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/VendorCreditReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/VendorCreditReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/VendorCreditReplaceResourceRequest4' required: true responses: '200': description: VendorCredit resource updated content: application/json: schema: $ref: '#/components/schemas/VendorCreditReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/VendorCreditReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/VendorCreditReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/VendorCreditReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/VendorCreditReplaceResource200Response' links: GetVendorCreditItem: operationId: getVendorCreditItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /vendor_credits/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"3000000002075\",\"date\":\"2014-08-28\",\"status\":\"open\",\"vendorId\":\"460000000020029\",\"vendorName\":\"Bowman and Co\",\"currency\":\"USD\",\"subtotal\":3000,\"totalAmount\":3500,\"balance\":2150,\"created\":\"2014-08-28T22:53:31-0700\",\"modified\":\"2014-08-28T22:53:31-0700\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"3000000002075\",\"date\":\"2014-08-28\",\"status\":\"open\",\"vendorId\":\"460000000020029\",\"vendorName\":\"Bowman and Co\",\"currency\":\"USD\",\"subtotal\":3000,\"totalAmount\":3500,\"balance\":2150,\"created\":\"2014-08-28T22:53:31-0700\",\"modified\":\"2014-08-28T22:53:31-0700\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"3000000002075","date":"2014-08-28","status":"open","vendorId":"460000000020029","vendorName":"Bowman and Co","currency":"USD","subtotal":3000,"totalAmount":3500,"balance":2150,"created":"2014-08-28T22:53:31-0700","modified":"2014-08-28T22:53:31-0700"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"3000000002075\",\"date\":\"2014-08-28\",\"status\":\"open\",\"vendorId\":\"460000000020029\",\"vendorName\":\"Bowman and Co\",\"currency\":\"USD\",\"subtotal\":3000,\"totalAmount\":3500,\"balance\":2150,\"created\":\"2014-08-28T22:53:31-0700\",\"modified\":\"2014-08-28T22:53:31-0700\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"3000000002075\",\"date\":\"2014-08-28\",\"status\":\"open\",\"vendorId\":\"460000000020029\",\"vendorName\":\"Bowman and Co\",\"currency\":\"USD\",\"subtotal\":3000,\"totalAmount\":3500,\"balance\":2150,\"created\":\"2014-08-28T22:53:31-0700\",\"modified\":\"2014-08-28T22:53:31-0700\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"3000000002075\",\"date\":\"2014-08-28\",\"status\":\"open\",\"vendorId\":\"460000000020029\",\"vendorName\":\"Bowman and Co\",\"currency\":\"USD\",\"subtotal\":3000,\"totalAmount\":3500,\"balance\":2150,\"created\":\"2014-08-28T22:53:31-0700\",\"modified\":\"2014-08-28T22:53:31-0700\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/vendor_credits/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"3000000002075\\\",\\\"date\\\":\\\"2014-08-28\\\",\\\"status\\\":\\\"open\\\",\\\"vendorId\\\":\\\"460000000020029\\\",\\\"vendorName\\\":\\\"Bowman and Co\\\",\\\"currency\\\":\\\"USD\\\",\\\"subtotal\\\":3000,\\\"totalAmount\\\":3500,\\\"balance\\\":2150,\\\"created\\\":\\\"2014-08-28T22:53:31-0700\\\",\\\"modified\\\":\\\"2014-08-28T22:53:31-0700\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"3000000002075\",\"date\":\"2014-08-28\",\"status\":\"open\",\"vendorId\":\"460000000020029\",\"vendorName\":\"Bowman and Co\",\"currency\":\"USD\",\"subtotal\":3000,\"totalAmount\":3500,\"balance\":2150,\"created\":\"2014-08-28T22:53:31-0700\",\"modified\":\"2014-08-28T22:53:31-0700\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/vendor_credits/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '3000000002075', date: '2014-08-28', status: 'open', vendorId: '460000000020029', vendorName: 'Bowman and Co', currency: 'USD', subtotal: 3000, totalAmount: 3500, balance: 2150, created: '2014-08-28T22:53:31-0700', modified: '2014-08-28T22:53:31-0700' })); req.end(); delete: tags: - VendorCredit summary: Removes the VendorCredit resource. operationId: VendorCredit_removeResource description: Removes the VendorCredit resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: VendorCredit resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/vendor_credits/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/vendor_credits/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/vendor_credits/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /vendor_payments: parameters: [] get: tags: - VendorPayment summary: Retrieves the collection of VendorPayment resources. operationId: VendorPayment_getCollection description: Retrieves the collection of VendorPayment resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: VendorPayment collection content: application/json: schema: $ref: '#/components/schemas/VendorPaymentGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/VendorPaymentGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/VendorPaymentGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/VendorPaymentGetCollection200Response' text/html: schema: $ref: '#/components/schemas/VendorPaymentGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/vendor_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/vendor_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/vendor_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/vendor_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/vendor_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/vendor_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/vendor_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/vendor_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/vendor_payments?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - VendorPayment summary: Creates a VendorPayment resource. operationId: VendorPayment_createResource description: Creates a VendorPayment resource. parameters: [] requestBody: description: The new VendorPayment resource content: application/json: schema: $ref: '#/components/schemas/VendorPaymentCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/VendorPaymentCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/VendorPaymentCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/VendorPaymentCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/VendorPaymentCreateResourceRequest4' required: true responses: '201': description: VendorPayment resource created content: application/json: schema: $ref: '#/components/schemas/VendorPaymentCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/VendorPaymentCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/VendorPaymentCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/VendorPaymentCreateResource201Response' text/html: schema: $ref: '#/components/schemas/VendorPaymentCreateResource201Response' links: GetVendorPaymentItem: operationId: getVendorPaymentItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /vendor_payments/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"balance\":3500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/vendor_payments") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/vendor_payments"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"balance\":3500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/vendor_payments \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"460000000053219","vendorId":"460000000026049","vendorName":"Bowman and Co","paymentMode":"Stripe","txnDate":"2013-10-07","referenceNumber":"REF#912300","amount":12500,"balance":3500,"currency":"USD","created":"2016-12-16T00:18:42-0500","modified":"2016-12-16T00:18:42-0500"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/vendor_payments", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"balance\":3500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/vendor_payments") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"balance\":3500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"balance\":3500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/vendor_payments", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/vendor_payments\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"460000000053219\\\",\\\"vendorId\\\":\\\"460000000026049\\\",\\\"vendorName\\\":\\\"Bowman and Co\\\",\\\"paymentMode\\\":\\\"Stripe\\\",\\\"txnDate\\\":\\\"2013-10-07\\\",\\\"referenceNumber\\\":\\\"REF#912300\\\",\\\"amount\\\":12500,\\\"balance\\\":3500,\\\"currency\\\":\\\"USD\\\",\\\"created\\\":\\\"2016-12-16T00:18:42-0500\\\",\\\"modified\\\":\\\"2016-12-16T00:18:42-0500\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/vendor_payments", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"balance\":3500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/vendor_payments", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '460000000053219', vendorId: '460000000026049', vendorName: 'Bowman and Co', paymentMode: 'Stripe', txnDate: '2013-10-07', referenceNumber: 'REF#912300', amount: 12500, balance: 3500, currency: 'USD', created: '2016-12-16T00:18:42-0500', modified: '2016-12-16T00:18:42-0500' })); req.end(); /vendor_payments/{id}: parameters: [] get: tags: - VendorPayment summary: Retrieves a VendorPayment resource. operationId: VendorPayment_getResource description: Retrieves a VendorPayment resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: VendorPayment resource content: application/json: schema: $ref: '#/components/schemas/VendorPaymentGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/VendorPaymentGetResource200Response' text/xml: schema: $ref: '#/components/schemas/VendorPaymentGetResource200Response' text/csv: schema: $ref: '#/components/schemas/VendorPaymentGetResource200Response' text/html: schema: $ref: '#/components/schemas/VendorPaymentGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/vendor_payments/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/vendor_payments/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - VendorPayment summary: Replaces the VendorPayment resource. operationId: VendorPayment_replaceResource description: Replaces the VendorPayment resource. parameters: - description: Resource identifier name: id in: path 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/VendorPaymentReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/VendorPaymentReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/VendorPaymentReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/VendorPaymentReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/VendorPaymentReplaceResourceRequest4' required: true responses: '200': description: VendorPayment resource updated content: application/json: schema: $ref: '#/components/schemas/VendorPaymentReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/VendorPaymentReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/VendorPaymentReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/VendorPaymentReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/VendorPaymentReplaceResource200Response' links: GetVendorPaymentItem: operationId: getVendorPaymentItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /vendor_payments/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"balance\":3500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"balance\":3500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"460000000053219","vendorId":"460000000026049","vendorName":"Bowman and Co","paymentMode":"Stripe","txnDate":"2013-10-07","referenceNumber":"REF#912300","amount":12500,"balance":3500,"currency":"USD","created":"2016-12-16T00:18:42-0500","modified":"2016-12-16T00:18:42-0500"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"balance\":3500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"balance\":3500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"balance\":3500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/vendor_payments/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"460000000053219\\\",\\\"vendorId\\\":\\\"460000000026049\\\",\\\"vendorName\\\":\\\"Bowman and Co\\\",\\\"paymentMode\\\":\\\"Stripe\\\",\\\"txnDate\\\":\\\"2013-10-07\\\",\\\"referenceNumber\\\":\\\"REF#912300\\\",\\\"amount\\\":12500,\\\"balance\\\":3500,\\\"currency\\\":\\\"USD\\\",\\\"created\\\":\\\"2016-12-16T00:18:42-0500\\\",\\\"modified\\\":\\\"2016-12-16T00:18:42-0500\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"460000000053219\",\"vendorId\":\"460000000026049\",\"vendorName\":\"Bowman and Co\",\"paymentMode\":\"Stripe\",\"txnDate\":\"2013-10-07\",\"referenceNumber\":\"REF#912300\",\"amount\":12500,\"balance\":3500,\"currency\":\"USD\",\"created\":\"2016-12-16T00:18:42-0500\",\"modified\":\"2016-12-16T00:18:42-0500\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/vendor_payments/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: '460000000053219', vendorId: '460000000026049', vendorName: 'Bowman and Co', paymentMode: 'Stripe', txnDate: '2013-10-07', referenceNumber: 'REF#912300', amount: 12500, balance: 3500, currency: 'USD', created: '2016-12-16T00:18:42-0500', modified: '2016-12-16T00:18:42-0500' })); req.end(); delete: tags: - VendorPayment summary: Removes the VendorPayment resource. operationId: VendorPayment_removeResource description: Removes the VendorPayment resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: VendorPayment resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/vendor_payments/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/vendor_payments/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/vendor_payments/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /vendors: parameters: [] get: tags: - Vendor summary: Retrieves the collection of Vendor resources. operationId: Vendor_getCollection description: Retrieves the collection of Vendor resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Vendor collection content: application/json: schema: $ref: '#/components/schemas/VendorGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/VendorGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/VendorGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/VendorGetCollection200Response' text/html: schema: $ref: '#/components/schemas/VendorGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/vendors?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/vendors?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/vendors?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/vendors?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/vendors?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/vendors?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/vendors?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/vendors?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/vendors?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); post: tags: - Vendor summary: Creates a Vendor resource. operationId: Vendor_createResource description: Creates a Vendor resource. parameters: [] requestBody: description: The new Vendor resource content: application/json: schema: $ref: '#/components/schemas/VendorCreateResourceRequest' application/xml: schema: $ref: '#/components/schemas/VendorCreateResourceRequest1' text/xml: schema: $ref: '#/components/schemas/VendorCreateResourceRequest2' text/csv: schema: $ref: '#/components/schemas/VendorCreateResourceRequest3' text/html: schema: $ref: '#/components/schemas/VendorCreateResourceRequest4' required: true responses: '201': description: Vendor resource created content: application/json: schema: $ref: '#/components/schemas/VendorCreateResourceResponse' application/xml: schema: $ref: '#/components/schemas/VendorCreateResource201Response' text/xml: schema: $ref: '#/components/schemas/VendorCreateResource201Response' text/csv: schema: $ref: '#/components/schemas/VendorCreateResource201Response' text/html: schema: $ref: '#/components/schemas/VendorCreateResource201Response' links: GetVendorItem: operationId: getVendorItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /vendors/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Doyle-Koch LLC\",\"displayName\":\"Doyle-Koch\",\"contactName\":\"John Smith\",\"contactTitle\":\"Account Manager\",\"accountNumber\":\"420042\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"email\":\"doyle-koch@email.com\",\"website\":\"https://www.doylekoch.com\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"country\":\"United States\",\"postalCode\":\"99660\",\"currency\":\"USD\",\"balance\":650000,\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"notes\":\"Quality vendor\",\"taxType\":\"Global\",\"isContractor\":true,\"active\":true,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/vendors") .post(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/vendors"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Doyle-Koch LLC\",\"displayName\":\"Doyle-Koch\",\"contactName\":\"John Smith\",\"contactTitle\":\"Account Manager\",\"accountNumber\":\"420042\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"email\":\"doyle-koch@email.com\",\"website\":\"https://www.doylekoch.com\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"country\":\"United States\",\"postalCode\":\"99660\",\"currency\":\"USD\",\"balance\":650000,\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"notes\":\"Quality vendor\",\"taxType\":\"Global\",\"isContractor\":true,\"active\":true,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request POST \ --url https://example.myintranetapps.com/api/vendors \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"GH2JK-67283H-YW82KHX-2883KK-KS78S","givenName":"Jane","familyName":"Doe","companyName":"Doyle-Koch LLC","displayName":"Doyle-Koch","contactName":"John Smith","contactTitle":"Account Manager","accountNumber":"420042","phone":"281-381-4241","mobile":"786-258-0182","fax":"281-381-4255","email":"doyle-koch@email.com","website":"https://www.doylekoch.com","address":"708 Woodland Avenue","addressLine2":"Unit 105","city":"St Paul","state":"Alaska","country":"United States","postalCode":"99660","currency":"USD","balance":650000,"bankAccountName":"Business Bank Account","bankAccountNumber":"123654","notes":"Quality vendor","taxType":"Global","isContractor":true,"active":true,"created":"2013-11-18T02:17:40.080Z","modified":"2013-11-22T02:17:40.080Z","termId":"1d80716b-427e-4cad-80c6-c4b3a18eb23d","termDays":"15","termType":"DAYSAFTERBILLDATE"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/vendors", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Doyle-Koch LLC\",\"displayName\":\"Doyle-Koch\",\"contactName\":\"John Smith\",\"contactTitle\":\"Account Manager\",\"accountNumber\":\"420042\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"email\":\"doyle-koch@email.com\",\"website\":\"https://www.doylekoch.com\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"country\":\"United States\",\"postalCode\":\"99660\",\"currency\":\"USD\",\"balance\":650000,\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"notes\":\"Quality vendor\",\"taxType\":\"Global\",\"isContractor\":true,\"active\":true,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/vendors") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Doyle-Koch LLC\",\"displayName\":\"Doyle-Koch\",\"contactName\":\"John Smith\",\"contactTitle\":\"Account Manager\",\"accountNumber\":\"420042\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"email\":\"doyle-koch@email.com\",\"website\":\"https://www.doylekoch.com\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"country\":\"United States\",\"postalCode\":\"99660\",\"currency\":\"USD\",\"balance\":650000,\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"notes\":\"Quality vendor\",\"taxType\":\"Global\",\"isContractor\":true,\"active\":true,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Doyle-Koch LLC\",\"displayName\":\"Doyle-Koch\",\"contactName\":\"John Smith\",\"contactTitle\":\"Account Manager\",\"accountNumber\":\"420042\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"email\":\"doyle-koch@email.com\",\"website\":\"https://www.doylekoch.com\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"country\":\"United States\",\"postalCode\":\"99660\",\"currency\":\"USD\",\"balance\":650000,\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"notes\":\"Quality vendor\",\"taxType\":\"Global\",\"isContractor\":true,\"active\":true,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("POST", "/api/vendors", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/vendors\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"GH2JK-67283H-YW82KHX-2883KK-KS78S\\\",\\\"givenName\\\":\\\"Jane\\\",\\\"familyName\\\":\\\"Doe\\\",\\\"companyName\\\":\\\"Doyle-Koch LLC\\\",\\\"displayName\\\":\\\"Doyle-Koch\\\",\\\"contactName\\\":\\\"John Smith\\\",\\\"contactTitle\\\":\\\"Account Manager\\\",\\\"accountNumber\\\":\\\"420042\\\",\\\"phone\\\":\\\"281-381-4241\\\",\\\"mobile\\\":\\\"786-258-0182\\\",\\\"fax\\\":\\\"281-381-4255\\\",\\\"email\\\":\\\"doyle-koch@email.com\\\",\\\"website\\\":\\\"https://www.doylekoch.com\\\",\\\"address\\\":\\\"708 Woodland Avenue\\\",\\\"addressLine2\\\":\\\"Unit 105\\\",\\\"city\\\":\\\"St Paul\\\",\\\"state\\\":\\\"Alaska\\\",\\\"country\\\":\\\"United States\\\",\\\"postalCode\\\":\\\"99660\\\",\\\"currency\\\":\\\"USD\\\",\\\"balance\\\":650000,\\\"bankAccountName\\\":\\\"Business Bank Account\\\",\\\"bankAccountNumber\\\":\\\"123654\\\",\\\"notes\\\":\\\"Quality vendor\\\",\\\"taxType\\\":\\\"Global\\\",\\\"isContractor\\\":true,\\\"active\\\":true,\\\"created\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"modified\\\":\\\"2013-11-22T02:17:40.080Z\\\",\\\"termId\\\":\\\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\\\",\\\"termDays\\\":\\\"15\\\",\\\"termType\\\":\\\"DAYSAFTERBILLDATE\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/vendors", "method": "POST", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Doyle-Koch LLC\",\"displayName\":\"Doyle-Koch\",\"contactName\":\"John Smith\",\"contactTitle\":\"Account Manager\",\"accountNumber\":\"420042\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"email\":\"doyle-koch@email.com\",\"website\":\"https://www.doylekoch.com\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"country\":\"United States\",\"postalCode\":\"99660\",\"currency\":\"USD\",\"balance\":650000,\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"notes\":\"Quality vendor\",\"taxType\":\"Global\",\"isContractor\":true,\"active\":true,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "POST", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/vendors", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: 'GH2JK-67283H-YW82KHX-2883KK-KS78S', givenName: 'Jane', familyName: 'Doe', companyName: 'Doyle-Koch LLC', displayName: 'Doyle-Koch', contactName: 'John Smith', contactTitle: 'Account Manager', accountNumber: '420042', phone: '281-381-4241', mobile: '786-258-0182', fax: '281-381-4255', email: 'doyle-koch@email.com', website: 'https://www.doylekoch.com', address: '708 Woodland Avenue', addressLine2: 'Unit 105', city: 'St Paul', state: 'Alaska', country: 'United States', postalCode: '99660', currency: 'USD', balance: 650000, bankAccountName: 'Business Bank Account', bankAccountNumber: '123654', notes: 'Quality vendor', taxType: 'Global', isContractor: true, active: true, created: '2013-11-18T02:17:40.080Z', modified: '2013-11-22T02:17:40.080Z', termId: '1d80716b-427e-4cad-80c6-c4b3a18eb23d', termDays: '15', termType: 'DAYSAFTERBILLDATE' })); req.end(); /vendors/{id}: parameters: [] get: tags: - Vendor summary: Retrieves a Vendor resource. operationId: Vendor_getResource description: Retrieves a Vendor resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Vendor resource content: application/json: schema: $ref: '#/components/schemas/VendorGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/VendorGetResource200Response' text/xml: schema: $ref: '#/components/schemas/VendorGetResource200Response' text/csv: schema: $ref: '#/components/schemas/VendorGetResource200Response' text/html: schema: $ref: '#/components/schemas/VendorGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/vendors/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/vendors/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/vendors/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/vendors/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/vendors/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/vendors/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/vendors/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/vendors/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/vendors/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); put: tags: - Vendor summary: Replaces the Vendor resource. operationId: Vendor_replaceResource description: Replaces the Vendor resource. parameters: - description: Resource identifier name: id in: path 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/VendorReplaceResourceRequest' application/xml: schema: $ref: '#/components/schemas/VendorReplaceResourceRequest1' text/xml: schema: $ref: '#/components/schemas/VendorReplaceResourceRequest2' text/csv: schema: $ref: '#/components/schemas/VendorReplaceResourceRequest3' text/html: schema: $ref: '#/components/schemas/VendorReplaceResourceRequest4' required: true responses: '200': description: Vendor resource updated content: application/json: schema: $ref: '#/components/schemas/VendorReplaceResourceResponse' application/xml: schema: $ref: '#/components/schemas/VendorReplaceResource200Response' text/xml: schema: $ref: '#/components/schemas/VendorReplaceResource200Response' text/csv: schema: $ref: '#/components/schemas/VendorReplaceResource200Response' text/html: schema: $ref: '#/components/schemas/VendorReplaceResource200Response' links: GetVendorItem: operationId: getVendorItem description: >- The `id` value returned in the response can be used as the `id` parameter in `GET /vendors/{id}`. parameters: id: $response.body#/id '400': description: Invalid input '404': description: Resource not found '422': description: Unprocessable entity deprecated: false x-codeSamples: - lang: Java + Okhttp source: >- OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Doyle-Koch LLC\",\"displayName\":\"Doyle-Koch\",\"contactName\":\"John Smith\",\"contactTitle\":\"Account Manager\",\"accountNumber\":\"420042\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"email\":\"doyle-koch@email.com\",\"website\":\"https://www.doylekoch.com\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"country\":\"United States\",\"postalCode\":\"99660\",\"currency\":\"USD\",\"balance\":650000,\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"notes\":\"Quality vendor\",\"taxType\":\"Global\",\"isContractor\":true,\"active\":true,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}"); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/vendors/%7Bid%7D") .put(body) .addHeader("content-type", "text/html") .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/vendors/%7Bid%7D"); var request = new RestRequest(Method.PUT); request.AddHeader("content-type", "text/html"); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); request.AddParameter("text/html", "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Doyle-Koch LLC\",\"displayName\":\"Doyle-Koch\",\"contactName\":\"John Smith\",\"contactTitle\":\"Account Manager\",\"accountNumber\":\"420042\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"email\":\"doyle-koch@email.com\",\"website\":\"https://www.doylekoch.com\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"country\":\"United States\",\"postalCode\":\"99660\",\"currency\":\"USD\",\"balance\":650000,\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"notes\":\"Quality vendor\",\"taxType\":\"Global\",\"isContractor\":true,\"active\":true,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request PUT \ --url https://example.myintranetapps.com/api/vendors/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' \ --header 'content-type: text/html' \ --data '{"integration":"quickbooks","srcId":"GH2JK-67283H-YW82KHX-2883KK-KS78S","givenName":"Jane","familyName":"Doe","companyName":"Doyle-Koch LLC","displayName":"Doyle-Koch","contactName":"John Smith","contactTitle":"Account Manager","accountNumber":"420042","phone":"281-381-4241","mobile":"786-258-0182","fax":"281-381-4255","email":"doyle-koch@email.com","website":"https://www.doylekoch.com","address":"708 Woodland Avenue","addressLine2":"Unit 105","city":"St Paul","state":"Alaska","country":"United States","postalCode":"99660","currency":"USD","balance":650000,"bankAccountName":"Business Bank Account","bankAccountNumber":"123654","notes":"Quality vendor","taxType":"Global","isContractor":true,"active":true,"created":"2013-11-18T02:17:40.080Z","modified":"2013-11-22T02:17:40.080Z","termId":"1d80716b-427e-4cad-80c6-c4b3a18eb23d","termDays":"15","termType":"DAYSAFTERBILLDATE"}' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/vendors/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_POSTFIELDS => "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Doyle-Koch LLC\",\"displayName\":\"Doyle-Koch\",\"contactName\":\"John Smith\",\"contactTitle\":\"Account Manager\",\"accountNumber\":\"420042\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"email\":\"doyle-koch@email.com\",\"website\":\"https://www.doylekoch.com\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"country\":\"United States\",\"postalCode\":\"99660\",\"currency\":\"USD\",\"balance\":650000,\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"notes\":\"Quality vendor\",\"taxType\":\"Global\",\"isContractor\":true,\"active\":true,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH", "content-type: text/html" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/vendors/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'text/html' request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' request.body = "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Doyle-Koch LLC\",\"displayName\":\"Doyle-Koch\",\"contactName\":\"John Smith\",\"contactTitle\":\"Account Manager\",\"accountNumber\":\"420042\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"email\":\"doyle-koch@email.com\",\"website\":\"https://www.doylekoch.com\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"country\":\"United States\",\"postalCode\":\"99660\",\"currency\":\"USD\",\"balance\":650000,\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"notes\":\"Quality vendor\",\"taxType\":\"Global\",\"isContractor\":true,\"active\":true,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}" response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") payload = "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Doyle-Koch LLC\",\"displayName\":\"Doyle-Koch\",\"contactName\":\"John Smith\",\"contactTitle\":\"Account Manager\",\"accountNumber\":\"420042\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"email\":\"doyle-koch@email.com\",\"website\":\"https://www.doylekoch.com\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"country\":\"United States\",\"postalCode\":\"99660\",\"currency\":\"USD\",\"balance\":650000,\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"notes\":\"Quality vendor\",\"taxType\":\"Global\",\"isContractor\":true,\"active\":true,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}" headers = { 'content-type': "text/html", 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("PUT", "/api/vendors/%7Bid%7D", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/vendors/%7Bid%7D\"\n\n\tpayload := strings.NewReader(\"{\\\"integration\\\":\\\"quickbooks\\\",\\\"srcId\\\":\\\"GH2JK-67283H-YW82KHX-2883KK-KS78S\\\",\\\"givenName\\\":\\\"Jane\\\",\\\"familyName\\\":\\\"Doe\\\",\\\"companyName\\\":\\\"Doyle-Koch LLC\\\",\\\"displayName\\\":\\\"Doyle-Koch\\\",\\\"contactName\\\":\\\"John Smith\\\",\\\"contactTitle\\\":\\\"Account Manager\\\",\\\"accountNumber\\\":\\\"420042\\\",\\\"phone\\\":\\\"281-381-4241\\\",\\\"mobile\\\":\\\"786-258-0182\\\",\\\"fax\\\":\\\"281-381-4255\\\",\\\"email\\\":\\\"doyle-koch@email.com\\\",\\\"website\\\":\\\"https://www.doylekoch.com\\\",\\\"address\\\":\\\"708 Woodland Avenue\\\",\\\"addressLine2\\\":\\\"Unit 105\\\",\\\"city\\\":\\\"St Paul\\\",\\\"state\\\":\\\"Alaska\\\",\\\"country\\\":\\\"United States\\\",\\\"postalCode\\\":\\\"99660\\\",\\\"currency\\\":\\\"USD\\\",\\\"balance\\\":650000,\\\"bankAccountName\\\":\\\"Business Bank Account\\\",\\\"bankAccountNumber\\\":\\\"123654\\\",\\\"notes\\\":\\\"Quality vendor\\\",\\\"taxType\\\":\\\"Global\\\",\\\"isContractor\\\":true,\\\"active\\\":true,\\\"created\\\":\\\"2013-11-18T02:17:40.080Z\\\",\\\"modified\\\":\\\"2013-11-22T02:17:40.080Z\\\",\\\"termId\\\":\\\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\\\",\\\"termDays\\\":\\\"15\\\",\\\"termType\\\":\\\"DAYSAFTERBILLDATE\\\"}\")\n\n\treq, _ := http.NewRequest(\"PUT\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"text/html\")\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/vendors/%7Bid%7D", "method": "PUT", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" }, "processData": false, "data": "{\"integration\":\"quickbooks\",\"srcId\":\"GH2JK-67283H-YW82KHX-2883KK-KS78S\",\"givenName\":\"Jane\",\"familyName\":\"Doe\",\"companyName\":\"Doyle-Koch LLC\",\"displayName\":\"Doyle-Koch\",\"contactName\":\"John Smith\",\"contactTitle\":\"Account Manager\",\"accountNumber\":\"420042\",\"phone\":\"281-381-4241\",\"mobile\":\"786-258-0182\",\"fax\":\"281-381-4255\",\"email\":\"doyle-koch@email.com\",\"website\":\"https://www.doylekoch.com\",\"address\":\"708 Woodland Avenue\",\"addressLine2\":\"Unit 105\",\"city\":\"St Paul\",\"state\":\"Alaska\",\"country\":\"United States\",\"postalCode\":\"99660\",\"currency\":\"USD\",\"balance\":650000,\"bankAccountName\":\"Business Bank Account\",\"bankAccountNumber\":\"123654\",\"notes\":\"Quality vendor\",\"taxType\":\"Global\",\"isContractor\":true,\"active\":true,\"created\":\"2013-11-18T02:17:40.080Z\",\"modified\":\"2013-11-22T02:17:40.080Z\",\"termId\":\"1d80716b-427e-4cad-80c6-c4b3a18eb23d\",\"termDays\":\"15\",\"termType\":\"DAYSAFTERBILLDATE\"}" }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "PUT", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/vendors/%7Bid%7D", "headers": { "content-type": "text/html", "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ integration: 'quickbooks', srcId: 'GH2JK-67283H-YW82KHX-2883KK-KS78S', givenName: 'Jane', familyName: 'Doe', companyName: 'Doyle-Koch LLC', displayName: 'Doyle-Koch', contactName: 'John Smith', contactTitle: 'Account Manager', accountNumber: '420042', phone: '281-381-4241', mobile: '786-258-0182', fax: '281-381-4255', email: 'doyle-koch@email.com', website: 'https://www.doylekoch.com', address: '708 Woodland Avenue', addressLine2: 'Unit 105', city: 'St Paul', state: 'Alaska', country: 'United States', postalCode: '99660', currency: 'USD', balance: 650000, bankAccountName: 'Business Bank Account', bankAccountNumber: '123654', notes: 'Quality vendor', taxType: 'Global', isContractor: true, active: true, created: '2013-11-18T02:17:40.080Z', modified: '2013-11-22T02:17:40.080Z', termId: '1d80716b-427e-4cad-80c6-c4b3a18eb23d', termDays: '15', termType: 'DAYSAFTERBILLDATE' })); req.end(); delete: tags: - Vendor summary: Removes the Vendor resource. operationId: Vendor_removeResource description: Removes the Vendor resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '204': description: Vendor resource deleted '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/vendors/%7Bid%7D") .delete(null) .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/vendors/%7Bid%7D"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request DELETE \ --url https://example.myintranetapps.com/api/vendors/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/vendors/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "DELETE", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/vendors/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("DELETE", "/api/vendors/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/vendors/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"DELETE\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/vendors/%7Bid%7D", "method": "DELETE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "DELETE", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/vendors/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /workflows: parameters: [] get: tags: - Workflow summary: Retrieves the collection of Workflow resources. operationId: Workflow_getCollection description: Retrieves the collection of Workflow resources. parameters: - description: The collection page number name: page in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 1 style: form explode: false allowReserved: false - description: The number of items per page name: itemsPerPage in: query required: false deprecated: false allowEmptyValue: true schema: type: integer default: 100 minimum: 0 maximum: 200 style: form explode: false allowReserved: false responses: '200': description: Workflow collection content: application/json: schema: $ref: '#/components/schemas/WorkflowGetCollectionResponse' application/xml: schema: $ref: '#/components/schemas/WorkflowGetCollection200Response' text/xml: schema: $ref: '#/components/schemas/WorkflowGetCollection200Response' text/csv: schema: $ref: '#/components/schemas/WorkflowGetCollection200Response' text/html: schema: $ref: '#/components/schemas/WorkflowGetCollection200Response' deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/workflows?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/workflows?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url 'https://example.myintranetapps.com/api/workflows?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE' \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/workflows?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/workflows?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: >- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/workflows?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/workflows?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/workflows?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/workflows?page=SOME_INTEGER_VALUE&itemsPerPage=SOME_INTEGER_VALUE", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); /workflows/{id}: parameters: [] get: tags: - Workflow summary: Retrieves a Workflow resource. operationId: Workflow_getResource description: Retrieves a Workflow resource. parameters: - description: Resource identifier name: id in: path required: true deprecated: false allowEmptyValue: false schema: type: string style: simple explode: false allowReserved: false responses: '200': description: Workflow resource content: application/json: schema: $ref: '#/components/schemas/WorkflowGetResourceResponse' application/xml: schema: $ref: '#/components/schemas/WorkflowGetResource200Response' text/xml: schema: $ref: '#/components/schemas/WorkflowGetResource200Response' text/csv: schema: $ref: '#/components/schemas/WorkflowGetResource200Response' text/html: schema: $ref: '#/components/schemas/WorkflowGetResource200Response' '404': description: Resource not found deprecated: false x-codeSamples: - lang: Java + Okhttp source: |- OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.myintranetapps.com/api/workflows/%7Bid%7D") .get() .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH") .build(); Response response = client.newCall(request).execute(); - lang: Csharp + Restsharp source: >- var client = new RestClient("https://example.myintranetapps.com/api/workflows/%7Bid%7D"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH"); IRestResponse response = client.Execute(request); - lang: Shell + Curl source: |- curl --request GET \ --url https://example.myintranetapps.com/api/workflows/%7Bid%7D \ --header 'Authorization: Basic REPLACE_BASIC_AUTH' - lang: Php + Curl source: |- "https://example.myintranetapps.com/api/workflows/%7Bid%7D", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Basic REPLACE_BASIC_AUTH" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://example.myintranetapps.com/api/workflows/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Basic REPLACE_BASIC_AUTH' response = http.request(request) puts response.read_body - lang: Python + Python3 source: |- import http.client conn = http.client.HTTPSConnection("example.myintranetapps.com") headers = { 'Authorization': "Basic REPLACE_BASIC_AUTH" } conn.request("GET", "/api/workflows/%7Bid%7D", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) - lang: Go + Native source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://example.myintranetapps.com/api/workflows/%7Bid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"Basic REPLACE_BASIC_AUTH\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" - lang: Javascript + Jquery source: |- const settings = { "async": true, "crossDomain": true, "url": "https://example.myintranetapps.com/api/workflows/%7Bid%7D", "method": "GET", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; $.ajax(settings).done(function (response) { console.log(response); }); - lang: Node + Native source: |- const http = require("https"); const options = { "method": "GET", "hostname": "example.myintranetapps.com", "port": null, "path": "/api/workflows/%7Bid%7D", "headers": { "Authorization": "Basic REPLACE_BASIC_AUTH" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); components: parameters: {} responses: {} schemas: Account: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name AccountingTransaction: description: '' type: object properties: description: description: Transaction description type: string nullable: true id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-34" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string transactionId: description: |- Transaction type e.g. Payment type: string nullable: true transactionType: description: |- Transaction type e.g. Payment type: string nullable: true transactionNumber: description: |- Transaction number e.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 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 e.g: 870 type: integer nullable: true taxType: description: |- Amount of the transaction in cents e.g: 870 type: string nullable: true totalAmount: description: |- Amount of the transaction in cents e.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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: type: string date: type: string format: date-time nullable: true emailsSent: type: integer nullable: true totalItems: type: integer nullable: true AgedPayablesExcel: description: provides an excel workbook of an aged payables report type: object properties: asOf: example: This endpoint returns an .xlsx file. AgedPayablesReport: description: Provides an Aged Payables Report type: object properties: 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 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 sources: type: array items: type: string example: - xero AgedReceivablesExcel: description: provides an excel workbook of an aged receivables report type: object properties: file: example: This endpoint returns an .xlsx file. AgedReceivablesReport: description: Provides an Aged Receivables Report type: object properties: 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 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 sources: type: array items: type: string example: - xero ApplicationCharge: description: A one time charge within an application type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "pending" e.g. "accepted" e.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: description: >- Application credit represents credits issued to merchants that can be used towards future app purchases type: object properties: description: description: A description of the application credit type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false readOnly: true type: string srcId: description: Unique identifier for each application credit type: string amount: description: Amount refunded by the application credit type: integer Asset: description: '' type: object properties: description: description: Additional details about the asset type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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: description: >- Balance history represents charges that have contributed to the account balance e.g. charges & transfers type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.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 e.g. "available", "pending" type: string nullable: true balanceType: description: |- The type of transaction e.g. "Charge" e.g. "Refund" type: string nullable: true BalanceSheet: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string reportTitle: description: 'e.g: BalanceSheet' example: Balance Sheet nullable: true type: string companyName: description: 'e.g: the company legal name' example: Flux Capacitors Inc nullable: true 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: description: >- accounting method: a set of rules under which revenues and expenses are reported in financial statements e.g: cash example: cash nullable: false type: string start: description: start datetime of the balancesheet coverage example: '2021-01-01' nullable: true type: string format: date-time end: description: end datetime of the balancesheet coverage example: '2021-01-31' nullable: true type: string format: date-time currencyCode: example: USD nullable: true type: string totalAssets: description: Total assets in cents example: 2786282 nullable: true type: integer totalLiabilities: description: Total liabilities in cents example: 287622 nullable: true type: integer totalCurrentAssets: description: Total current assets in cents example: 89792 nullable: true type: integer totalCurrentLiabilities: description: Total current liabilities in cents example: 198339 nullable: true type: integer totalEquity: description: Total equity in cents example: 625282 nullable: true type: integer netIncome: type: integer nullable: true BalanceSheetExcel: description: provides an excel workbook of a series of mapped balance sheets type: object properties: file: example: This endpoint returns an .xlsx file. BalanceSheetReport: description: provides a mapped balance sheet type: object 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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string report_id: description: |- Report ID e.g: BankSummary readOnly: true type: string nullable: true name: description: |- Report Name e.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: description: >- Bank transaction represents spend and receive money transactions, overpayments and prepayments type: object properties: description: type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "RECEIVE" e.g. "RECEIVE-OVERPAYMENT" type: string nullable: true lineAmountTypes: description: |- The type of line amount e.g. "Exclusive" e.g. "Inclusive" e.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 e.g. "INPUT" e.g. "OUTPUT e.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 BankTransfer: description: The transfer of money from one bank account to another type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: >- Batch payment represents a single payment transaction that includes multiple bills or invoices type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "PAYBATCH" e.g. "RECBATCH" type: string nullable: true status: description: |- Status of the batch payment e.g. "authorised" e.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: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer BillPayment: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time Blog: description: A blog. type: object properties: description: description: A description of the blog type: string nullable: true id: type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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: description: A blog post. type: object properties: title: description: The title of the blog post type: string nullable: true id: type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string report_id: description: |- Report ID e.g: BudgetSummary readOnly: true type: string nullable: true name: description: |- Report name e.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: description: '' type: object properties: description: description: details about the call type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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: description: '' type: object properties: description: description: details about the campaign type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 e.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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: Charge represents charges made to a debit or credit card type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "succeeded" e.g. "pending" e.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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: type: string emailClient: type: string nullable: true numMembers: type: integer nullable: true totalItems: type: integer nullable: true Company: description: Company represents any type of organization type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: >- Contact groups represent contacts that are segmented into groups based on specific characteristics type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: '' type: object properties: description: description: additional details about the contract type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 status: description: |- status of the contract e.g: activated, draft type: string nullable: true Conversion: description: '' type: object properties: id: description: identifier readOnly: true 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: description: conversion processing status readOnly: true type: string file: description: name of file type: string CreditNote: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time Customer: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string CustomerOpeningBalance: description: '' type: object properties: description: description: A description of the opening balance type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 totalAmount: description: The total amount of the opening balance type: integer nullable: true currency: description: Currency of the account type: string nullable: true DataSync: description: '' type: object properties: message: type: string example: xero synced successfully Deal: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer Department: 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. type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: type: string directory: description: |- List the directory of the current department e.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: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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: description: >- Engagement represents CRM actions stored as notes, tasks, meetings and calls type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "MEETING" e.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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string estimateNumber: description: For searching estimates type: string nullable: true txnStatus: description: |- Transaction status e.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: description: '' type: object properties: title: description: title of the event type: string nullable: true description: description: details about the event type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: the unique identifier of the source 3rd party integration type: string 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 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 e.g. "SCHEDULED" e.g. "DONE" type: string nullable: true type: description: |- The type of event e.g. "CONTENT" e.g. "SOCIAL" type: string nullable: true url: description: Public url for the event type: string nullable: true ExecutiveSummary: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string report_id: description: |- Report ID e.g: ExecutiveSummary readOnly: true type: string nullable: true name: description: |- Report Name e.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: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean FinancialMapping: description: Accounting financial mapping type: object properties: id: {} account_id: readOnly: true account_type: readOnly: true period_id: readOnly: true created: {} modified: {} verified: {} accountId: {} accountType: {} periodId: {} FinancialPeriod: description: Accounting financial period type: object properties: id: {} name: {} start: {} integration: {} year_end: readOnly: true deleted: {} created: {} modified: {} yearEnd: {} Form: description: >- Forms are standard website forms that can be used to generate website leads. type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: '' type: object properties: formInput1: type: string example: value formInput2: type: string example: value formInput3: type: string example: value formInput4: type: string example: value GrowthHistory: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: provides a mapped balance sheet type: object properties: file: example: This endpoint returns an connected integrations Inventory: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} Invoice: description: A statement of the money due for goods or services; a bill. type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-34" example: quickbooks-34 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string additionalType: description: >- An additional type for the item. This is a relationship between something and a class that the thing is in. example: '' nullable: true type: string category: description: >- A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. example: Spare Parts Division nullable: true type: string confirmationNumber: description: a number that confirms the given order or payment has been received example: 2798-2929 nullable: true type: string customerId: description: party placing the order or paying the invoice example: '672' nullable: true type: string paymentMethod: description: the name of the credit card or other method of payment for the order example: PayPal nullable: true type: string paymentMethodId: description: >- An identifier for the method of payment used (e.g. the last 4 digits of the credit card). example: '3009' nullable: true type: string paymentDueDate: description: The date the payment is due example: '2020-10-22T19:30:17.697Z' nullable: true externalDocs: url: http://schema.org/DateTime type: string format: date-time provider: 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. example: Amazon nullable: true type: string potentialAction: description: >- indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role example: '' nullable: true type: string broker: 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. example: '' nullable: true type: string minimumPaymentDue: description: the minimum payment required at this time example: 2000 nullable: true type: integer accountId: description: the identifier for the account the payment will be applied to example: '127362' nullable: true type: string scheduledPaymentDate: description: the date the invoice is scheduled to be paid example: '2021-10-22T19:30:17.697Z' nullable: true externalDocs: url: http://schema.org/Date type: string format: date-time billingPeriod: description: >- the time interval used to compute the invoice in ISO 8601 duration format example: P0Y2M0DT12H30M5S nullable: true type: string status: description: the status of payment; whether the invoice has been paid or not example: PastDue nullable: true type: string paymentStatus: type: string nullable: true created: description: The date and time the invoice was first created example: '2020-09-07T19:58:50.550Z' nullable: true type: string format: date-time modified: description: The date and time the invoice was last updated example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time subtotal: description: Total payment amount, before tax example: 8750 nullable: true type: integer taxAmount: description: Tax amount example: 1225 nullable: true type: integer currencyCode: description: Currency code example: USD nullable: true type: string invoiceNumber: description: Invoice number example: BP-27719 nullable: true type: string amountPaid: description: Amount paid so far example: 0 nullable: true type: integer amountCredited: description: The amount remaining that is due example: 9975 nullable: true type: integer customerName: description: The customer's name example: Bobs Bait Shop nullable: true type: string customerMemo: example: >- It's a pleasure doing business with you. Remember, referrals are appreciated! nullable: true type: string billingEmail: description: The customer's email example: ben@arima.com nullable: true type: string billingAddressType: example: HOME nullable: true type: string billingAddressLine1: description: |- * @ApiProperty( swaggerContext={"example"="4567 Finch St.", "required"=false}, openapiContext={"example"="4567 Finch St.", "nullable"=true}) 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: description: the unique identifier of the source 3rd party integration example: '129' nullable: false type: string url: description: Invoice url example: https://bobsburger.com nullable: true type: string txnDate: description: Transaction date example: '2020-09-07T19:58:50.550Z' nullable: true type: string format: date-time jsonAddress: description: Billing address in json format example: '{}' nullable: true type: string subscriptionId: description: The ID of the subscription the invoice was prepared for example: '342' nullable: true type: string referenceNumber: description: Reference number of sale order example: B1-7855 nullable: true type: string balance: description: Ending customer balance after the invoice is finalized example: 9975 nullable: true type: integer accountName: description: The name of the business associated with the invoice example: Bills Bait Shop nullable: true type: string purchaseOrderNum: description: Purchase order number example: 342 nullable: true type: integer billingCountry: description: Billing address country example: United States nullable: true type: string totalAmount: description: Total amount of the invoice example: 9975 nullable: true type: integer billingState: description: State the billing address is addressed to example: CA nullable: true type: string shippingCountry: description: Country the shipping address is addressed to example: United States nullable: true type: string shippingState: description: State the shipping address is addressed to example: CA nullable: true type: string amountDue: description: The unpaid amount that is due on the invoice example: 6275 nullable: true type: integer InvoiceItem: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer Item: description: '' type: object properties: description: description: Description of item type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.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 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: description: >- Journal represents recorded transactions and adjustments to the 3rd party account type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: Journal Lines represent a single line of a larger Journal entity type: object properties: description: description: A description of line item type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "200" e.g. "SALES type: string nullable: true accountType: description: |- Type of account e.g. "BANK" e.g. "CURRENT" e.g. "CURRLIAB" type: string nullable: true accountName: description: Name of account 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: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LedgerAccountOpeningBalance: description: '' type: object properties: description: description: A description of the opening balance type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: Is ledger account debit or credit readOnly: true 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: description: '' type: object properties: description: description: Description of the ledger entry type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 ledgerAccount: description: Ledger account id type: string nullable: true LinkedTransaction: description: >- Linked transaction represent transactions that form part of a single scheme, arrangement or series of transactions between the same vendor and customer type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.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 e.g. "ACCPAY" e.g. "SPEND" type: string nullable: true Location: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string ManualJournal: description: Manual journal represents manually logged transactions type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "Inclusive" e.g. "Exclusive", e.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 e.g. "OUTPUT" e.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: description: provides a set of business metrics type: object 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: description: '' 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: '' current_ratio: description: '' 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: '' 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: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string OrderReturn: description: >- Order return represents the full or partial return of a number of order items type: object properties: description: description: A description of the order return type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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: description: '' type: object properties: description: description: Further details about the company example: Best burgers in the world nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: description: Company name example: Bobs Sandwiches nullable: false type: string legalName: description: legal name example: Bobs Sandwiches nullable: true type: string primaryPhone: description: Primary phone number of the company example: '4165769834' nullable: true type: string email: description: Primary email address associated to the company example: bobs.sandwiches@gmail.com nullable: true type: string addressLine1: description: Line1 address of the company example: 23 berkly street nullable: true type: string addressLine2: example: 45 portland road nullable: true type: string city: example: Toronto nullable: true type: string country: description: Country of the company location example: Canada nullable: true type: string postalCode: description: Postalcode of the company location example: H7F5R3 nullable: true 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: description: |- Type of the organization e.g: charity e.g: not_for_profit e.g: partnership example: charity nullable: true type: string employeeCount: description: Number of employees in the company example: 75 nullable: true type: integer website: description: Website address of the comapny example: bobssandwiches.com nullable: true type: string annualRevenue: example: '45000000000' nullable: true type: string industry: description: |- The industry company belongs to e.g: banking example: hospitality nullable: true type: string locationCount: description: Number of locations company has example: 4 nullable: true type: integer industryCode: description: NAICS/SIC industry code for the company example: '441221' nullable: true type: string organisationType: type: string nullable: true OtherIncome: description: '' type: object properties: description: type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: type: string totalAmount: type: integer currencyCode: type: string category: type: string nullable: true dateReceived: type: string format: date-time nullable: true paymentType: type: string nullable: true source: type: string created: type: string format: date-time modified: type: string format: date-time Owner: description: >- Owner represents accounts in the system that are able to view and edit customer information. type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PaymentIntent: description: >- Payment intent captures the process of collecting a payment from customers type: object properties: description: description: A description about the payment intent type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 e.g. "requires_payment_method" e.g. "requires_confirmation" e.g. "succeeded" type: string nullable: true PaymentMethod: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentService: description: Payment service represents services used that allow for online payments type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "AwesomePay" e.g. "CUSTOM type: string nullable: true Payout: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: |- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string Payroll: description: '' type: object properties: description: example: '' nullable: true 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 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: description: >- Plan represents the base price, currency and billing cycle for subscriptions type: object properties: description: description: plan description example: Monthly streaming subscription nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: true type: string isActive: example: true nullable: true type: boolean aggregateUsage: description: |- A usage aggregation strategy for metered usage plans e.g. "sum" e.g. "last_during_period" e.g. "max" example: sum nullable: true type: string amount: description: price of the plan example: 200 nullable: true type: integer billingScheme: description: |- Describes how to compute the price per period e.g. "per_unit" e.g. "tiered" example: per_unit nullable: true 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 productId: description: id for the plan example: '2' nullable: true type: string tiersMode: description: |- Defines if the tier pricing should be graduated or volume e.g. "graduated" e.g. "volume" example: volume nullable: true type: string transformUsage: description: Division transformation applied to the reported usage type: integer nullable: true usageType: description: |- Configures how the quantity per period should be determined e.g. "metered" e.g. "licensed" example: metered nullable: true type: string intervalCount: type: integer nullable: true trialPeriodDays: type: integer nullable: true Product: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string reportTitle: description: 'e.g: ProfitAndLoss' example: Profit and Loss Statement nullable: true type: string companyName: description: 'e.g: the company legal name' example: Flux Capacitors Inc nullable: true 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: description: >- accounting method: a set of rules under which revenues and expenses are reported in financial statements e.g: cash example: cash nullable: true 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: description: Total income in cents example: 786532 nullable: true type: integer totalExpenses: description: Total expenses in cents example: 756282 nullable: true type: integer ProfitAndLossExcel: description: provides an excel workbook of a series of mapped profit and loss reports type: object properties: file: example: This endpoint returns an .xlsx file. ProfitAndLossReport: description: provides a mapped profit and loss report type: object 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: 9X 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: 9X 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: 9X name: Sales value: 24500 mapping: Revenue - id: 17X 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: 9X 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: 9X 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: 9X 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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration eg. "460000000044019" type: string projectName: description: |- Name of the project eg. "REAL TIME TRAFFIC FLUX" type: string nullable: true customerId: description: |- Unique identifier for the customer eg. "460000000044001" type: string nullable: true customerName: description: |- Name of customer eg. "SAF Instruments Inc" type: string nullable: true currency: description: |- Currency eg. "USD" type: string nullable: true status: description: |- Status of project eg. "active" type: string nullable: true billingType: description: |- The way you bill your customer eg. fixed_cost_for_project, based_on_project_hours, based_on_staff_hours based_on_task_hours type: string nullable: true rate: description: |- Hourly rate for a task in cents eg. "5000" type: integer nullable: true totalHours: description: |- Total hours eg. "12.41" type: number nullable: true billableHours: description: |- Billable hours for the project eg. "12.41" type: number nullable: true created: description: |- Datetime when the project object was created eg. "2013-09-18 18:05:27" type: string format: date-time nullable: true modified: description: |- Datetime when the project object was last updated eg. "2013-09-18 18:05:27" type: string format: date-time nullable: true ProxyRequest: description: '' type: object PublishingChannel: description: >- Publishing channels represent all channels (e.g. Twitter account, Facebook page) connected to the portal that can be published to type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.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 e.g. "ABC Facebook page" type: string profileUrl: description: The web address to the publishing channel type: string nullable: true Purchase: description: '' type: object properties: id: description: >- Unique identifier for this purchase note that no particular pattern in this field is guaranteed, only that this field is unique e.g: "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string paymentType: description: |- Payment type e.g: "CreditCard" example: CreditCard nullable: true type: string accountId: description: |- ID of account associated with purchase e.g: "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. USD example: USD nullable: true type: string txnDate: description: |- Transaction date e.g. "2019-08-25" example: '2019-08-25' nullable: true type: string totalAmount: description: |- Total amount purchased in cents e.g. 450000 example: 450000 nullable: false type: integer created: description: |- Date entry was created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date purchase was last modified e.g. "2019-08-26T02:17:40.080Z" example: '2019-08-26T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string customerId: description: |- Id of the customer who made the purchase e.g. "C056" example: C056 nullable: true type: string name: description: |- Name of the purchase e.g. "purchase name" example: purchase name nullable: true type: string status: description: |- Status of the product e.g. "shipped" example: shipped nullable: true type: string quantity: description: |- Quantity purchased e.g. 10 example: 10 nullable: true type: integer amountPerUnit: description: |- Amount per unit e.g. "450" example: '450' nullable: true type: string txnId: description: |- Transaction Id e.g. "4560" example: '4560' nullable: true type: string accountName: description: |- Name of the account associated with the purchase e.g. "Cool Cars" example: Cool Cars nullable: true type: string invoiceId: description: |- ID of the invoice associated with the purchase e.g. "9870028192" example: '9870028192' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true writeOnly: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string PurchaseCreditNote: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: type: string vendorId: description: Vendor Id type: string vendorName: description: Vendor name type: string nullable: true currency: description: |- Currency code e.g. USD type: string nullable: true totalAmount: description: |- Total amount of the purchase e.g. 1000 type: integer poStatus: description: |- Purchase order status, either open or closed e.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: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for the item example: '90300000072369' nullable: false type: string created: description: Datetime when the item was created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: Datetime when the item was last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time customerId: description: Unique identifier for contact example: '0124' nullable: true type: string customerName: description: Contact name example: John Doe nullable: true type: string quoteNumber: description: Generated quote number example: '99' nullable: true type: string txnDate: description: Date of the quote example: '2021-07-28 00:00:00' nullable: true type: string billingCity: description: Main address city example: Toronto nullable: true type: string billingPostalcode: description: Main address postalcode example: H6F0R3 nullable: true type: string billingCountry: description: Main address country example: Canada nullable: true type: string shippingCity: description: Delivery address city example: Vancouver nullable: true type: string shippingCountry: description: Delivery address country example: Canada nullable: true type: string totalAmount: description: Total amount of the quote example: 5000000 nullable: true type: integer currency: description: Currency of the quote example: CAD nullable: true type: string txnStatus: description: Status of quote example: '2021-09-15 00:00:00' nullable: true type: string shippingPostalcode: description: Delivery address postalcode example: V5N7G4 nullable: true type: string RecurringCharge: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: description: Name of the recurring charge example: Monthly Rental nullable: true type: string srcId: description: Unique identifier for each recurring charge example: '982000000567240' nullable: true type: string apiClientId: description: API key for the app the charge is associated with example: aa2e-87c43f2a32a9 nullable: true type: string price: description: The price of the recurring application charge example: 1200 nullable: true type: integer status: description: |- The status of the recurring charge e.g. "Pending" e.g. "Accepted" example: Pending nullable: true type: string returnUrl: description: The URL where the merchant is redirected afteraccepting the charge example: www.example.com nullable: true type: string billingDate: description: The date and time when the customer is billed example: '2021-07-28' nullable: true type: string format: date-time created: description: |- The date and time when the recurring charge was created eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- The date and time when the recurring charge was last modified eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time activationDate: description: The date and time when the customer activated the recurring charge example: '2021-06-28' nullable: true type: string format: date-time cancellationDate: description: The date and time when the merchant cancelled their recurring charge example: '2021-08-28' nullable: true type: string format: date-time trialDays: description: The number of days that the customer is eligible for a free trial example: 12 nullable: true type: integer trialEndsOn: description: The date and time when the free trial ends example: '2021-07-09' nullable: true type: string format: date-time decoratedReturnUrl: description: >- The display URL where the merchant is redirected after accepting a charge example: https://www.example.com nullable: true type: string RecurringExpense: description: '' type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- Unique identifier of the source 3rd party integration eg. 982000000567240 example: '982000000567240' nullable: false type: string recurrenceName: description: |- Name of the recurring-expense eg. "Monthly Rental" example: Monthly Rental nullable: true type: string startDate: description: |- Start date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2020-11-19T00:00:00.000Z' nullable: true type: string endDate: description: |- End date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2024-11-19T00:00:00.000Z' nullable: true type: string lastCreatedDate: description: |- When expense was last generated eg. "2013-11-18T00:00:00.000Z" example: '2021-11-18T00:00:00.000Z' nullable: true type: string recurrenceFrequency: description: >- The frequency of time interval at which the invoice is to be generated eg. "months" example: months nullable: true type: string repeatEvery: description: |- The period between every recurrency frequency eg. "2" example: '2' nullable: true type: string nextExpenseDate: description: |- Date the next expense will be generated eg. "2013-12-18T00:00:00.000Z" example: '2021-12-18T00:00:00.000Z' nullable: true type: string accountId: description: >- Unique identifier for the account associated with the recurring expense "982000000561057" example: '982000000561057' nullable: true type: string accountName: description: |- Expense account name eg. "Rent" example: Rent nullable: true type: string currency: description: |- Currency of the expense eg. "USD" example: USD nullable: true type: string total: description: |- Total amount in cents eg. "1000" example: 100 nullable: true type: integer customerId: description: |- Customer ID of the customer for whom the recurring invoice is raised eg. "982000000567001" example: '982000000567001' nullable: true type: string status: description: |- Status of the recurring expense eg. "active" example: active nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice details were last updated eg. "2013-11-18T02:17:40.080Z" example: '2021-09-15 00:00:00' nullable: true type: string format: date-time Refund: description: Refund captures funds that are refunded to a credit or debit card type: object properties: id: example: quickbooks-66 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string accountId: example: '35' nullable: false type: string currency: description: Currency the refund was made in example: USD nullable: true type: string paymentRef: description: >- Transaction number that appears on email receipts sent for this refund example: USD nullable: true type: string txnDate: description: The date and time the refund was created example: '2021-06-24' nullable: true type: string totalAmount: description: Total amount refunded example: 8750 nullable: false type: integer balance: example: 0 nullable: true type: integer customerId: example: '15' nullable: true type: string created: description: The date and time the refund was created example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time modified: example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time srcId: description: Unique identifier for each refund example: '66' nullable: false type: string reason: description: Reason for refund example: bad item nullable: true type: string status: description: |- Status of refund e.g. "pending" e.g. "succeeded" e.g. "failed" example: succeeded nullable: true type: string RepeatingInvoice: description: >- Repeating invoice represents invoices that are automatically created at regular intervals type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for each repeating invoice example: 01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false type: string period: description: Number of times the invoice is charged per unit example: 1 nullable: true type: integer unit: description: |- Interval unit defining how often the invoice is charged e.g. WEEKLY e.g. MONTHLY example: MONTHLY nullable: true type: string dueDate: description: Number of days defining when the invoice is scheduled to be charged example: '0' nullable: true type: string dueDateType: description: |- The type of billing used together with due date e.g. "DAYSAFTERBILLDATE" e.g. "DAYSAFTERBILLMONTH" e.g. "OFCURRENTMONTH" e.g. "OFFOLLOWINGMONTH" example: DAYSAFTERBILLDATE nullable: true type: string startDate: description: date on which the recurring invoice starts example: '2021-02-27 00:00:00' nullable: true type: string nextScheduledDate: description: date at which next invoice is to be sent example: '2021-07-28 00:00:00' nullable: true type: string type: description: |- The type of invoice e.g. "ACCPAY" e.g. "ACCREC" example: ACCPAY nullable: true type: string reference: description: Order number of recurring invoice example: AP nullable: true type: string hasAttachments: description: Whether the invoice has attachments or not example: false nullable: true type: boolean contactId: description: Id of customer for whom recurring invoice is raised example: 3b30a108-9156-4a42-a893-3bbbe7af1ef8 nullable: true type: string contactName: description: Full name of contact example: Xero nullable: true type: string status: description: |- Status of the repeating invoice e.g. "DRAFT" e.g. "AUTHORISED" example: AUTHORISED nullable: true type: string lineAmountTypes: description: Whether the line amount includes, excludes or doesn't have tax. example: Exclusive nullable: true type: string lineItemDescription: description: A description of the line item example: Monthly subscription nullable: true type: string lineItemUnitAmount: description: The unit amount of the line item example: 29 nullable: true type: integer lineItemTaxType: description: |- The type of tax applied to line items e.g. "OUTPUT" e.g. "INPUT" e.g. "CAPEXINPUT" example: INPUT nullable: true type: string lineAmount: description: The final amount for the line items example: 29 nullable: true type: integer lineItemAccountCode: description: Account code for the line item example: '412' nullable: true type: string lineItemQuantity: description: The quantity of the line items example: 1 nullable: true type: integer lineItemId: description: Unique ID for the line item example: 304e5b38-d62f-4c43-91d2-24786154c3c0 nullable: true type: string subTotal: description: Total of invoice excluding taxes example: 2900 nullable: true type: integer totalTax: description: Total tax on invoice example: 239 nullable: true type: integer total: description: Total of invoice tax inclusive example: 3139 nullable: false type: integer currencyCode: description: currency of invoice example: USD nullable: true type: string recurrenceName: description: Unique name for the recurring profile given by the user example: '412' nullable: true type: string endDate: description: date on which the recurring invoice expires example: '2022-07-28 00:00:00' nullable: true type: string lastSentDate: description: date at which the last invoice was sent example: '2021-08-28 00:00:00' nullable: true type: string paidInvoicesTotal: description: total amount paid to date example: 1000 nullable: true type: integer unpaidInvoicesBalance: description: total amount left to be paid example: 2139 nullable: true 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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: 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\]\]. type: object properties: description: type: string nullable: true id: type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- Unique identifier for the customer e.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 e.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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- Unique identifier of the source 3rd party integration eg. "460000000039129" type: string customerId: description: |- ID of the customer to whom the sales order has to be created eg. "460000000017138" type: string nullable: true Identifier: description: >- Unique number generated (starts with SO) which will be displayed in the interface and sales orders eg. "SO-00001" type: string nullable: true referenceNumber: description: |- Reference number to sales-order eg. "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 eg. "open" type: string nullable: true customerName: description: |- Name of the customer associated with the Sales Order eg. "Bowman Furniture" type: string nullable: true currency: description: |- Code of the Currency involved in the Sales Order eg. "USD" type: string nullable: true subtotal: description: |- Subtotal of sales order eg. 90 type: integer nullable: true totalAmount: description: |- Total of sales order eg. 100 type: integer nullable: true created: description: |- Creation Time of the Sales Order eg. 2014-07-28T08:29:07+0530 type: string format: date-time nullable: true modified: description: |- Last modified time of the Sales Order eg. 2014-07-28T08:29:07+0530 type: string format: date-time nullable: true billingCity: description: |- Billing city eg. Beijing type: string nullable: true billingCountry: description: |- Billing country eg. China type: string nullable: true billingPostalcode: description: |- Billing postal code eg. 1000881 type: string nullable: true shippingCity: description: |- Shipping city eg Beijing type: string nullable: true shippingCountry: description: |- Shipping country eg China type: string nullable: true shippingPostalcode: description: |- Shipping postal code eg. 1000881 type: string nullable: true identifier: type: string nullable: true SiteEvent: description: '' type: object properties: description: type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: type: string subscriptionId: type: string nullable: true created: type: string nullable: true Statement: description: '' type: object properties: description: description: Description of the statement type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- Unique identifier for the customer e.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 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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: '' type: object properties: id: description: >- Unique identifier for this subscription note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Status of the subscription e.g. expired example: true nullable: true type: boolean balance: description: |- Amount in balance for the subscription in cents e.g. 500045 example: 500045 nullable: true type: integer totalRevenue: description: |- Total revenue from this specific subscription in cents e.g. 387687 example: 387687 nullable: true type: integer productPrice: description: |- Price of the subscribed product in cents e.g. 4999 example: 4999 nullable: true type: integer currencyCode: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string currentPeriodStart: description: |- Current period start datetime e.g. "2014-11-18" e.g. "1655792028" example: '1655792028' nullable: true type: string currentPeriodEnd: description: |- Current period end datetime e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string nextPeriodStart: description: |- Date next period starts e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string cancelAtEndOfPeriod: description: Boolean on if plan is canelled at the end of the current period example: true nullable: true type: boolean signupId: description: |- Signup id e.g. "user123" example: user123 nullable: true type: string signupRevenue: description: |- Signup revenue e.g. "250" example: '250' nullable: true type: string couponCode: description: |- Coupon code e.g. "PROMOCODE" example: PROMOCODE nullable: true type: string customerId: description: |- Customer id e.g. "123" example: '123' nullable: true type: string productId: description: |- Id for the subscribed product e.g. "321" example: '321' nullable: true type: string creditCardId: description: |- Credit card id e.g. "4250" example: '4250' nullable: true type: string created: description: |- The date and time the subscription is first created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time customerFirstName: description: |- Customer first name e.g. "Jane" example: Jane nullable: true type: string customerLastName: description: |- Customer last name e.g. "Doe" example: Doe nullable: true type: string startDate: description: |- Start datetime of the subscription e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time endDate: description: |- End datetime of the subscription e.g. "2015-11-18T02:17:40.080Z" example: '2015-11-18T02:17:40.080Z' nullable: true type: string format: date-time planName: description: |- Name of the plan of which this subscription is an instance e.g. "Basic Plan" example: Basic Plan nullable: true type: string activated: description: |- Indicates when the subscription was activated e.g. "Jan 23 2023" example: Jan 23 2023 nullable: true type: string remainingIntervals: description: |- Number of remaining subscription intervals e.g. 12 example: 12 nullable: true type: integer monthlyRevenue: description: |- Revenue per month in cents e.g. 500000 example: 500000 nullable: true type: integer netMonthlyRevenue: description: |- Monthly revenue after taxes e.g. 300000 example: 300000 nullable: true type: integer contractStartDate: description: "Date contract starts\n\t * e.g. \"2013-11-18T02:17:40.080Z\"" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time expiredTimestamp: description: |- When the current subscription expires e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time planInterval: description: |- Length of each subscription plan e.g. "Monthly" example: Monthly nullable: true type: string numOfIntervals: description: |- Number of subscription intervals e.g. 12 example: 12 nullable: true type: integer SupportTicket: description: >- Support tickets represent a customer request for help, support, service, or a response, and the responses generated in reply to the request. type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "OPEN" type: string nullable: true Task: description: '' type: object properties: description: description: details about the task type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g: done e.g: not started type: string nullable: true priority: description: |- priority of the task e.g: high type: string nullable: true dueDate: description: due date of the task type: string format: date-time 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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: '' type: object properties: description: type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: type: string taxRate: type: string nullable: true taxType: 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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: description: |- Name for the term e.g. Net 30 type: string type: description: |- Type of the Sales term e.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: description: >- Tracking category represents categories defined for report generation and tracking type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for each tracking category type: string name: description: |- Name of tracking category e.g. "Department" e.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 e.g. "Marketing" type: string nullable: true trackingOptionStatus: description: The status of a tracking option type: string nullable: true Transaction: description: '' type: object properties: description: description: Transaction description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string transactionType: description: |- Transaction type e.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 e.g: 870 type: integer 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 e.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: description: >- Provides a transaction match report showing which transactions match in banking data sources and accounting data sources type: object properties: 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 start: type: string format: date example: '2022-07-01' end: type: string format: date example: '2022-08-31' 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: description: >- Provides a monthly series of transaction match reports showing which transactions match in banking data sources and accounting data sources type: object 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: 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 start: type: string format: date end: type: string format: date 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: - 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 start: '2022-07-01' end: '2022-07-31' 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 - 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 start: '2022-08-01' end: '2022-08-31' 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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: '' type: object properties: description: description: |- Description of unbilled charge e.g. No Trial type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- Unique identifier for the customer e.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 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: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: '' type: object properties: id: description: >- Unique identifier for this vendor note that no particular pattern in this field is guaranteed, only that this field is unique e.g: "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string givenName: description: |- First name of the vendor e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the vendor e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company e.g. "Doyle-Koch LLC" example: Doyle-Koch LLC nullable: true type: string displayName: description: |- Name displayed for vendor e.g. "Doyle-Koch" example: Doyle-Koch nullable: true type: string contactName: description: |- Name of the main contact for the vendor e.g. "John Smith" example: John Smith nullable: true type: string contactTitle: description: |- Title of the main contact for the vendor e.g. "Account Manager" example: Account Manager nullable: true type: string accountNumber: description: |- Account number for the vendor e.g. "420042" example: '420042' nullable: true type: string phone: description: |- Phone number e.g. "281-381-4241" example: 281-381-4241 nullable: true type: string mobile: description: |- Mobile number e.g. "786-258-0182" example: 786-258-0182 nullable: true type: string fax: description: |- Fax number e.g. "281-381-4255" example: 281-381-4255 nullable: true type: string email: description: |- Email address for the vendor e.g. "doyle-koch@email.com" example: doyle-koch@email.com nullable: true type: string website: description: |- Vendor website e.g. "https://www.doylekoch.com" example: https://www.doylekoch.com nullable: true type: string address: description: |- First line of vendor address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Vendor address line 2 e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string country: description: |- Country of the address * e.g. "United States" example: United States nullable: true type: string postalCode: description: |- Postal code of the address * e.g. "99660" example: '99660' nullable: true type: string currency: description: |- Currency code used by vendor e.g. "USD" example: USD nullable: true type: string balance: description: |- Balance in ledger for vendor in cents e.g. 650000 example: 650000 nullable: true type: integer bankAccountName: description: |- Bank account name associated with the vendor e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank acount number associated with the vendor e.g. "123654" example: '123654' nullable: true type: string notes: description: |- Additional note attached to vendor e.g. "Quality vendor" example: Quality vendor nullable: true type: string taxType: description: |- Type of tax applied to vendor e.g. "Global" example: Global nullable: true type: string isContractor: description: Whether the vendor is a contractor example: true nullable: true type: boolean active: description: Whether the vendor is active example: true nullable: true type: boolean created: description: |- Date of vendor account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time termId: description: >- Reference to a Term object (payment terms) associated with this Vendor e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Vendor e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Vendor e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string VendorCredit: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "3000000002075" example: '3000000002075' nullable: false type: string date: description: |- The date the vendor credit was created e.g. "2014-08-28" example: '2014-08-28' nullable: true type: string status: description: |- Status of recurring expense e.g. "open" example: open nullable: true type: string vendorId: description: |- ID of the vendor the vendor credit is associated with e.g. "460000000020029" example: '460000000020029' nullable: true type: string vendorName: description: |- Name of the vendor the vendor credit is associated with e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string subtotal: description: |- Subtotal of the vendor credits in cents e.g. 3000 example: 3000 nullable: true type: integer totalAmount: description: |- Total amount of the vendor credits in cents e.g. 3500 example: 3500 nullable: true type: integer balance: description: |- Balance in the vendor credit in cents e.g. 2150 example: 2150 nullable: true type: integer created: description: |- Time of the vendor credit creation e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time modified: description: |- Last modified time of vendor credit e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time required: - totalAmount VendorPayment: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string vendorId: description: |- Unique identifier for the vendor e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of vendor payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the vendor payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the vendor payment in cents e.g. 12500 example: 12500 nullable: true type: integer balance: description: |- Balance due for the bill in cents e.g. 3500 example: 3500 nullable: true type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time required: - amount Workflow: description: >- Workflows represent sophisticated marketing automation campaigns that rely on triggering relevant and timely actions (like emails) for contacts in their database type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 AccountCreateResourceRequest: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name AccountCreateResourceRequest1: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name AccountCreateResourceRequest2: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name AccountCreateResourceRequest3: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name AccountCreateResourceRequest4: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name AccountReplaceResourceRequest: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name AccountReplaceResourceRequest1: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name AccountReplaceResourceRequest2: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name AccountReplaceResourceRequest3: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name AccountReplaceResourceRequest4: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name BillPaymentCreateResourceRequest: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time BillPaymentCreateResourceRequest1: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time BillPaymentCreateResourceRequest2: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time BillPaymentCreateResourceRequest3: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time BillPaymentCreateResourceRequest4: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time BillPaymentReplaceResourceRequest: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time BillPaymentReplaceResourceRequest1: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time BillPaymentReplaceResourceRequest2: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time BillPaymentReplaceResourceRequest3: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time BillPaymentReplaceResourceRequest4: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time BillCreateResourceRequest: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer BillCreateResourceRequest1: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer BillCreateResourceRequest2: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer BillCreateResourceRequest3: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer BillCreateResourceRequest4: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer BillUpdateResourceRequest: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer BillUpdateResourceRequest1: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer BillUpdateResourceRequest2: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer BillUpdateResourceRequest3: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer BillUpdateResourceRequest4: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer ConversionDocumentFormatRequest: description: '' type: object properties: id: description: identifier readOnly: true 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: description: conversion processing status readOnly: true type: string file: description: name of file type: string ConversionDocumentFormatRequest1: description: '' type: object properties: id: description: identifier readOnly: true 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: description: conversion processing status readOnly: true type: string file: description: name of file type: string ConversionDocumentFormatRequest2: description: '' type: object properties: id: description: identifier readOnly: true 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: description: conversion processing status readOnly: true type: string file: description: name of file type: string ConversionDocumentFormatRequest3: description: '' type: object properties: id: description: identifier readOnly: true 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: description: conversion processing status readOnly: true type: string file: description: name of file type: string ConversionDocumentFormatRequest4: description: '' type: object properties: id: description: identifier readOnly: true 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: description: conversion processing status readOnly: true type: string file: description: name of file type: string CreditNoteCreateResourceRequest: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time CreditNoteCreateResourceRequest1: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time CreditNoteCreateResourceRequest2: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time CreditNoteCreateResourceRequest3: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time CreditNoteCreateResourceRequest4: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time CreditNoteReplaceResourceRequest: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time CreditNoteReplaceResourceRequest1: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time CreditNoteReplaceResourceRequest2: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time CreditNoteReplaceResourceRequest3: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time CreditNoteReplaceResourceRequest4: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time CustomerCreateResourceRequest: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string CustomerCreateResourceRequest1: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string CustomerCreateResourceRequest2: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string CustomerCreateResourceRequest3: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string CustomerCreateResourceRequest4: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string CustomerReplaceResourceRequest: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string CustomerReplaceResourceRequest1: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string CustomerReplaceResourceRequest2: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string CustomerReplaceResourceRequest3: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string CustomerReplaceResourceRequest4: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string DealCreateResourceRequest: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer DealCreateResourceRequest1: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer DealCreateResourceRequest2: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer DealCreateResourceRequest3: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer DealCreateResourceRequest4: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer DealUpdateResourceRequest: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer DealUpdateResourceRequest1: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer DealUpdateResourceRequest2: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer DealUpdateResourceRequest3: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer DealUpdateResourceRequest4: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer EmployeeCreateResourceRequest: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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 EmployeeCreateResourceRequest1: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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 EmployeeCreateResourceRequest2: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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 EmployeeCreateResourceRequest3: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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 EmployeeCreateResourceRequest4: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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 EmployeeReplaceResourceRequest: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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 EmployeeReplaceResourceRequest1: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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 EmployeeReplaceResourceRequest2: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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 EmployeeReplaceResourceRequest3: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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 EmployeeReplaceResourceRequest4: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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 ExpenseCreateResourceRequest: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean ExpenseCreateResourceRequest1: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean ExpenseCreateResourceRequest2: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean ExpenseCreateResourceRequest3: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean ExpenseCreateResourceRequest4: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean ExpenseReplaceResourceRequest: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean ExpenseReplaceResourceRequest1: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean ExpenseReplaceResourceRequest2: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean ExpenseReplaceResourceRequest3: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean ExpenseReplaceResourceRequest4: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean InventoryCreateResourceRequest: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} InventoryCreateResourceRequest1: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} InventoryCreateResourceRequest2: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} InventoryCreateResourceRequest3: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} InventoryCreateResourceRequest4: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} InventoryReplaceResourceRequest: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} InventoryReplaceResourceRequest1: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} InventoryReplaceResourceRequest2: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} InventoryReplaceResourceRequest3: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} InventoryReplaceResourceRequest4: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} InvoiceItemCreateResourceRequest: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer InvoiceItemCreateResourceRequest1: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer InvoiceItemCreateResourceRequest2: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer InvoiceItemCreateResourceRequest3: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer InvoiceItemCreateResourceRequest4: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer InvoiceItemReplaceResourceRequest: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer InvoiceItemReplaceResourceRequest1: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer InvoiceItemReplaceResourceRequest2: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer InvoiceItemReplaceResourceRequest3: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer InvoiceItemReplaceResourceRequest4: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer LeadCreateResourceRequest: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LeadCreateResourceRequest1: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LeadCreateResourceRequest2: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LeadCreateResourceRequest3: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LeadCreateResourceRequest4: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LeadReplaceResourceRequest: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LeadReplaceResourceRequest1: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LeadReplaceResourceRequest2: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LeadReplaceResourceRequest3: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LeadReplaceResourceRequest4: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LocationCreateResourceRequest: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string LocationCreateResourceRequest1: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string LocationCreateResourceRequest2: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string LocationCreateResourceRequest3: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string LocationCreateResourceRequest4: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string LocationReplaceResourceRequest: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string LocationReplaceResourceRequest1: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string LocationReplaceResourceRequest2: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string LocationReplaceResourceRequest3: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string LocationReplaceResourceRequest4: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string OrderCreateResourceRequest: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string OrderCreateResourceRequest1: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string OrderCreateResourceRequest2: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string OrderCreateResourceRequest3: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string OrderCreateResourceRequest4: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string OrderReplaceResourceRequest: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string OrderReplaceResourceRequest1: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string OrderReplaceResourceRequest2: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string OrderReplaceResourceRequest3: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string OrderReplaceResourceRequest4: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string PaymentMethodCreateResourceRequest: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentMethodCreateResourceRequest1: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentMethodCreateResourceRequest2: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentMethodCreateResourceRequest3: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentMethodCreateResourceRequest4: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentMethodReplaceResourceRequest: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentMethodReplaceResourceRequest1: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentMethodReplaceResourceRequest2: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentMethodReplaceResourceRequest3: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentMethodReplaceResourceRequest4: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentCreateResourceRequest: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PaymentCreateResourceRequest1: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PaymentCreateResourceRequest2: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PaymentCreateResourceRequest3: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PaymentCreateResourceRequest4: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PaymentReplaceResourceRequest: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PaymentReplaceResourceRequest1: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PaymentReplaceResourceRequest2: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PaymentReplaceResourceRequest3: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PaymentReplaceResourceRequest4: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PayoutCreateResourceRequest: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: |- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string PayoutCreateResourceRequest1: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: |- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string PayoutCreateResourceRequest2: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: |- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string PayoutCreateResourceRequest3: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: |- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string PayoutCreateResourceRequest4: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: |- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string PayoutReplaceResourceRequest: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: |- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string PayoutReplaceResourceRequest1: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: |- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string PayoutReplaceResourceRequest2: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: |- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string PayoutReplaceResourceRequest3: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: |- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string PayoutReplaceResourceRequest4: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: |- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string ProductCreateResourceRequest: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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 ProductCreateResourceRequest1: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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 ProductCreateResourceRequest2: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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 ProductCreateResourceRequest3: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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 ProductCreateResourceRequest4: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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 ProductReplaceResourceRequest: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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 ProductReplaceResourceRequest1: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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 ProductReplaceResourceRequest2: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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 ProductReplaceResourceRequest3: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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 ProductReplaceResourceRequest4: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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 ProxyRequestSendRequestRequest: description: '' type: object ProxyRequestSendRequestRequest1: description: '' type: object ProxyRequestSendRequestRequest2: description: '' type: object ProxyRequestSendRequestRequest3: description: '' type: object ProxyRequestSendRequestRequest4: description: '' type: object QuoteCreateResourceRequest: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for the item example: '90300000072369' nullable: false type: string created: description: Datetime when the item was created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: Datetime when the item was last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time customerId: description: Unique identifier for contact example: '0124' nullable: true type: string customerName: description: Contact name example: John Doe nullable: true type: string quoteNumber: description: Generated quote number example: '99' nullable: true type: string txnDate: description: Date of the quote example: '2021-07-28 00:00:00' nullable: true type: string billingCity: description: Main address city example: Toronto nullable: true type: string billingPostalcode: description: Main address postalcode example: H6F0R3 nullable: true type: string billingCountry: description: Main address country example: Canada nullable: true type: string shippingCity: description: Delivery address city example: Vancouver nullable: true type: string shippingCountry: description: Delivery address country example: Canada nullable: true type: string totalAmount: description: Total amount of the quote example: 5000000 nullable: true type: integer currency: description: Currency of the quote example: CAD nullable: true type: string txnStatus: description: Status of quote example: '2021-09-15 00:00:00' nullable: true type: string shippingPostalcode: description: Delivery address postalcode example: V5N7G4 nullable: true type: string QuoteCreateResourceRequest1: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for the item example: '90300000072369' nullable: false type: string created: description: Datetime when the item was created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: Datetime when the item was last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time customerId: description: Unique identifier for contact example: '0124' nullable: true type: string customerName: description: Contact name example: John Doe nullable: true type: string quoteNumber: description: Generated quote number example: '99' nullable: true type: string txnDate: description: Date of the quote example: '2021-07-28 00:00:00' nullable: true type: string billingCity: description: Main address city example: Toronto nullable: true type: string billingPostalcode: description: Main address postalcode example: H6F0R3 nullable: true type: string billingCountry: description: Main address country example: Canada nullable: true type: string shippingCity: description: Delivery address city example: Vancouver nullable: true type: string shippingCountry: description: Delivery address country example: Canada nullable: true type: string totalAmount: description: Total amount of the quote example: 5000000 nullable: true type: integer currency: description: Currency of the quote example: CAD nullable: true type: string txnStatus: description: Status of quote example: '2021-09-15 00:00:00' nullable: true type: string shippingPostalcode: description: Delivery address postalcode example: V5N7G4 nullable: true type: string QuoteCreateResourceRequest2: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for the item example: '90300000072369' nullable: false type: string created: description: Datetime when the item was created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: Datetime when the item was last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time customerId: description: Unique identifier for contact example: '0124' nullable: true type: string customerName: description: Contact name example: John Doe nullable: true type: string quoteNumber: description: Generated quote number example: '99' nullable: true type: string txnDate: description: Date of the quote example: '2021-07-28 00:00:00' nullable: true type: string billingCity: description: Main address city example: Toronto nullable: true type: string billingPostalcode: description: Main address postalcode example: H6F0R3 nullable: true type: string billingCountry: description: Main address country example: Canada nullable: true type: string shippingCity: description: Delivery address city example: Vancouver nullable: true type: string shippingCountry: description: Delivery address country example: Canada nullable: true type: string totalAmount: description: Total amount of the quote example: 5000000 nullable: true type: integer currency: description: Currency of the quote example: CAD nullable: true type: string txnStatus: description: Status of quote example: '2021-09-15 00:00:00' nullable: true type: string shippingPostalcode: description: Delivery address postalcode example: V5N7G4 nullable: true type: string QuoteCreateResourceRequest3: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for the item example: '90300000072369' nullable: false type: string created: description: Datetime when the item was created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: Datetime when the item was last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time customerId: description: Unique identifier for contact example: '0124' nullable: true type: string customerName: description: Contact name example: John Doe nullable: true type: string quoteNumber: description: Generated quote number example: '99' nullable: true type: string txnDate: description: Date of the quote example: '2021-07-28 00:00:00' nullable: true type: string billingCity: description: Main address city example: Toronto nullable: true type: string billingPostalcode: description: Main address postalcode example: H6F0R3 nullable: true type: string billingCountry: description: Main address country example: Canada nullable: true type: string shippingCity: description: Delivery address city example: Vancouver nullable: true type: string shippingCountry: description: Delivery address country example: Canada nullable: true type: string totalAmount: description: Total amount of the quote example: 5000000 nullable: true type: integer currency: description: Currency of the quote example: CAD nullable: true type: string txnStatus: description: Status of quote example: '2021-09-15 00:00:00' nullable: true type: string shippingPostalcode: description: Delivery address postalcode example: V5N7G4 nullable: true type: string QuoteCreateResourceRequest4: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for the item example: '90300000072369' nullable: false type: string created: description: Datetime when the item was created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: Datetime when the item was last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time customerId: description: Unique identifier for contact example: '0124' nullable: true type: string customerName: description: Contact name example: John Doe nullable: true type: string quoteNumber: description: Generated quote number example: '99' nullable: true type: string txnDate: description: Date of the quote example: '2021-07-28 00:00:00' nullable: true type: string billingCity: description: Main address city example: Toronto nullable: true type: string billingPostalcode: description: Main address postalcode example: H6F0R3 nullable: true type: string billingCountry: description: Main address country example: Canada nullable: true type: string shippingCity: description: Delivery address city example: Vancouver nullable: true type: string shippingCountry: description: Delivery address country example: Canada nullable: true type: string totalAmount: description: Total amount of the quote example: 5000000 nullable: true type: integer currency: description: Currency of the quote example: CAD nullable: true type: string txnStatus: description: Status of quote example: '2021-09-15 00:00:00' nullable: true type: string shippingPostalcode: description: Delivery address postalcode example: V5N7G4 nullable: true type: string QuoteReplaceResourceRequest: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for the item example: '90300000072369' nullable: false type: string created: description: Datetime when the item was created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: Datetime when the item was last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time customerId: description: Unique identifier for contact example: '0124' nullable: true type: string customerName: description: Contact name example: John Doe nullable: true type: string quoteNumber: description: Generated quote number example: '99' nullable: true type: string txnDate: description: Date of the quote example: '2021-07-28 00:00:00' nullable: true type: string billingCity: description: Main address city example: Toronto nullable: true type: string billingPostalcode: description: Main address postalcode example: H6F0R3 nullable: true type: string billingCountry: description: Main address country example: Canada nullable: true type: string shippingCity: description: Delivery address city example: Vancouver nullable: true type: string shippingCountry: description: Delivery address country example: Canada nullable: true type: string totalAmount: description: Total amount of the quote example: 5000000 nullable: true type: integer currency: description: Currency of the quote example: CAD nullable: true type: string txnStatus: description: Status of quote example: '2021-09-15 00:00:00' nullable: true type: string shippingPostalcode: description: Delivery address postalcode example: V5N7G4 nullable: true type: string QuoteReplaceResourceRequest1: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for the item example: '90300000072369' nullable: false type: string created: description: Datetime when the item was created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: Datetime when the item was last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time customerId: description: Unique identifier for contact example: '0124' nullable: true type: string customerName: description: Contact name example: John Doe nullable: true type: string quoteNumber: description: Generated quote number example: '99' nullable: true type: string txnDate: description: Date of the quote example: '2021-07-28 00:00:00' nullable: true type: string billingCity: description: Main address city example: Toronto nullable: true type: string billingPostalcode: description: Main address postalcode example: H6F0R3 nullable: true type: string billingCountry: description: Main address country example: Canada nullable: true type: string shippingCity: description: Delivery address city example: Vancouver nullable: true type: string shippingCountry: description: Delivery address country example: Canada nullable: true type: string totalAmount: description: Total amount of the quote example: 5000000 nullable: true type: integer currency: description: Currency of the quote example: CAD nullable: true type: string txnStatus: description: Status of quote example: '2021-09-15 00:00:00' nullable: true type: string shippingPostalcode: description: Delivery address postalcode example: V5N7G4 nullable: true type: string QuoteReplaceResourceRequest2: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for the item example: '90300000072369' nullable: false type: string created: description: Datetime when the item was created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: Datetime when the item was last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time customerId: description: Unique identifier for contact example: '0124' nullable: true type: string customerName: description: Contact name example: John Doe nullable: true type: string quoteNumber: description: Generated quote number example: '99' nullable: true type: string txnDate: description: Date of the quote example: '2021-07-28 00:00:00' nullable: true type: string billingCity: description: Main address city example: Toronto nullable: true type: string billingPostalcode: description: Main address postalcode example: H6F0R3 nullable: true type: string billingCountry: description: Main address country example: Canada nullable: true type: string shippingCity: description: Delivery address city example: Vancouver nullable: true type: string shippingCountry: description: Delivery address country example: Canada nullable: true type: string totalAmount: description: Total amount of the quote example: 5000000 nullable: true type: integer currency: description: Currency of the quote example: CAD nullable: true type: string txnStatus: description: Status of quote example: '2021-09-15 00:00:00' nullable: true type: string shippingPostalcode: description: Delivery address postalcode example: V5N7G4 nullable: true type: string QuoteReplaceResourceRequest3: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for the item example: '90300000072369' nullable: false type: string created: description: Datetime when the item was created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: Datetime when the item was last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time customerId: description: Unique identifier for contact example: '0124' nullable: true type: string customerName: description: Contact name example: John Doe nullable: true type: string quoteNumber: description: Generated quote number example: '99' nullable: true type: string txnDate: description: Date of the quote example: '2021-07-28 00:00:00' nullable: true type: string billingCity: description: Main address city example: Toronto nullable: true type: string billingPostalcode: description: Main address postalcode example: H6F0R3 nullable: true type: string billingCountry: description: Main address country example: Canada nullable: true type: string shippingCity: description: Delivery address city example: Vancouver nullable: true type: string shippingCountry: description: Delivery address country example: Canada nullable: true type: string totalAmount: description: Total amount of the quote example: 5000000 nullable: true type: integer currency: description: Currency of the quote example: CAD nullable: true type: string txnStatus: description: Status of quote example: '2021-09-15 00:00:00' nullable: true type: string shippingPostalcode: description: Delivery address postalcode example: V5N7G4 nullable: true type: string QuoteReplaceResourceRequest4: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for the item example: '90300000072369' nullable: false type: string created: description: Datetime when the item was created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: Datetime when the item was last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time customerId: description: Unique identifier for contact example: '0124' nullable: true type: string customerName: description: Contact name example: John Doe nullable: true type: string quoteNumber: description: Generated quote number example: '99' nullable: true type: string txnDate: description: Date of the quote example: '2021-07-28 00:00:00' nullable: true type: string billingCity: description: Main address city example: Toronto nullable: true type: string billingPostalcode: description: Main address postalcode example: H6F0R3 nullable: true type: string billingCountry: description: Main address country example: Canada nullable: true type: string shippingCity: description: Delivery address city example: Vancouver nullable: true type: string shippingCountry: description: Delivery address country example: Canada nullable: true type: string totalAmount: description: Total amount of the quote example: 5000000 nullable: true type: integer currency: description: Currency of the quote example: CAD nullable: true type: string txnStatus: description: Status of quote example: '2021-09-15 00:00:00' nullable: true type: string shippingPostalcode: description: Delivery address postalcode example: V5N7G4 nullable: true type: string RecurringChargeCreateResourceRequest: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: description: Name of the recurring charge example: Monthly Rental nullable: true type: string srcId: description: Unique identifier for each recurring charge example: '982000000567240' nullable: true type: string apiClientId: description: API key for the app the charge is associated with example: aa2e-87c43f2a32a9 nullable: true type: string price: description: The price of the recurring application charge example: 1200 nullable: true type: integer status: description: |- The status of the recurring charge e.g. "Pending" e.g. "Accepted" example: Pending nullable: true type: string returnUrl: description: The URL where the merchant is redirected afteraccepting the charge example: www.example.com nullable: true type: string billingDate: description: The date and time when the customer is billed example: '2021-07-28' nullable: true type: string format: date-time created: description: |- The date and time when the recurring charge was created eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- The date and time when the recurring charge was last modified eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time activationDate: description: The date and time when the customer activated the recurring charge example: '2021-06-28' nullable: true type: string format: date-time cancellationDate: description: The date and time when the merchant cancelled their recurring charge example: '2021-08-28' nullable: true type: string format: date-time trialDays: description: The number of days that the customer is eligible for a free trial example: 12 nullable: true type: integer trialEndsOn: description: The date and time when the free trial ends example: '2021-07-09' nullable: true type: string format: date-time decoratedReturnUrl: description: >- The display URL where the merchant is redirected after accepting a charge example: https://www.example.com nullable: true type: string RecurringChargeCreateResourceRequest1: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: description: Name of the recurring charge example: Monthly Rental nullable: true type: string srcId: description: Unique identifier for each recurring charge example: '982000000567240' nullable: true type: string apiClientId: description: API key for the app the charge is associated with example: aa2e-87c43f2a32a9 nullable: true type: string price: description: The price of the recurring application charge example: 1200 nullable: true type: integer status: description: |- The status of the recurring charge e.g. "Pending" e.g. "Accepted" example: Pending nullable: true type: string returnUrl: description: The URL where the merchant is redirected afteraccepting the charge example: www.example.com nullable: true type: string billingDate: description: The date and time when the customer is billed example: '2021-07-28' nullable: true type: string format: date-time created: description: |- The date and time when the recurring charge was created eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- The date and time when the recurring charge was last modified eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time activationDate: description: The date and time when the customer activated the recurring charge example: '2021-06-28' nullable: true type: string format: date-time cancellationDate: description: The date and time when the merchant cancelled their recurring charge example: '2021-08-28' nullable: true type: string format: date-time trialDays: description: The number of days that the customer is eligible for a free trial example: 12 nullable: true type: integer trialEndsOn: description: The date and time when the free trial ends example: '2021-07-09' nullable: true type: string format: date-time decoratedReturnUrl: description: >- The display URL where the merchant is redirected after accepting a charge example: https://www.example.com nullable: true type: string RecurringChargeCreateResourceRequest2: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: description: Name of the recurring charge example: Monthly Rental nullable: true type: string srcId: description: Unique identifier for each recurring charge example: '982000000567240' nullable: true type: string apiClientId: description: API key for the app the charge is associated with example: aa2e-87c43f2a32a9 nullable: true type: string price: description: The price of the recurring application charge example: 1200 nullable: true type: integer status: description: |- The status of the recurring charge e.g. "Pending" e.g. "Accepted" example: Pending nullable: true type: string returnUrl: description: The URL where the merchant is redirected afteraccepting the charge example: www.example.com nullable: true type: string billingDate: description: The date and time when the customer is billed example: '2021-07-28' nullable: true type: string format: date-time created: description: |- The date and time when the recurring charge was created eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- The date and time when the recurring charge was last modified eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time activationDate: description: The date and time when the customer activated the recurring charge example: '2021-06-28' nullable: true type: string format: date-time cancellationDate: description: The date and time when the merchant cancelled their recurring charge example: '2021-08-28' nullable: true type: string format: date-time trialDays: description: The number of days that the customer is eligible for a free trial example: 12 nullable: true type: integer trialEndsOn: description: The date and time when the free trial ends example: '2021-07-09' nullable: true type: string format: date-time decoratedReturnUrl: description: >- The display URL where the merchant is redirected after accepting a charge example: https://www.example.com nullable: true type: string RecurringChargeCreateResourceRequest3: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: description: Name of the recurring charge example: Monthly Rental nullable: true type: string srcId: description: Unique identifier for each recurring charge example: '982000000567240' nullable: true type: string apiClientId: description: API key for the app the charge is associated with example: aa2e-87c43f2a32a9 nullable: true type: string price: description: The price of the recurring application charge example: 1200 nullable: true type: integer status: description: |- The status of the recurring charge e.g. "Pending" e.g. "Accepted" example: Pending nullable: true type: string returnUrl: description: The URL where the merchant is redirected afteraccepting the charge example: www.example.com nullable: true type: string billingDate: description: The date and time when the customer is billed example: '2021-07-28' nullable: true type: string format: date-time created: description: |- The date and time when the recurring charge was created eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- The date and time when the recurring charge was last modified eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time activationDate: description: The date and time when the customer activated the recurring charge example: '2021-06-28' nullable: true type: string format: date-time cancellationDate: description: The date and time when the merchant cancelled their recurring charge example: '2021-08-28' nullable: true type: string format: date-time trialDays: description: The number of days that the customer is eligible for a free trial example: 12 nullable: true type: integer trialEndsOn: description: The date and time when the free trial ends example: '2021-07-09' nullable: true type: string format: date-time decoratedReturnUrl: description: >- The display URL where the merchant is redirected after accepting a charge example: https://www.example.com nullable: true type: string RecurringChargeCreateResourceRequest4: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: description: Name of the recurring charge example: Monthly Rental nullable: true type: string srcId: description: Unique identifier for each recurring charge example: '982000000567240' nullable: true type: string apiClientId: description: API key for the app the charge is associated with example: aa2e-87c43f2a32a9 nullable: true type: string price: description: The price of the recurring application charge example: 1200 nullable: true type: integer status: description: |- The status of the recurring charge e.g. "Pending" e.g. "Accepted" example: Pending nullable: true type: string returnUrl: description: The URL where the merchant is redirected afteraccepting the charge example: www.example.com nullable: true type: string billingDate: description: The date and time when the customer is billed example: '2021-07-28' nullable: true type: string format: date-time created: description: |- The date and time when the recurring charge was created eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- The date and time when the recurring charge was last modified eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time activationDate: description: The date and time when the customer activated the recurring charge example: '2021-06-28' nullable: true type: string format: date-time cancellationDate: description: The date and time when the merchant cancelled their recurring charge example: '2021-08-28' nullable: true type: string format: date-time trialDays: description: The number of days that the customer is eligible for a free trial example: 12 nullable: true type: integer trialEndsOn: description: The date and time when the free trial ends example: '2021-07-09' nullable: true type: string format: date-time decoratedReturnUrl: description: >- The display URL where the merchant is redirected after accepting a charge example: https://www.example.com nullable: true type: string RecurringChargeReplaceResourceRequest: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: description: Name of the recurring charge example: Monthly Rental nullable: true type: string srcId: description: Unique identifier for each recurring charge example: '982000000567240' nullable: true type: string apiClientId: description: API key for the app the charge is associated with example: aa2e-87c43f2a32a9 nullable: true type: string price: description: The price of the recurring application charge example: 1200 nullable: true type: integer status: description: |- The status of the recurring charge e.g. "Pending" e.g. "Accepted" example: Pending nullable: true type: string returnUrl: description: The URL where the merchant is redirected afteraccepting the charge example: www.example.com nullable: true type: string billingDate: description: The date and time when the customer is billed example: '2021-07-28' nullable: true type: string format: date-time created: description: |- The date and time when the recurring charge was created eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- The date and time when the recurring charge was last modified eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time activationDate: description: The date and time when the customer activated the recurring charge example: '2021-06-28' nullable: true type: string format: date-time cancellationDate: description: The date and time when the merchant cancelled their recurring charge example: '2021-08-28' nullable: true type: string format: date-time trialDays: description: The number of days that the customer is eligible for a free trial example: 12 nullable: true type: integer trialEndsOn: description: The date and time when the free trial ends example: '2021-07-09' nullable: true type: string format: date-time decoratedReturnUrl: description: >- The display URL where the merchant is redirected after accepting a charge example: https://www.example.com nullable: true type: string RecurringChargeReplaceResourceRequest1: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: description: Name of the recurring charge example: Monthly Rental nullable: true type: string srcId: description: Unique identifier for each recurring charge example: '982000000567240' nullable: true type: string apiClientId: description: API key for the app the charge is associated with example: aa2e-87c43f2a32a9 nullable: true type: string price: description: The price of the recurring application charge example: 1200 nullable: true type: integer status: description: |- The status of the recurring charge e.g. "Pending" e.g. "Accepted" example: Pending nullable: true type: string returnUrl: description: The URL where the merchant is redirected afteraccepting the charge example: www.example.com nullable: true type: string billingDate: description: The date and time when the customer is billed example: '2021-07-28' nullable: true type: string format: date-time created: description: |- The date and time when the recurring charge was created eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- The date and time when the recurring charge was last modified eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time activationDate: description: The date and time when the customer activated the recurring charge example: '2021-06-28' nullable: true type: string format: date-time cancellationDate: description: The date and time when the merchant cancelled their recurring charge example: '2021-08-28' nullable: true type: string format: date-time trialDays: description: The number of days that the customer is eligible for a free trial example: 12 nullable: true type: integer trialEndsOn: description: The date and time when the free trial ends example: '2021-07-09' nullable: true type: string format: date-time decoratedReturnUrl: description: >- The display URL where the merchant is redirected after accepting a charge example: https://www.example.com nullable: true type: string RecurringChargeReplaceResourceRequest2: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: description: Name of the recurring charge example: Monthly Rental nullable: true type: string srcId: description: Unique identifier for each recurring charge example: '982000000567240' nullable: true type: string apiClientId: description: API key for the app the charge is associated with example: aa2e-87c43f2a32a9 nullable: true type: string price: description: The price of the recurring application charge example: 1200 nullable: true type: integer status: description: |- The status of the recurring charge e.g. "Pending" e.g. "Accepted" example: Pending nullable: true type: string returnUrl: description: The URL where the merchant is redirected afteraccepting the charge example: www.example.com nullable: true type: string billingDate: description: The date and time when the customer is billed example: '2021-07-28' nullable: true type: string format: date-time created: description: |- The date and time when the recurring charge was created eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- The date and time when the recurring charge was last modified eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time activationDate: description: The date and time when the customer activated the recurring charge example: '2021-06-28' nullable: true type: string format: date-time cancellationDate: description: The date and time when the merchant cancelled their recurring charge example: '2021-08-28' nullable: true type: string format: date-time trialDays: description: The number of days that the customer is eligible for a free trial example: 12 nullable: true type: integer trialEndsOn: description: The date and time when the free trial ends example: '2021-07-09' nullable: true type: string format: date-time decoratedReturnUrl: description: >- The display URL where the merchant is redirected after accepting a charge example: https://www.example.com nullable: true type: string RecurringChargeReplaceResourceRequest3: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: description: Name of the recurring charge example: Monthly Rental nullable: true type: string srcId: description: Unique identifier for each recurring charge example: '982000000567240' nullable: true type: string apiClientId: description: API key for the app the charge is associated with example: aa2e-87c43f2a32a9 nullable: true type: string price: description: The price of the recurring application charge example: 1200 nullable: true type: integer status: description: |- The status of the recurring charge e.g. "Pending" e.g. "Accepted" example: Pending nullable: true type: string returnUrl: description: The URL where the merchant is redirected afteraccepting the charge example: www.example.com nullable: true type: string billingDate: description: The date and time when the customer is billed example: '2021-07-28' nullable: true type: string format: date-time created: description: |- The date and time when the recurring charge was created eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- The date and time when the recurring charge was last modified eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time activationDate: description: The date and time when the customer activated the recurring charge example: '2021-06-28' nullable: true type: string format: date-time cancellationDate: description: The date and time when the merchant cancelled their recurring charge example: '2021-08-28' nullable: true type: string format: date-time trialDays: description: The number of days that the customer is eligible for a free trial example: 12 nullable: true type: integer trialEndsOn: description: The date and time when the free trial ends example: '2021-07-09' nullable: true type: string format: date-time decoratedReturnUrl: description: >- The display URL where the merchant is redirected after accepting a charge example: https://www.example.com nullable: true type: string RecurringChargeReplaceResourceRequest4: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: description: Name of the recurring charge example: Monthly Rental nullable: true type: string srcId: description: Unique identifier for each recurring charge example: '982000000567240' nullable: true type: string apiClientId: description: API key for the app the charge is associated with example: aa2e-87c43f2a32a9 nullable: true type: string price: description: The price of the recurring application charge example: 1200 nullable: true type: integer status: description: |- The status of the recurring charge e.g. "Pending" e.g. "Accepted" example: Pending nullable: true type: string returnUrl: description: The URL where the merchant is redirected afteraccepting the charge example: www.example.com nullable: true type: string billingDate: description: The date and time when the customer is billed example: '2021-07-28' nullable: true type: string format: date-time created: description: |- The date and time when the recurring charge was created eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- The date and time when the recurring charge was last modified eg. "2021-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time activationDate: description: The date and time when the customer activated the recurring charge example: '2021-06-28' nullable: true type: string format: date-time cancellationDate: description: The date and time when the merchant cancelled their recurring charge example: '2021-08-28' nullable: true type: string format: date-time trialDays: description: The number of days that the customer is eligible for a free trial example: 12 nullable: true type: integer trialEndsOn: description: The date and time when the free trial ends example: '2021-07-09' nullable: true type: string format: date-time decoratedReturnUrl: description: >- The display URL where the merchant is redirected after accepting a charge example: https://www.example.com nullable: true type: string RecurringExpenseCreateResourceRequest: description: '' type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- Unique identifier of the source 3rd party integration eg. 982000000567240 example: '982000000567240' nullable: false type: string recurrenceName: description: |- Name of the recurring-expense eg. "Monthly Rental" example: Monthly Rental nullable: true type: string startDate: description: |- Start date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2020-11-19T00:00:00.000Z' nullable: true type: string endDate: description: |- End date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2024-11-19T00:00:00.000Z' nullable: true type: string lastCreatedDate: description: |- When expense was last generated eg. "2013-11-18T00:00:00.000Z" example: '2021-11-18T00:00:00.000Z' nullable: true type: string recurrenceFrequency: description: >- The frequency of time interval at which the invoice is to be generated eg. "months" example: months nullable: true type: string repeatEvery: description: |- The period between every recurrency frequency eg. "2" example: '2' nullable: true type: string nextExpenseDate: description: |- Date the next expense will be generated eg. "2013-12-18T00:00:00.000Z" example: '2021-12-18T00:00:00.000Z' nullable: true type: string accountId: description: >- Unique identifier for the account associated with the recurring expense "982000000561057" example: '982000000561057' nullable: true type: string accountName: description: |- Expense account name eg. "Rent" example: Rent nullable: true type: string currency: description: |- Currency of the expense eg. "USD" example: USD nullable: true type: string total: description: |- Total amount in cents eg. "1000" example: 100 nullable: true type: integer customerId: description: |- Customer ID of the customer for whom the recurring invoice is raised eg. "982000000567001" example: '982000000567001' nullable: true type: string status: description: |- Status of the recurring expense eg. "active" example: active nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice details were last updated eg. "2013-11-18T02:17:40.080Z" example: '2021-09-15 00:00:00' nullable: true type: string format: date-time RecurringExpenseCreateResourceRequest1: description: '' type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- Unique identifier of the source 3rd party integration eg. 982000000567240 example: '982000000567240' nullable: false type: string recurrenceName: description: |- Name of the recurring-expense eg. "Monthly Rental" example: Monthly Rental nullable: true type: string startDate: description: |- Start date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2020-11-19T00:00:00.000Z' nullable: true type: string endDate: description: |- End date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2024-11-19T00:00:00.000Z' nullable: true type: string lastCreatedDate: description: |- When expense was last generated eg. "2013-11-18T00:00:00.000Z" example: '2021-11-18T00:00:00.000Z' nullable: true type: string recurrenceFrequency: description: >- The frequency of time interval at which the invoice is to be generated eg. "months" example: months nullable: true type: string repeatEvery: description: |- The period between every recurrency frequency eg. "2" example: '2' nullable: true type: string nextExpenseDate: description: |- Date the next expense will be generated eg. "2013-12-18T00:00:00.000Z" example: '2021-12-18T00:00:00.000Z' nullable: true type: string accountId: description: >- Unique identifier for the account associated with the recurring expense "982000000561057" example: '982000000561057' nullable: true type: string accountName: description: |- Expense account name eg. "Rent" example: Rent nullable: true type: string currency: description: |- Currency of the expense eg. "USD" example: USD nullable: true type: string total: description: |- Total amount in cents eg. "1000" example: 100 nullable: true type: integer customerId: description: |- Customer ID of the customer for whom the recurring invoice is raised eg. "982000000567001" example: '982000000567001' nullable: true type: string status: description: |- Status of the recurring expense eg. "active" example: active nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice details were last updated eg. "2013-11-18T02:17:40.080Z" example: '2021-09-15 00:00:00' nullable: true type: string format: date-time RecurringExpenseCreateResourceRequest2: description: '' type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- Unique identifier of the source 3rd party integration eg. 982000000567240 example: '982000000567240' nullable: false type: string recurrenceName: description: |- Name of the recurring-expense eg. "Monthly Rental" example: Monthly Rental nullable: true type: string startDate: description: |- Start date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2020-11-19T00:00:00.000Z' nullable: true type: string endDate: description: |- End date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2024-11-19T00:00:00.000Z' nullable: true type: string lastCreatedDate: description: |- When expense was last generated eg. "2013-11-18T00:00:00.000Z" example: '2021-11-18T00:00:00.000Z' nullable: true type: string recurrenceFrequency: description: >- The frequency of time interval at which the invoice is to be generated eg. "months" example: months nullable: true type: string repeatEvery: description: |- The period between every recurrency frequency eg. "2" example: '2' nullable: true type: string nextExpenseDate: description: |- Date the next expense will be generated eg. "2013-12-18T00:00:00.000Z" example: '2021-12-18T00:00:00.000Z' nullable: true type: string accountId: description: >- Unique identifier for the account associated with the recurring expense "982000000561057" example: '982000000561057' nullable: true type: string accountName: description: |- Expense account name eg. "Rent" example: Rent nullable: true type: string currency: description: |- Currency of the expense eg. "USD" example: USD nullable: true type: string total: description: |- Total amount in cents eg. "1000" example: 100 nullable: true type: integer customerId: description: |- Customer ID of the customer for whom the recurring invoice is raised eg. "982000000567001" example: '982000000567001' nullable: true type: string status: description: |- Status of the recurring expense eg. "active" example: active nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice details were last updated eg. "2013-11-18T02:17:40.080Z" example: '2021-09-15 00:00:00' nullable: true type: string format: date-time RecurringExpenseCreateResourceRequest3: description: '' type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- Unique identifier of the source 3rd party integration eg. 982000000567240 example: '982000000567240' nullable: false type: string recurrenceName: description: |- Name of the recurring-expense eg. "Monthly Rental" example: Monthly Rental nullable: true type: string startDate: description: |- Start date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2020-11-19T00:00:00.000Z' nullable: true type: string endDate: description: |- End date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2024-11-19T00:00:00.000Z' nullable: true type: string lastCreatedDate: description: |- When expense was last generated eg. "2013-11-18T00:00:00.000Z" example: '2021-11-18T00:00:00.000Z' nullable: true type: string recurrenceFrequency: description: >- The frequency of time interval at which the invoice is to be generated eg. "months" example: months nullable: true type: string repeatEvery: description: |- The period between every recurrency frequency eg. "2" example: '2' nullable: true type: string nextExpenseDate: description: |- Date the next expense will be generated eg. "2013-12-18T00:00:00.000Z" example: '2021-12-18T00:00:00.000Z' nullable: true type: string accountId: description: >- Unique identifier for the account associated with the recurring expense "982000000561057" example: '982000000561057' nullable: true type: string accountName: description: |- Expense account name eg. "Rent" example: Rent nullable: true type: string currency: description: |- Currency of the expense eg. "USD" example: USD nullable: true type: string total: description: |- Total amount in cents eg. "1000" example: 100 nullable: true type: integer customerId: description: |- Customer ID of the customer for whom the recurring invoice is raised eg. "982000000567001" example: '982000000567001' nullable: true type: string status: description: |- Status of the recurring expense eg. "active" example: active nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice details were last updated eg. "2013-11-18T02:17:40.080Z" example: '2021-09-15 00:00:00' nullable: true type: string format: date-time RecurringExpenseCreateResourceRequest4: description: '' type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- Unique identifier of the source 3rd party integration eg. 982000000567240 example: '982000000567240' nullable: false type: string recurrenceName: description: |- Name of the recurring-expense eg. "Monthly Rental" example: Monthly Rental nullable: true type: string startDate: description: |- Start date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2020-11-19T00:00:00.000Z' nullable: true type: string endDate: description: |- End date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2024-11-19T00:00:00.000Z' nullable: true type: string lastCreatedDate: description: |- When expense was last generated eg. "2013-11-18T00:00:00.000Z" example: '2021-11-18T00:00:00.000Z' nullable: true type: string recurrenceFrequency: description: >- The frequency of time interval at which the invoice is to be generated eg. "months" example: months nullable: true type: string repeatEvery: description: |- The period between every recurrency frequency eg. "2" example: '2' nullable: true type: string nextExpenseDate: description: |- Date the next expense will be generated eg. "2013-12-18T00:00:00.000Z" example: '2021-12-18T00:00:00.000Z' nullable: true type: string accountId: description: >- Unique identifier for the account associated with the recurring expense "982000000561057" example: '982000000561057' nullable: true type: string accountName: description: |- Expense account name eg. "Rent" example: Rent nullable: true type: string currency: description: |- Currency of the expense eg. "USD" example: USD nullable: true type: string total: description: |- Total amount in cents eg. "1000" example: 100 nullable: true type: integer customerId: description: |- Customer ID of the customer for whom the recurring invoice is raised eg. "982000000567001" example: '982000000567001' nullable: true type: string status: description: |- Status of the recurring expense eg. "active" example: active nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice details were last updated eg. "2013-11-18T02:17:40.080Z" example: '2021-09-15 00:00:00' nullable: true type: string format: date-time RecurringExpenseReplaceResourceRequest: description: '' type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- Unique identifier of the source 3rd party integration eg. 982000000567240 example: '982000000567240' nullable: false type: string recurrenceName: description: |- Name of the recurring-expense eg. "Monthly Rental" example: Monthly Rental nullable: true type: string startDate: description: |- Start date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2020-11-19T00:00:00.000Z' nullable: true type: string endDate: description: |- End date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2024-11-19T00:00:00.000Z' nullable: true type: string lastCreatedDate: description: |- When expense was last generated eg. "2013-11-18T00:00:00.000Z" example: '2021-11-18T00:00:00.000Z' nullable: true type: string recurrenceFrequency: description: >- The frequency of time interval at which the invoice is to be generated eg. "months" example: months nullable: true type: string repeatEvery: description: |- The period between every recurrency frequency eg. "2" example: '2' nullable: true type: string nextExpenseDate: description: |- Date the next expense will be generated eg. "2013-12-18T00:00:00.000Z" example: '2021-12-18T00:00:00.000Z' nullable: true type: string accountId: description: >- Unique identifier for the account associated with the recurring expense "982000000561057" example: '982000000561057' nullable: true type: string accountName: description: |- Expense account name eg. "Rent" example: Rent nullable: true type: string currency: description: |- Currency of the expense eg. "USD" example: USD nullable: true type: string total: description: |- Total amount in cents eg. "1000" example: 100 nullable: true type: integer customerId: description: |- Customer ID of the customer for whom the recurring invoice is raised eg. "982000000567001" example: '982000000567001' nullable: true type: string status: description: |- Status of the recurring expense eg. "active" example: active nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice details were last updated eg. "2013-11-18T02:17:40.080Z" example: '2021-09-15 00:00:00' nullable: true type: string format: date-time RecurringExpenseReplaceResourceRequest1: description: '' type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- Unique identifier of the source 3rd party integration eg. 982000000567240 example: '982000000567240' nullable: false type: string recurrenceName: description: |- Name of the recurring-expense eg. "Monthly Rental" example: Monthly Rental nullable: true type: string startDate: description: |- Start date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2020-11-19T00:00:00.000Z' nullable: true type: string endDate: description: |- End date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2024-11-19T00:00:00.000Z' nullable: true type: string lastCreatedDate: description: |- When expense was last generated eg. "2013-11-18T00:00:00.000Z" example: '2021-11-18T00:00:00.000Z' nullable: true type: string recurrenceFrequency: description: >- The frequency of time interval at which the invoice is to be generated eg. "months" example: months nullable: true type: string repeatEvery: description: |- The period between every recurrency frequency eg. "2" example: '2' nullable: true type: string nextExpenseDate: description: |- Date the next expense will be generated eg. "2013-12-18T00:00:00.000Z" example: '2021-12-18T00:00:00.000Z' nullable: true type: string accountId: description: >- Unique identifier for the account associated with the recurring expense "982000000561057" example: '982000000561057' nullable: true type: string accountName: description: |- Expense account name eg. "Rent" example: Rent nullable: true type: string currency: description: |- Currency of the expense eg. "USD" example: USD nullable: true type: string total: description: |- Total amount in cents eg. "1000" example: 100 nullable: true type: integer customerId: description: |- Customer ID of the customer for whom the recurring invoice is raised eg. "982000000567001" example: '982000000567001' nullable: true type: string status: description: |- Status of the recurring expense eg. "active" example: active nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice details were last updated eg. "2013-11-18T02:17:40.080Z" example: '2021-09-15 00:00:00' nullable: true type: string format: date-time RecurringExpenseReplaceResourceRequest2: description: '' type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- Unique identifier of the source 3rd party integration eg. 982000000567240 example: '982000000567240' nullable: false type: string recurrenceName: description: |- Name of the recurring-expense eg. "Monthly Rental" example: Monthly Rental nullable: true type: string startDate: description: |- Start date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2020-11-19T00:00:00.000Z' nullable: true type: string endDate: description: |- End date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2024-11-19T00:00:00.000Z' nullable: true type: string lastCreatedDate: description: |- When expense was last generated eg. "2013-11-18T00:00:00.000Z" example: '2021-11-18T00:00:00.000Z' nullable: true type: string recurrenceFrequency: description: >- The frequency of time interval at which the invoice is to be generated eg. "months" example: months nullable: true type: string repeatEvery: description: |- The period between every recurrency frequency eg. "2" example: '2' nullable: true type: string nextExpenseDate: description: |- Date the next expense will be generated eg. "2013-12-18T00:00:00.000Z" example: '2021-12-18T00:00:00.000Z' nullable: true type: string accountId: description: >- Unique identifier for the account associated with the recurring expense "982000000561057" example: '982000000561057' nullable: true type: string accountName: description: |- Expense account name eg. "Rent" example: Rent nullable: true type: string currency: description: |- Currency of the expense eg. "USD" example: USD nullable: true type: string total: description: |- Total amount in cents eg. "1000" example: 100 nullable: true type: integer customerId: description: |- Customer ID of the customer for whom the recurring invoice is raised eg. "982000000567001" example: '982000000567001' nullable: true type: string status: description: |- Status of the recurring expense eg. "active" example: active nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice details were last updated eg. "2013-11-18T02:17:40.080Z" example: '2021-09-15 00:00:00' nullable: true type: string format: date-time RecurringExpenseReplaceResourceRequest3: description: '' type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- Unique identifier of the source 3rd party integration eg. 982000000567240 example: '982000000567240' nullable: false type: string recurrenceName: description: |- Name of the recurring-expense eg. "Monthly Rental" example: Monthly Rental nullable: true type: string startDate: description: |- Start date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2020-11-19T00:00:00.000Z' nullable: true type: string endDate: description: |- End date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2024-11-19T00:00:00.000Z' nullable: true type: string lastCreatedDate: description: |- When expense was last generated eg. "2013-11-18T00:00:00.000Z" example: '2021-11-18T00:00:00.000Z' nullable: true type: string recurrenceFrequency: description: >- The frequency of time interval at which the invoice is to be generated eg. "months" example: months nullable: true type: string repeatEvery: description: |- The period between every recurrency frequency eg. "2" example: '2' nullable: true type: string nextExpenseDate: description: |- Date the next expense will be generated eg. "2013-12-18T00:00:00.000Z" example: '2021-12-18T00:00:00.000Z' nullable: true type: string accountId: description: >- Unique identifier for the account associated with the recurring expense "982000000561057" example: '982000000561057' nullable: true type: string accountName: description: |- Expense account name eg. "Rent" example: Rent nullable: true type: string currency: description: |- Currency of the expense eg. "USD" example: USD nullable: true type: string total: description: |- Total amount in cents eg. "1000" example: 100 nullable: true type: integer customerId: description: |- Customer ID of the customer for whom the recurring invoice is raised eg. "982000000567001" example: '982000000567001' nullable: true type: string status: description: |- Status of the recurring expense eg. "active" example: active nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice details were last updated eg. "2013-11-18T02:17:40.080Z" example: '2021-09-15 00:00:00' nullable: true type: string format: date-time RecurringExpenseReplaceResourceRequest4: description: '' type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- Unique identifier of the source 3rd party integration eg. 982000000567240 example: '982000000567240' nullable: false type: string recurrenceName: description: |- Name of the recurring-expense eg. "Monthly Rental" example: Monthly Rental nullable: true type: string startDate: description: |- Start date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2020-11-19T00:00:00.000Z' nullable: true type: string endDate: description: |- End date of the recurring expense eg. 2016-11-19T00:00:00.000Z example: '2024-11-19T00:00:00.000Z' nullable: true type: string lastCreatedDate: description: |- When expense was last generated eg. "2013-11-18T00:00:00.000Z" example: '2021-11-18T00:00:00.000Z' nullable: true type: string recurrenceFrequency: description: >- The frequency of time interval at which the invoice is to be generated eg. "months" example: months nullable: true type: string repeatEvery: description: |- The period between every recurrency frequency eg. "2" example: '2' nullable: true type: string nextExpenseDate: description: |- Date the next expense will be generated eg. "2013-12-18T00:00:00.000Z" example: '2021-12-18T00:00:00.000Z' nullable: true type: string accountId: description: >- Unique identifier for the account associated with the recurring expense "982000000561057" example: '982000000561057' nullable: true type: string accountName: description: |- Expense account name eg. "Rent" example: Rent nullable: true type: string currency: description: |- Currency of the expense eg. "USD" example: USD nullable: true type: string total: description: |- Total amount in cents eg. "1000" example: 100 nullable: true type: integer customerId: description: |- Customer ID of the customer for whom the recurring invoice is raised eg. "982000000567001" example: '982000000567001' nullable: true type: string status: description: |- Status of the recurring expense eg. "active" example: active nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice details were last updated eg. "2013-11-18T02:17:40.080Z" example: '2021-09-15 00:00:00' nullable: true type: string format: date-time RefundCreateResourceRequest: description: Refund captures funds that are refunded to a credit or debit card type: object properties: id: example: quickbooks-66 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string accountId: example: '35' nullable: false type: string currency: description: Currency the refund was made in example: USD nullable: true type: string paymentRef: description: >- Transaction number that appears on email receipts sent for this refund example: USD nullable: true type: string txnDate: description: The date and time the refund was created example: '2021-06-24' nullable: true type: string totalAmount: description: Total amount refunded example: 8750 nullable: false type: integer balance: example: 0 nullable: true type: integer customerId: example: '15' nullable: true type: string created: description: The date and time the refund was created example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time modified: example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time srcId: description: Unique identifier for each refund example: '66' nullable: false type: string reason: description: Reason for refund example: bad item nullable: true type: string status: description: |- Status of refund e.g. "pending" e.g. "succeeded" e.g. "failed" example: succeeded nullable: true type: string RefundCreateResourceRequest1: description: Refund captures funds that are refunded to a credit or debit card type: object properties: id: example: quickbooks-66 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string accountId: example: '35' nullable: false type: string currency: description: Currency the refund was made in example: USD nullable: true type: string paymentRef: description: >- Transaction number that appears on email receipts sent for this refund example: USD nullable: true type: string txnDate: description: The date and time the refund was created example: '2021-06-24' nullable: true type: string totalAmount: description: Total amount refunded example: 8750 nullable: false type: integer balance: example: 0 nullable: true type: integer customerId: example: '15' nullable: true type: string created: description: The date and time the refund was created example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time modified: example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time srcId: description: Unique identifier for each refund example: '66' nullable: false type: string reason: description: Reason for refund example: bad item nullable: true type: string status: description: |- Status of refund e.g. "pending" e.g. "succeeded" e.g. "failed" example: succeeded nullable: true type: string RefundCreateResourceRequest2: description: Refund captures funds that are refunded to a credit or debit card type: object properties: id: example: quickbooks-66 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string accountId: example: '35' nullable: false type: string currency: description: Currency the refund was made in example: USD nullable: true type: string paymentRef: description: >- Transaction number that appears on email receipts sent for this refund example: USD nullable: true type: string txnDate: description: The date and time the refund was created example: '2021-06-24' nullable: true type: string totalAmount: description: Total amount refunded example: 8750 nullable: false type: integer balance: example: 0 nullable: true type: integer customerId: example: '15' nullable: true type: string created: description: The date and time the refund was created example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time modified: example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time srcId: description: Unique identifier for each refund example: '66' nullable: false type: string reason: description: Reason for refund example: bad item nullable: true type: string status: description: |- Status of refund e.g. "pending" e.g. "succeeded" e.g. "failed" example: succeeded nullable: true type: string RefundCreateResourceRequest3: description: Refund captures funds that are refunded to a credit or debit card type: object properties: id: example: quickbooks-66 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string accountId: example: '35' nullable: false type: string currency: description: Currency the refund was made in example: USD nullable: true type: string paymentRef: description: >- Transaction number that appears on email receipts sent for this refund example: USD nullable: true type: string txnDate: description: The date and time the refund was created example: '2021-06-24' nullable: true type: string totalAmount: description: Total amount refunded example: 8750 nullable: false type: integer balance: example: 0 nullable: true type: integer customerId: example: '15' nullable: true type: string created: description: The date and time the refund was created example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time modified: example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time srcId: description: Unique identifier for each refund example: '66' nullable: false type: string reason: description: Reason for refund example: bad item nullable: true type: string status: description: |- Status of refund e.g. "pending" e.g. "succeeded" e.g. "failed" example: succeeded nullable: true type: string RefundCreateResourceRequest4: description: Refund captures funds that are refunded to a credit or debit card type: object properties: id: example: quickbooks-66 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string accountId: example: '35' nullable: false type: string currency: description: Currency the refund was made in example: USD nullable: true type: string paymentRef: description: >- Transaction number that appears on email receipts sent for this refund example: USD nullable: true type: string txnDate: description: The date and time the refund was created example: '2021-06-24' nullable: true type: string totalAmount: description: Total amount refunded example: 8750 nullable: false type: integer balance: example: 0 nullable: true type: integer customerId: example: '15' nullable: true type: string created: description: The date and time the refund was created example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time modified: example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time srcId: description: Unique identifier for each refund example: '66' nullable: false type: string reason: description: Reason for refund example: bad item nullable: true type: string status: description: |- Status of refund e.g. "pending" e.g. "succeeded" e.g. "failed" example: succeeded nullable: true type: string RefundReplaceResourceRequest: description: Refund captures funds that are refunded to a credit or debit card type: object properties: id: example: quickbooks-66 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string accountId: example: '35' nullable: false type: string currency: description: Currency the refund was made in example: USD nullable: true type: string paymentRef: description: >- Transaction number that appears on email receipts sent for this refund example: USD nullable: true type: string txnDate: description: The date and time the refund was created example: '2021-06-24' nullable: true type: string totalAmount: description: Total amount refunded example: 8750 nullable: false type: integer balance: example: 0 nullable: true type: integer customerId: example: '15' nullable: true type: string created: description: The date and time the refund was created example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time modified: example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time srcId: description: Unique identifier for each refund example: '66' nullable: false type: string reason: description: Reason for refund example: bad item nullable: true type: string status: description: |- Status of refund e.g. "pending" e.g. "succeeded" e.g. "failed" example: succeeded nullable: true type: string RefundReplaceResourceRequest1: description: Refund captures funds that are refunded to a credit or debit card type: object properties: id: example: quickbooks-66 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string accountId: example: '35' nullable: false type: string currency: description: Currency the refund was made in example: USD nullable: true type: string paymentRef: description: >- Transaction number that appears on email receipts sent for this refund example: USD nullable: true type: string txnDate: description: The date and time the refund was created example: '2021-06-24' nullable: true type: string totalAmount: description: Total amount refunded example: 8750 nullable: false type: integer balance: example: 0 nullable: true type: integer customerId: example: '15' nullable: true type: string created: description: The date and time the refund was created example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time modified: example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time srcId: description: Unique identifier for each refund example: '66' nullable: false type: string reason: description: Reason for refund example: bad item nullable: true type: string status: description: |- Status of refund e.g. "pending" e.g. "succeeded" e.g. "failed" example: succeeded nullable: true type: string RefundReplaceResourceRequest2: description: Refund captures funds that are refunded to a credit or debit card type: object properties: id: example: quickbooks-66 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string accountId: example: '35' nullable: false type: string currency: description: Currency the refund was made in example: USD nullable: true type: string paymentRef: description: >- Transaction number that appears on email receipts sent for this refund example: USD nullable: true type: string txnDate: description: The date and time the refund was created example: '2021-06-24' nullable: true type: string totalAmount: description: Total amount refunded example: 8750 nullable: false type: integer balance: example: 0 nullable: true type: integer customerId: example: '15' nullable: true type: string created: description: The date and time the refund was created example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time modified: example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time srcId: description: Unique identifier for each refund example: '66' nullable: false type: string reason: description: Reason for refund example: bad item nullable: true type: string status: description: |- Status of refund e.g. "pending" e.g. "succeeded" e.g. "failed" example: succeeded nullable: true type: string RefundReplaceResourceRequest3: description: Refund captures funds that are refunded to a credit or debit card type: object properties: id: example: quickbooks-66 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string accountId: example: '35' nullable: false type: string currency: description: Currency the refund was made in example: USD nullable: true type: string paymentRef: description: >- Transaction number that appears on email receipts sent for this refund example: USD nullable: true type: string txnDate: description: The date and time the refund was created example: '2021-06-24' nullable: true type: string totalAmount: description: Total amount refunded example: 8750 nullable: false type: integer balance: example: 0 nullable: true type: integer customerId: example: '15' nullable: true type: string created: description: The date and time the refund was created example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time modified: example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time srcId: description: Unique identifier for each refund example: '66' nullable: false type: string reason: description: Reason for refund example: bad item nullable: true type: string status: description: |- Status of refund e.g. "pending" e.g. "succeeded" e.g. "failed" example: succeeded nullable: true type: string RefundReplaceResourceRequest4: description: Refund captures funds that are refunded to a credit or debit card type: object properties: id: example: quickbooks-66 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string accountId: example: '35' nullable: false type: string currency: description: Currency the refund was made in example: USD nullable: true type: string paymentRef: description: >- Transaction number that appears on email receipts sent for this refund example: USD nullable: true type: string txnDate: description: The date and time the refund was created example: '2021-06-24' nullable: true type: string totalAmount: description: Total amount refunded example: 8750 nullable: false type: integer balance: example: 0 nullable: true type: integer customerId: example: '15' nullable: true type: string created: description: The date and time the refund was created example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time modified: example: '2021-06-24T22:35:07+00:00' nullable: true type: string format: date-time srcId: description: Unique identifier for each refund example: '66' nullable: false type: string reason: description: Reason for refund example: bad item nullable: true type: string status: description: |- Status of refund e.g. "pending" e.g. "succeeded" e.g. "failed" example: succeeded nullable: true type: string RepeatingInvoiceCreateResourceRequest: description: >- Repeating invoice represents invoices that are automatically created at regular intervals type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for each repeating invoice example: 01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false type: string period: description: Number of times the invoice is charged per unit example: 1 nullable: true type: integer unit: description: |- Interval unit defining how often the invoice is charged e.g. WEEKLY e.g. MONTHLY example: MONTHLY nullable: true type: string dueDate: description: Number of days defining when the invoice is scheduled to be charged example: '0' nullable: true type: string dueDateType: description: |- The type of billing used together with due date e.g. "DAYSAFTERBILLDATE" e.g. "DAYSAFTERBILLMONTH" e.g. "OFCURRENTMONTH" e.g. "OFFOLLOWINGMONTH" example: DAYSAFTERBILLDATE nullable: true type: string startDate: description: date on which the recurring invoice starts example: '2021-02-27 00:00:00' nullable: true type: string nextScheduledDate: description: date at which next invoice is to be sent example: '2021-07-28 00:00:00' nullable: true type: string type: description: |- The type of invoice e.g. "ACCPAY" e.g. "ACCREC" example: ACCPAY nullable: true type: string reference: description: Order number of recurring invoice example: AP nullable: true type: string hasAttachments: description: Whether the invoice has attachments or not example: false nullable: true type: boolean contactId: description: Id of customer for whom recurring invoice is raised example: 3b30a108-9156-4a42-a893-3bbbe7af1ef8 nullable: true type: string contactName: description: Full name of contact example: Xero nullable: true type: string status: description: |- Status of the repeating invoice e.g. "DRAFT" e.g. "AUTHORISED" example: AUTHORISED nullable: true type: string lineAmountTypes: description: Whether the line amount includes, excludes or doesn't have tax. example: Exclusive nullable: true type: string lineItemDescription: description: A description of the line item example: Monthly subscription nullable: true type: string lineItemUnitAmount: description: The unit amount of the line item example: 29 nullable: true type: integer lineItemTaxType: description: |- The type of tax applied to line items e.g. "OUTPUT" e.g. "INPUT" e.g. "CAPEXINPUT" example: INPUT nullable: true type: string lineAmount: description: The final amount for the line items example: 29 nullable: true type: integer lineItemAccountCode: description: Account code for the line item example: '412' nullable: true type: string lineItemQuantity: description: The quantity of the line items example: 1 nullable: true type: integer lineItemId: description: Unique ID for the line item example: 304e5b38-d62f-4c43-91d2-24786154c3c0 nullable: true type: string subTotal: description: Total of invoice excluding taxes example: 2900 nullable: true type: integer totalTax: description: Total tax on invoice example: 239 nullable: true type: integer total: description: Total of invoice tax inclusive example: 3139 nullable: false type: integer currencyCode: description: currency of invoice example: USD nullable: true type: string recurrenceName: description: Unique name for the recurring profile given by the user example: '412' nullable: true type: string endDate: description: date on which the recurring invoice expires example: '2022-07-28 00:00:00' nullable: true type: string lastSentDate: description: date at which the last invoice was sent example: '2021-08-28 00:00:00' nullable: true type: string paidInvoicesTotal: description: total amount paid to date example: 1000 nullable: true type: integer unpaidInvoicesBalance: description: total amount left to be paid example: 2139 nullable: true 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 RepeatingInvoiceCreateResourceRequest1: description: >- Repeating invoice represents invoices that are automatically created at regular intervals type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for each repeating invoice example: 01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false type: string period: description: Number of times the invoice is charged per unit example: 1 nullable: true type: integer unit: description: |- Interval unit defining how often the invoice is charged e.g. WEEKLY e.g. MONTHLY example: MONTHLY nullable: true type: string dueDate: description: Number of days defining when the invoice is scheduled to be charged example: '0' nullable: true type: string dueDateType: description: |- The type of billing used together with due date e.g. "DAYSAFTERBILLDATE" e.g. "DAYSAFTERBILLMONTH" e.g. "OFCURRENTMONTH" e.g. "OFFOLLOWINGMONTH" example: DAYSAFTERBILLDATE nullable: true type: string startDate: description: date on which the recurring invoice starts example: '2021-02-27 00:00:00' nullable: true type: string nextScheduledDate: description: date at which next invoice is to be sent example: '2021-07-28 00:00:00' nullable: true type: string type: description: |- The type of invoice e.g. "ACCPAY" e.g. "ACCREC" example: ACCPAY nullable: true type: string reference: description: Order number of recurring invoice example: AP nullable: true type: string hasAttachments: description: Whether the invoice has attachments or not example: false nullable: true type: boolean contactId: description: Id of customer for whom recurring invoice is raised example: 3b30a108-9156-4a42-a893-3bbbe7af1ef8 nullable: true type: string contactName: description: Full name of contact example: Xero nullable: true type: string status: description: |- Status of the repeating invoice e.g. "DRAFT" e.g. "AUTHORISED" example: AUTHORISED nullable: true type: string lineAmountTypes: description: Whether the line amount includes, excludes or doesn't have tax. example: Exclusive nullable: true type: string lineItemDescription: description: A description of the line item example: Monthly subscription nullable: true type: string lineItemUnitAmount: description: The unit amount of the line item example: 29 nullable: true type: integer lineItemTaxType: description: |- The type of tax applied to line items e.g. "OUTPUT" e.g. "INPUT" e.g. "CAPEXINPUT" example: INPUT nullable: true type: string lineAmount: description: The final amount for the line items example: 29 nullable: true type: integer lineItemAccountCode: description: Account code for the line item example: '412' nullable: true type: string lineItemQuantity: description: The quantity of the line items example: 1 nullable: true type: integer lineItemId: description: Unique ID for the line item example: 304e5b38-d62f-4c43-91d2-24786154c3c0 nullable: true type: string subTotal: description: Total of invoice excluding taxes example: 2900 nullable: true type: integer totalTax: description: Total tax on invoice example: 239 nullable: true type: integer total: description: Total of invoice tax inclusive example: 3139 nullable: false type: integer currencyCode: description: currency of invoice example: USD nullable: true type: string recurrenceName: description: Unique name for the recurring profile given by the user example: '412' nullable: true type: string endDate: description: date on which the recurring invoice expires example: '2022-07-28 00:00:00' nullable: true type: string lastSentDate: description: date at which the last invoice was sent example: '2021-08-28 00:00:00' nullable: true type: string paidInvoicesTotal: description: total amount paid to date example: 1000 nullable: true type: integer unpaidInvoicesBalance: description: total amount left to be paid example: 2139 nullable: true 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 RepeatingInvoiceCreateResourceRequest2: description: >- Repeating invoice represents invoices that are automatically created at regular intervals type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for each repeating invoice example: 01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false type: string period: description: Number of times the invoice is charged per unit example: 1 nullable: true type: integer unit: description: |- Interval unit defining how often the invoice is charged e.g. WEEKLY e.g. MONTHLY example: MONTHLY nullable: true type: string dueDate: description: Number of days defining when the invoice is scheduled to be charged example: '0' nullable: true type: string dueDateType: description: |- The type of billing used together with due date e.g. "DAYSAFTERBILLDATE" e.g. "DAYSAFTERBILLMONTH" e.g. "OFCURRENTMONTH" e.g. "OFFOLLOWINGMONTH" example: DAYSAFTERBILLDATE nullable: true type: string startDate: description: date on which the recurring invoice starts example: '2021-02-27 00:00:00' nullable: true type: string nextScheduledDate: description: date at which next invoice is to be sent example: '2021-07-28 00:00:00' nullable: true type: string type: description: |- The type of invoice e.g. "ACCPAY" e.g. "ACCREC" example: ACCPAY nullable: true type: string reference: description: Order number of recurring invoice example: AP nullable: true type: string hasAttachments: description: Whether the invoice has attachments or not example: false nullable: true type: boolean contactId: description: Id of customer for whom recurring invoice is raised example: 3b30a108-9156-4a42-a893-3bbbe7af1ef8 nullable: true type: string contactName: description: Full name of contact example: Xero nullable: true type: string status: description: |- Status of the repeating invoice e.g. "DRAFT" e.g. "AUTHORISED" example: AUTHORISED nullable: true type: string lineAmountTypes: description: Whether the line amount includes, excludes or doesn't have tax. example: Exclusive nullable: true type: string lineItemDescription: description: A description of the line item example: Monthly subscription nullable: true type: string lineItemUnitAmount: description: The unit amount of the line item example: 29 nullable: true type: integer lineItemTaxType: description: |- The type of tax applied to line items e.g. "OUTPUT" e.g. "INPUT" e.g. "CAPEXINPUT" example: INPUT nullable: true type: string lineAmount: description: The final amount for the line items example: 29 nullable: true type: integer lineItemAccountCode: description: Account code for the line item example: '412' nullable: true type: string lineItemQuantity: description: The quantity of the line items example: 1 nullable: true type: integer lineItemId: description: Unique ID for the line item example: 304e5b38-d62f-4c43-91d2-24786154c3c0 nullable: true type: string subTotal: description: Total of invoice excluding taxes example: 2900 nullable: true type: integer totalTax: description: Total tax on invoice example: 239 nullable: true type: integer total: description: Total of invoice tax inclusive example: 3139 nullable: false type: integer currencyCode: description: currency of invoice example: USD nullable: true type: string recurrenceName: description: Unique name for the recurring profile given by the user example: '412' nullable: true type: string endDate: description: date on which the recurring invoice expires example: '2022-07-28 00:00:00' nullable: true type: string lastSentDate: description: date at which the last invoice was sent example: '2021-08-28 00:00:00' nullable: true type: string paidInvoicesTotal: description: total amount paid to date example: 1000 nullable: true type: integer unpaidInvoicesBalance: description: total amount left to be paid example: 2139 nullable: true 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 RepeatingInvoiceCreateResourceRequest3: description: >- Repeating invoice represents invoices that are automatically created at regular intervals type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for each repeating invoice example: 01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false type: string period: description: Number of times the invoice is charged per unit example: 1 nullable: true type: integer unit: description: |- Interval unit defining how often the invoice is charged e.g. WEEKLY e.g. MONTHLY example: MONTHLY nullable: true type: string dueDate: description: Number of days defining when the invoice is scheduled to be charged example: '0' nullable: true type: string dueDateType: description: |- The type of billing used together with due date e.g. "DAYSAFTERBILLDATE" e.g. "DAYSAFTERBILLMONTH" e.g. "OFCURRENTMONTH" e.g. "OFFOLLOWINGMONTH" example: DAYSAFTERBILLDATE nullable: true type: string startDate: description: date on which the recurring invoice starts example: '2021-02-27 00:00:00' nullable: true type: string nextScheduledDate: description: date at which next invoice is to be sent example: '2021-07-28 00:00:00' nullable: true type: string type: description: |- The type of invoice e.g. "ACCPAY" e.g. "ACCREC" example: ACCPAY nullable: true type: string reference: description: Order number of recurring invoice example: AP nullable: true type: string hasAttachments: description: Whether the invoice has attachments or not example: false nullable: true type: boolean contactId: description: Id of customer for whom recurring invoice is raised example: 3b30a108-9156-4a42-a893-3bbbe7af1ef8 nullable: true type: string contactName: description: Full name of contact example: Xero nullable: true type: string status: description: |- Status of the repeating invoice e.g. "DRAFT" e.g. "AUTHORISED" example: AUTHORISED nullable: true type: string lineAmountTypes: description: Whether the line amount includes, excludes or doesn't have tax. example: Exclusive nullable: true type: string lineItemDescription: description: A description of the line item example: Monthly subscription nullable: true type: string lineItemUnitAmount: description: The unit amount of the line item example: 29 nullable: true type: integer lineItemTaxType: description: |- The type of tax applied to line items e.g. "OUTPUT" e.g. "INPUT" e.g. "CAPEXINPUT" example: INPUT nullable: true type: string lineAmount: description: The final amount for the line items example: 29 nullable: true type: integer lineItemAccountCode: description: Account code for the line item example: '412' nullable: true type: string lineItemQuantity: description: The quantity of the line items example: 1 nullable: true type: integer lineItemId: description: Unique ID for the line item example: 304e5b38-d62f-4c43-91d2-24786154c3c0 nullable: true type: string subTotal: description: Total of invoice excluding taxes example: 2900 nullable: true type: integer totalTax: description: Total tax on invoice example: 239 nullable: true type: integer total: description: Total of invoice tax inclusive example: 3139 nullable: false type: integer currencyCode: description: currency of invoice example: USD nullable: true type: string recurrenceName: description: Unique name for the recurring profile given by the user example: '412' nullable: true type: string endDate: description: date on which the recurring invoice expires example: '2022-07-28 00:00:00' nullable: true type: string lastSentDate: description: date at which the last invoice was sent example: '2021-08-28 00:00:00' nullable: true type: string paidInvoicesTotal: description: total amount paid to date example: 1000 nullable: true type: integer unpaidInvoicesBalance: description: total amount left to be paid example: 2139 nullable: true 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 RepeatingInvoiceCreateResourceRequest4: description: >- Repeating invoice represents invoices that are automatically created at regular intervals type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for each repeating invoice example: 01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false type: string period: description: Number of times the invoice is charged per unit example: 1 nullable: true type: integer unit: description: |- Interval unit defining how often the invoice is charged e.g. WEEKLY e.g. MONTHLY example: MONTHLY nullable: true type: string dueDate: description: Number of days defining when the invoice is scheduled to be charged example: '0' nullable: true type: string dueDateType: description: |- The type of billing used together with due date e.g. "DAYSAFTERBILLDATE" e.g. "DAYSAFTERBILLMONTH" e.g. "OFCURRENTMONTH" e.g. "OFFOLLOWINGMONTH" example: DAYSAFTERBILLDATE nullable: true type: string startDate: description: date on which the recurring invoice starts example: '2021-02-27 00:00:00' nullable: true type: string nextScheduledDate: description: date at which next invoice is to be sent example: '2021-07-28 00:00:00' nullable: true type: string type: description: |- The type of invoice e.g. "ACCPAY" e.g. "ACCREC" example: ACCPAY nullable: true type: string reference: description: Order number of recurring invoice example: AP nullable: true type: string hasAttachments: description: Whether the invoice has attachments or not example: false nullable: true type: boolean contactId: description: Id of customer for whom recurring invoice is raised example: 3b30a108-9156-4a42-a893-3bbbe7af1ef8 nullable: true type: string contactName: description: Full name of contact example: Xero nullable: true type: string status: description: |- Status of the repeating invoice e.g. "DRAFT" e.g. "AUTHORISED" example: AUTHORISED nullable: true type: string lineAmountTypes: description: Whether the line amount includes, excludes or doesn't have tax. example: Exclusive nullable: true type: string lineItemDescription: description: A description of the line item example: Monthly subscription nullable: true type: string lineItemUnitAmount: description: The unit amount of the line item example: 29 nullable: true type: integer lineItemTaxType: description: |- The type of tax applied to line items e.g. "OUTPUT" e.g. "INPUT" e.g. "CAPEXINPUT" example: INPUT nullable: true type: string lineAmount: description: The final amount for the line items example: 29 nullable: true type: integer lineItemAccountCode: description: Account code for the line item example: '412' nullable: true type: string lineItemQuantity: description: The quantity of the line items example: 1 nullable: true type: integer lineItemId: description: Unique ID for the line item example: 304e5b38-d62f-4c43-91d2-24786154c3c0 nullable: true type: string subTotal: description: Total of invoice excluding taxes example: 2900 nullable: true type: integer totalTax: description: Total tax on invoice example: 239 nullable: true type: integer total: description: Total of invoice tax inclusive example: 3139 nullable: false type: integer currencyCode: description: currency of invoice example: USD nullable: true type: string recurrenceName: description: Unique name for the recurring profile given by the user example: '412' nullable: true type: string endDate: description: date on which the recurring invoice expires example: '2022-07-28 00:00:00' nullable: true type: string lastSentDate: description: date at which the last invoice was sent example: '2021-08-28 00:00:00' nullable: true type: string paidInvoicesTotal: description: total amount paid to date example: 1000 nullable: true type: integer unpaidInvoicesBalance: description: total amount left to be paid example: 2139 nullable: true 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 RepeatingInvoiceReplaceResourceRequest: description: >- Repeating invoice represents invoices that are automatically created at regular intervals type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for each repeating invoice example: 01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false type: string period: description: Number of times the invoice is charged per unit example: 1 nullable: true type: integer unit: description: |- Interval unit defining how often the invoice is charged e.g. WEEKLY e.g. MONTHLY example: MONTHLY nullable: true type: string dueDate: description: Number of days defining when the invoice is scheduled to be charged example: '0' nullable: true type: string dueDateType: description: |- The type of billing used together with due date e.g. "DAYSAFTERBILLDATE" e.g. "DAYSAFTERBILLMONTH" e.g. "OFCURRENTMONTH" e.g. "OFFOLLOWINGMONTH" example: DAYSAFTERBILLDATE nullable: true type: string startDate: description: date on which the recurring invoice starts example: '2021-02-27 00:00:00' nullable: true type: string nextScheduledDate: description: date at which next invoice is to be sent example: '2021-07-28 00:00:00' nullable: true type: string type: description: |- The type of invoice e.g. "ACCPAY" e.g. "ACCREC" example: ACCPAY nullable: true type: string reference: description: Order number of recurring invoice example: AP nullable: true type: string hasAttachments: description: Whether the invoice has attachments or not example: false nullable: true type: boolean contactId: description: Id of customer for whom recurring invoice is raised example: 3b30a108-9156-4a42-a893-3bbbe7af1ef8 nullable: true type: string contactName: description: Full name of contact example: Xero nullable: true type: string status: description: |- Status of the repeating invoice e.g. "DRAFT" e.g. "AUTHORISED" example: AUTHORISED nullable: true type: string lineAmountTypes: description: Whether the line amount includes, excludes or doesn't have tax. example: Exclusive nullable: true type: string lineItemDescription: description: A description of the line item example: Monthly subscription nullable: true type: string lineItemUnitAmount: description: The unit amount of the line item example: 29 nullable: true type: integer lineItemTaxType: description: |- The type of tax applied to line items e.g. "OUTPUT" e.g. "INPUT" e.g. "CAPEXINPUT" example: INPUT nullable: true type: string lineAmount: description: The final amount for the line items example: 29 nullable: true type: integer lineItemAccountCode: description: Account code for the line item example: '412' nullable: true type: string lineItemQuantity: description: The quantity of the line items example: 1 nullable: true type: integer lineItemId: description: Unique ID for the line item example: 304e5b38-d62f-4c43-91d2-24786154c3c0 nullable: true type: string subTotal: description: Total of invoice excluding taxes example: 2900 nullable: true type: integer totalTax: description: Total tax on invoice example: 239 nullable: true type: integer total: description: Total of invoice tax inclusive example: 3139 nullable: false type: integer currencyCode: description: currency of invoice example: USD nullable: true type: string recurrenceName: description: Unique name for the recurring profile given by the user example: '412' nullable: true type: string endDate: description: date on which the recurring invoice expires example: '2022-07-28 00:00:00' nullable: true type: string lastSentDate: description: date at which the last invoice was sent example: '2021-08-28 00:00:00' nullable: true type: string paidInvoicesTotal: description: total amount paid to date example: 1000 nullable: true type: integer unpaidInvoicesBalance: description: total amount left to be paid example: 2139 nullable: true 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 RepeatingInvoiceReplaceResourceRequest1: description: >- Repeating invoice represents invoices that are automatically created at regular intervals type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for each repeating invoice example: 01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false type: string period: description: Number of times the invoice is charged per unit example: 1 nullable: true type: integer unit: description: |- Interval unit defining how often the invoice is charged e.g. WEEKLY e.g. MONTHLY example: MONTHLY nullable: true type: string dueDate: description: Number of days defining when the invoice is scheduled to be charged example: '0' nullable: true type: string dueDateType: description: |- The type of billing used together with due date e.g. "DAYSAFTERBILLDATE" e.g. "DAYSAFTERBILLMONTH" e.g. "OFCURRENTMONTH" e.g. "OFFOLLOWINGMONTH" example: DAYSAFTERBILLDATE nullable: true type: string startDate: description: date on which the recurring invoice starts example: '2021-02-27 00:00:00' nullable: true type: string nextScheduledDate: description: date at which next invoice is to be sent example: '2021-07-28 00:00:00' nullable: true type: string type: description: |- The type of invoice e.g. "ACCPAY" e.g. "ACCREC" example: ACCPAY nullable: true type: string reference: description: Order number of recurring invoice example: AP nullable: true type: string hasAttachments: description: Whether the invoice has attachments or not example: false nullable: true type: boolean contactId: description: Id of customer for whom recurring invoice is raised example: 3b30a108-9156-4a42-a893-3bbbe7af1ef8 nullable: true type: string contactName: description: Full name of contact example: Xero nullable: true type: string status: description: |- Status of the repeating invoice e.g. "DRAFT" e.g. "AUTHORISED" example: AUTHORISED nullable: true type: string lineAmountTypes: description: Whether the line amount includes, excludes or doesn't have tax. example: Exclusive nullable: true type: string lineItemDescription: description: A description of the line item example: Monthly subscription nullable: true type: string lineItemUnitAmount: description: The unit amount of the line item example: 29 nullable: true type: integer lineItemTaxType: description: |- The type of tax applied to line items e.g. "OUTPUT" e.g. "INPUT" e.g. "CAPEXINPUT" example: INPUT nullable: true type: string lineAmount: description: The final amount for the line items example: 29 nullable: true type: integer lineItemAccountCode: description: Account code for the line item example: '412' nullable: true type: string lineItemQuantity: description: The quantity of the line items example: 1 nullable: true type: integer lineItemId: description: Unique ID for the line item example: 304e5b38-d62f-4c43-91d2-24786154c3c0 nullable: true type: string subTotal: description: Total of invoice excluding taxes example: 2900 nullable: true type: integer totalTax: description: Total tax on invoice example: 239 nullable: true type: integer total: description: Total of invoice tax inclusive example: 3139 nullable: false type: integer currencyCode: description: currency of invoice example: USD nullable: true type: string recurrenceName: description: Unique name for the recurring profile given by the user example: '412' nullable: true type: string endDate: description: date on which the recurring invoice expires example: '2022-07-28 00:00:00' nullable: true type: string lastSentDate: description: date at which the last invoice was sent example: '2021-08-28 00:00:00' nullable: true type: string paidInvoicesTotal: description: total amount paid to date example: 1000 nullable: true type: integer unpaidInvoicesBalance: description: total amount left to be paid example: 2139 nullable: true 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 RepeatingInvoiceReplaceResourceRequest2: description: >- Repeating invoice represents invoices that are automatically created at regular intervals type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for each repeating invoice example: 01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false type: string period: description: Number of times the invoice is charged per unit example: 1 nullable: true type: integer unit: description: |- Interval unit defining how often the invoice is charged e.g. WEEKLY e.g. MONTHLY example: MONTHLY nullable: true type: string dueDate: description: Number of days defining when the invoice is scheduled to be charged example: '0' nullable: true type: string dueDateType: description: |- The type of billing used together with due date e.g. "DAYSAFTERBILLDATE" e.g. "DAYSAFTERBILLMONTH" e.g. "OFCURRENTMONTH" e.g. "OFFOLLOWINGMONTH" example: DAYSAFTERBILLDATE nullable: true type: string startDate: description: date on which the recurring invoice starts example: '2021-02-27 00:00:00' nullable: true type: string nextScheduledDate: description: date at which next invoice is to be sent example: '2021-07-28 00:00:00' nullable: true type: string type: description: |- The type of invoice e.g. "ACCPAY" e.g. "ACCREC" example: ACCPAY nullable: true type: string reference: description: Order number of recurring invoice example: AP nullable: true type: string hasAttachments: description: Whether the invoice has attachments or not example: false nullable: true type: boolean contactId: description: Id of customer for whom recurring invoice is raised example: 3b30a108-9156-4a42-a893-3bbbe7af1ef8 nullable: true type: string contactName: description: Full name of contact example: Xero nullable: true type: string status: description: |- Status of the repeating invoice e.g. "DRAFT" e.g. "AUTHORISED" example: AUTHORISED nullable: true type: string lineAmountTypes: description: Whether the line amount includes, excludes or doesn't have tax. example: Exclusive nullable: true type: string lineItemDescription: description: A description of the line item example: Monthly subscription nullable: true type: string lineItemUnitAmount: description: The unit amount of the line item example: 29 nullable: true type: integer lineItemTaxType: description: |- The type of tax applied to line items e.g. "OUTPUT" e.g. "INPUT" e.g. "CAPEXINPUT" example: INPUT nullable: true type: string lineAmount: description: The final amount for the line items example: 29 nullable: true type: integer lineItemAccountCode: description: Account code for the line item example: '412' nullable: true type: string lineItemQuantity: description: The quantity of the line items example: 1 nullable: true type: integer lineItemId: description: Unique ID for the line item example: 304e5b38-d62f-4c43-91d2-24786154c3c0 nullable: true type: string subTotal: description: Total of invoice excluding taxes example: 2900 nullable: true type: integer totalTax: description: Total tax on invoice example: 239 nullable: true type: integer total: description: Total of invoice tax inclusive example: 3139 nullable: false type: integer currencyCode: description: currency of invoice example: USD nullable: true type: string recurrenceName: description: Unique name for the recurring profile given by the user example: '412' nullable: true type: string endDate: description: date on which the recurring invoice expires example: '2022-07-28 00:00:00' nullable: true type: string lastSentDate: description: date at which the last invoice was sent example: '2021-08-28 00:00:00' nullable: true type: string paidInvoicesTotal: description: total amount paid to date example: 1000 nullable: true type: integer unpaidInvoicesBalance: description: total amount left to be paid example: 2139 nullable: true 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 RepeatingInvoiceReplaceResourceRequest3: description: >- Repeating invoice represents invoices that are automatically created at regular intervals type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for each repeating invoice example: 01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false type: string period: description: Number of times the invoice is charged per unit example: 1 nullable: true type: integer unit: description: |- Interval unit defining how often the invoice is charged e.g. WEEKLY e.g. MONTHLY example: MONTHLY nullable: true type: string dueDate: description: Number of days defining when the invoice is scheduled to be charged example: '0' nullable: true type: string dueDateType: description: |- The type of billing used together with due date e.g. "DAYSAFTERBILLDATE" e.g. "DAYSAFTERBILLMONTH" e.g. "OFCURRENTMONTH" e.g. "OFFOLLOWINGMONTH" example: DAYSAFTERBILLDATE nullable: true type: string startDate: description: date on which the recurring invoice starts example: '2021-02-27 00:00:00' nullable: true type: string nextScheduledDate: description: date at which next invoice is to be sent example: '2021-07-28 00:00:00' nullable: true type: string type: description: |- The type of invoice e.g. "ACCPAY" e.g. "ACCREC" example: ACCPAY nullable: true type: string reference: description: Order number of recurring invoice example: AP nullable: true type: string hasAttachments: description: Whether the invoice has attachments or not example: false nullable: true type: boolean contactId: description: Id of customer for whom recurring invoice is raised example: 3b30a108-9156-4a42-a893-3bbbe7af1ef8 nullable: true type: string contactName: description: Full name of contact example: Xero nullable: true type: string status: description: |- Status of the repeating invoice e.g. "DRAFT" e.g. "AUTHORISED" example: AUTHORISED nullable: true type: string lineAmountTypes: description: Whether the line amount includes, excludes or doesn't have tax. example: Exclusive nullable: true type: string lineItemDescription: description: A description of the line item example: Monthly subscription nullable: true type: string lineItemUnitAmount: description: The unit amount of the line item example: 29 nullable: true type: integer lineItemTaxType: description: |- The type of tax applied to line items e.g. "OUTPUT" e.g. "INPUT" e.g. "CAPEXINPUT" example: INPUT nullable: true type: string lineAmount: description: The final amount for the line items example: 29 nullable: true type: integer lineItemAccountCode: description: Account code for the line item example: '412' nullable: true type: string lineItemQuantity: description: The quantity of the line items example: 1 nullable: true type: integer lineItemId: description: Unique ID for the line item example: 304e5b38-d62f-4c43-91d2-24786154c3c0 nullable: true type: string subTotal: description: Total of invoice excluding taxes example: 2900 nullable: true type: integer totalTax: description: Total tax on invoice example: 239 nullable: true type: integer total: description: Total of invoice tax inclusive example: 3139 nullable: false type: integer currencyCode: description: currency of invoice example: USD nullable: true type: string recurrenceName: description: Unique name for the recurring profile given by the user example: '412' nullable: true type: string endDate: description: date on which the recurring invoice expires example: '2022-07-28 00:00:00' nullable: true type: string lastSentDate: description: date at which the last invoice was sent example: '2021-08-28 00:00:00' nullable: true type: string paidInvoicesTotal: description: total amount paid to date example: 1000 nullable: true type: integer unpaidInvoicesBalance: description: total amount left to be paid example: 2139 nullable: true 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 RepeatingInvoiceReplaceResourceRequest4: description: >- Repeating invoice represents invoices that are automatically created at regular intervals type: object properties: id: example: xero-01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier for each repeating invoice example: 01e01427-6b48-4d5f-aa2e-87c43f2a32a9 nullable: false type: string period: description: Number of times the invoice is charged per unit example: 1 nullable: true type: integer unit: description: |- Interval unit defining how often the invoice is charged e.g. WEEKLY e.g. MONTHLY example: MONTHLY nullable: true type: string dueDate: description: Number of days defining when the invoice is scheduled to be charged example: '0' nullable: true type: string dueDateType: description: |- The type of billing used together with due date e.g. "DAYSAFTERBILLDATE" e.g. "DAYSAFTERBILLMONTH" e.g. "OFCURRENTMONTH" e.g. "OFFOLLOWINGMONTH" example: DAYSAFTERBILLDATE nullable: true type: string startDate: description: date on which the recurring invoice starts example: '2021-02-27 00:00:00' nullable: true type: string nextScheduledDate: description: date at which next invoice is to be sent example: '2021-07-28 00:00:00' nullable: true type: string type: description: |- The type of invoice e.g. "ACCPAY" e.g. "ACCREC" example: ACCPAY nullable: true type: string reference: description: Order number of recurring invoice example: AP nullable: true type: string hasAttachments: description: Whether the invoice has attachments or not example: false nullable: true type: boolean contactId: description: Id of customer for whom recurring invoice is raised example: 3b30a108-9156-4a42-a893-3bbbe7af1ef8 nullable: true type: string contactName: description: Full name of contact example: Xero nullable: true type: string status: description: |- Status of the repeating invoice e.g. "DRAFT" e.g. "AUTHORISED" example: AUTHORISED nullable: true type: string lineAmountTypes: description: Whether the line amount includes, excludes or doesn't have tax. example: Exclusive nullable: true type: string lineItemDescription: description: A description of the line item example: Monthly subscription nullable: true type: string lineItemUnitAmount: description: The unit amount of the line item example: 29 nullable: true type: integer lineItemTaxType: description: |- The type of tax applied to line items e.g. "OUTPUT" e.g. "INPUT" e.g. "CAPEXINPUT" example: INPUT nullable: true type: string lineAmount: description: The final amount for the line items example: 29 nullable: true type: integer lineItemAccountCode: description: Account code for the line item example: '412' nullable: true type: string lineItemQuantity: description: The quantity of the line items example: 1 nullable: true type: integer lineItemId: description: Unique ID for the line item example: 304e5b38-d62f-4c43-91d2-24786154c3c0 nullable: true type: string subTotal: description: Total of invoice excluding taxes example: 2900 nullable: true type: integer totalTax: description: Total tax on invoice example: 239 nullable: true type: integer total: description: Total of invoice tax inclusive example: 3139 nullable: false type: integer currencyCode: description: currency of invoice example: USD nullable: true type: string recurrenceName: description: Unique name for the recurring profile given by the user example: '412' nullable: true type: string endDate: description: date on which the recurring invoice expires example: '2022-07-28 00:00:00' nullable: true type: string lastSentDate: description: date at which the last invoice was sent example: '2021-08-28 00:00:00' nullable: true type: string paidInvoicesTotal: description: total amount paid to date example: 1000 nullable: true type: integer unpaidInvoicesBalance: description: total amount left to be paid example: 2139 nullable: true 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 SubscriptionCreateResourceRequest: description: '' type: object properties: id: description: >- Unique identifier for this subscription note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Status of the subscription e.g. expired example: true nullable: true type: boolean balance: description: |- Amount in balance for the subscription in cents e.g. 500045 example: 500045 nullable: true type: integer totalRevenue: description: |- Total revenue from this specific subscription in cents e.g. 387687 example: 387687 nullable: true type: integer productPrice: description: |- Price of the subscribed product in cents e.g. 4999 example: 4999 nullable: true type: integer currencyCode: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string currentPeriodStart: description: |- Current period start datetime e.g. "2014-11-18" e.g. "1655792028" example: '1655792028' nullable: true type: string currentPeriodEnd: description: |- Current period end datetime e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string nextPeriodStart: description: |- Date next period starts e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string cancelAtEndOfPeriod: description: Boolean on if plan is canelled at the end of the current period example: true nullable: true type: boolean signupId: description: |- Signup id e.g. "user123" example: user123 nullable: true type: string signupRevenue: description: |- Signup revenue e.g. "250" example: '250' nullable: true type: string couponCode: description: |- Coupon code e.g. "PROMOCODE" example: PROMOCODE nullable: true type: string customerId: description: |- Customer id e.g. "123" example: '123' nullable: true type: string productId: description: |- Id for the subscribed product e.g. "321" example: '321' nullable: true type: string creditCardId: description: |- Credit card id e.g. "4250" example: '4250' nullable: true type: string created: description: |- The date and time the subscription is first created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time customerFirstName: description: |- Customer first name e.g. "Jane" example: Jane nullable: true type: string customerLastName: description: |- Customer last name e.g. "Doe" example: Doe nullable: true type: string startDate: description: |- Start datetime of the subscription e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time endDate: description: |- End datetime of the subscription e.g. "2015-11-18T02:17:40.080Z" example: '2015-11-18T02:17:40.080Z' nullable: true type: string format: date-time planName: description: |- Name of the plan of which this subscription is an instance e.g. "Basic Plan" example: Basic Plan nullable: true type: string activated: description: |- Indicates when the subscription was activated e.g. "Jan 23 2023" example: Jan 23 2023 nullable: true type: string remainingIntervals: description: |- Number of remaining subscription intervals e.g. 12 example: 12 nullable: true type: integer monthlyRevenue: description: |- Revenue per month in cents e.g. 500000 example: 500000 nullable: true type: integer netMonthlyRevenue: description: |- Monthly revenue after taxes e.g. 300000 example: 300000 nullable: true type: integer contractStartDate: description: "Date contract starts\n\t * e.g. \"2013-11-18T02:17:40.080Z\"" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time expiredTimestamp: description: |- When the current subscription expires e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time planInterval: description: |- Length of each subscription plan e.g. "Monthly" example: Monthly nullable: true type: string numOfIntervals: description: |- Number of subscription intervals e.g. 12 example: 12 nullable: true type: integer SubscriptionCreateResourceRequest1: description: '' type: object properties: id: description: >- Unique identifier for this subscription note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Status of the subscription e.g. expired example: true nullable: true type: boolean balance: description: |- Amount in balance for the subscription in cents e.g. 500045 example: 500045 nullable: true type: integer totalRevenue: description: |- Total revenue from this specific subscription in cents e.g. 387687 example: 387687 nullable: true type: integer productPrice: description: |- Price of the subscribed product in cents e.g. 4999 example: 4999 nullable: true type: integer currencyCode: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string currentPeriodStart: description: |- Current period start datetime e.g. "2014-11-18" e.g. "1655792028" example: '1655792028' nullable: true type: string currentPeriodEnd: description: |- Current period end datetime e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string nextPeriodStart: description: |- Date next period starts e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string cancelAtEndOfPeriod: description: Boolean on if plan is canelled at the end of the current period example: true nullable: true type: boolean signupId: description: |- Signup id e.g. "user123" example: user123 nullable: true type: string signupRevenue: description: |- Signup revenue e.g. "250" example: '250' nullable: true type: string couponCode: description: |- Coupon code e.g. "PROMOCODE" example: PROMOCODE nullable: true type: string customerId: description: |- Customer id e.g. "123" example: '123' nullable: true type: string productId: description: |- Id for the subscribed product e.g. "321" example: '321' nullable: true type: string creditCardId: description: |- Credit card id e.g. "4250" example: '4250' nullable: true type: string created: description: |- The date and time the subscription is first created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time customerFirstName: description: |- Customer first name e.g. "Jane" example: Jane nullable: true type: string customerLastName: description: |- Customer last name e.g. "Doe" example: Doe nullable: true type: string startDate: description: |- Start datetime of the subscription e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time endDate: description: |- End datetime of the subscription e.g. "2015-11-18T02:17:40.080Z" example: '2015-11-18T02:17:40.080Z' nullable: true type: string format: date-time planName: description: |- Name of the plan of which this subscription is an instance e.g. "Basic Plan" example: Basic Plan nullable: true type: string activated: description: |- Indicates when the subscription was activated e.g. "Jan 23 2023" example: Jan 23 2023 nullable: true type: string remainingIntervals: description: |- Number of remaining subscription intervals e.g. 12 example: 12 nullable: true type: integer monthlyRevenue: description: |- Revenue per month in cents e.g. 500000 example: 500000 nullable: true type: integer netMonthlyRevenue: description: |- Monthly revenue after taxes e.g. 300000 example: 300000 nullable: true type: integer contractStartDate: description: "Date contract starts\n\t * e.g. \"2013-11-18T02:17:40.080Z\"" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time expiredTimestamp: description: |- When the current subscription expires e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time planInterval: description: |- Length of each subscription plan e.g. "Monthly" example: Monthly nullable: true type: string numOfIntervals: description: |- Number of subscription intervals e.g. 12 example: 12 nullable: true type: integer SubscriptionCreateResourceRequest2: description: '' type: object properties: id: description: >- Unique identifier for this subscription note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Status of the subscription e.g. expired example: true nullable: true type: boolean balance: description: |- Amount in balance for the subscription in cents e.g. 500045 example: 500045 nullable: true type: integer totalRevenue: description: |- Total revenue from this specific subscription in cents e.g. 387687 example: 387687 nullable: true type: integer productPrice: description: |- Price of the subscribed product in cents e.g. 4999 example: 4999 nullable: true type: integer currencyCode: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string currentPeriodStart: description: |- Current period start datetime e.g. "2014-11-18" e.g. "1655792028" example: '1655792028' nullable: true type: string currentPeriodEnd: description: |- Current period end datetime e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string nextPeriodStart: description: |- Date next period starts e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string cancelAtEndOfPeriod: description: Boolean on if plan is canelled at the end of the current period example: true nullable: true type: boolean signupId: description: |- Signup id e.g. "user123" example: user123 nullable: true type: string signupRevenue: description: |- Signup revenue e.g. "250" example: '250' nullable: true type: string couponCode: description: |- Coupon code e.g. "PROMOCODE" example: PROMOCODE nullable: true type: string customerId: description: |- Customer id e.g. "123" example: '123' nullable: true type: string productId: description: |- Id for the subscribed product e.g. "321" example: '321' nullable: true type: string creditCardId: description: |- Credit card id e.g. "4250" example: '4250' nullable: true type: string created: description: |- The date and time the subscription is first created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time customerFirstName: description: |- Customer first name e.g. "Jane" example: Jane nullable: true type: string customerLastName: description: |- Customer last name e.g. "Doe" example: Doe nullable: true type: string startDate: description: |- Start datetime of the subscription e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time endDate: description: |- End datetime of the subscription e.g. "2015-11-18T02:17:40.080Z" example: '2015-11-18T02:17:40.080Z' nullable: true type: string format: date-time planName: description: |- Name of the plan of which this subscription is an instance e.g. "Basic Plan" example: Basic Plan nullable: true type: string activated: description: |- Indicates when the subscription was activated e.g. "Jan 23 2023" example: Jan 23 2023 nullable: true type: string remainingIntervals: description: |- Number of remaining subscription intervals e.g. 12 example: 12 nullable: true type: integer monthlyRevenue: description: |- Revenue per month in cents e.g. 500000 example: 500000 nullable: true type: integer netMonthlyRevenue: description: |- Monthly revenue after taxes e.g. 300000 example: 300000 nullable: true type: integer contractStartDate: description: "Date contract starts\n\t * e.g. \"2013-11-18T02:17:40.080Z\"" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time expiredTimestamp: description: |- When the current subscription expires e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time planInterval: description: |- Length of each subscription plan e.g. "Monthly" example: Monthly nullable: true type: string numOfIntervals: description: |- Number of subscription intervals e.g. 12 example: 12 nullable: true type: integer SubscriptionCreateResourceRequest3: description: '' type: object properties: id: description: >- Unique identifier for this subscription note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Status of the subscription e.g. expired example: true nullable: true type: boolean balance: description: |- Amount in balance for the subscription in cents e.g. 500045 example: 500045 nullable: true type: integer totalRevenue: description: |- Total revenue from this specific subscription in cents e.g. 387687 example: 387687 nullable: true type: integer productPrice: description: |- Price of the subscribed product in cents e.g. 4999 example: 4999 nullable: true type: integer currencyCode: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string currentPeriodStart: description: |- Current period start datetime e.g. "2014-11-18" e.g. "1655792028" example: '1655792028' nullable: true type: string currentPeriodEnd: description: |- Current period end datetime e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string nextPeriodStart: description: |- Date next period starts e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string cancelAtEndOfPeriod: description: Boolean on if plan is canelled at the end of the current period example: true nullable: true type: boolean signupId: description: |- Signup id e.g. "user123" example: user123 nullable: true type: string signupRevenue: description: |- Signup revenue e.g. "250" example: '250' nullable: true type: string couponCode: description: |- Coupon code e.g. "PROMOCODE" example: PROMOCODE nullable: true type: string customerId: description: |- Customer id e.g. "123" example: '123' nullable: true type: string productId: description: |- Id for the subscribed product e.g. "321" example: '321' nullable: true type: string creditCardId: description: |- Credit card id e.g. "4250" example: '4250' nullable: true type: string created: description: |- The date and time the subscription is first created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time customerFirstName: description: |- Customer first name e.g. "Jane" example: Jane nullable: true type: string customerLastName: description: |- Customer last name e.g. "Doe" example: Doe nullable: true type: string startDate: description: |- Start datetime of the subscription e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time endDate: description: |- End datetime of the subscription e.g. "2015-11-18T02:17:40.080Z" example: '2015-11-18T02:17:40.080Z' nullable: true type: string format: date-time planName: description: |- Name of the plan of which this subscription is an instance e.g. "Basic Plan" example: Basic Plan nullable: true type: string activated: description: |- Indicates when the subscription was activated e.g. "Jan 23 2023" example: Jan 23 2023 nullable: true type: string remainingIntervals: description: |- Number of remaining subscription intervals e.g. 12 example: 12 nullable: true type: integer monthlyRevenue: description: |- Revenue per month in cents e.g. 500000 example: 500000 nullable: true type: integer netMonthlyRevenue: description: |- Monthly revenue after taxes e.g. 300000 example: 300000 nullable: true type: integer contractStartDate: description: "Date contract starts\n\t * e.g. \"2013-11-18T02:17:40.080Z\"" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time expiredTimestamp: description: |- When the current subscription expires e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time planInterval: description: |- Length of each subscription plan e.g. "Monthly" example: Monthly nullable: true type: string numOfIntervals: description: |- Number of subscription intervals e.g. 12 example: 12 nullable: true type: integer SubscriptionCreateResourceRequest4: description: '' type: object properties: id: description: >- Unique identifier for this subscription note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Status of the subscription e.g. expired example: true nullable: true type: boolean balance: description: |- Amount in balance for the subscription in cents e.g. 500045 example: 500045 nullable: true type: integer totalRevenue: description: |- Total revenue from this specific subscription in cents e.g. 387687 example: 387687 nullable: true type: integer productPrice: description: |- Price of the subscribed product in cents e.g. 4999 example: 4999 nullable: true type: integer currencyCode: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string currentPeriodStart: description: |- Current period start datetime e.g. "2014-11-18" e.g. "1655792028" example: '1655792028' nullable: true type: string currentPeriodEnd: description: |- Current period end datetime e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string nextPeriodStart: description: |- Date next period starts e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string cancelAtEndOfPeriod: description: Boolean on if plan is canelled at the end of the current period example: true nullable: true type: boolean signupId: description: |- Signup id e.g. "user123" example: user123 nullable: true type: string signupRevenue: description: |- Signup revenue e.g. "250" example: '250' nullable: true type: string couponCode: description: |- Coupon code e.g. "PROMOCODE" example: PROMOCODE nullable: true type: string customerId: description: |- Customer id e.g. "123" example: '123' nullable: true type: string productId: description: |- Id for the subscribed product e.g. "321" example: '321' nullable: true type: string creditCardId: description: |- Credit card id e.g. "4250" example: '4250' nullable: true type: string created: description: |- The date and time the subscription is first created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time customerFirstName: description: |- Customer first name e.g. "Jane" example: Jane nullable: true type: string customerLastName: description: |- Customer last name e.g. "Doe" example: Doe nullable: true type: string startDate: description: |- Start datetime of the subscription e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time endDate: description: |- End datetime of the subscription e.g. "2015-11-18T02:17:40.080Z" example: '2015-11-18T02:17:40.080Z' nullable: true type: string format: date-time planName: description: |- Name of the plan of which this subscription is an instance e.g. "Basic Plan" example: Basic Plan nullable: true type: string activated: description: |- Indicates when the subscription was activated e.g. "Jan 23 2023" example: Jan 23 2023 nullable: true type: string remainingIntervals: description: |- Number of remaining subscription intervals e.g. 12 example: 12 nullable: true type: integer monthlyRevenue: description: |- Revenue per month in cents e.g. 500000 example: 500000 nullable: true type: integer netMonthlyRevenue: description: |- Monthly revenue after taxes e.g. 300000 example: 300000 nullable: true type: integer contractStartDate: description: "Date contract starts\n\t * e.g. \"2013-11-18T02:17:40.080Z\"" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time expiredTimestamp: description: |- When the current subscription expires e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time planInterval: description: |- Length of each subscription plan e.g. "Monthly" example: Monthly nullable: true type: string numOfIntervals: description: |- Number of subscription intervals e.g. 12 example: 12 nullable: true type: integer SubscriptionReplaceResourceRequest: description: '' type: object properties: id: description: >- Unique identifier for this subscription note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Status of the subscription e.g. expired example: true nullable: true type: boolean balance: description: |- Amount in balance for the subscription in cents e.g. 500045 example: 500045 nullable: true type: integer totalRevenue: description: |- Total revenue from this specific subscription in cents e.g. 387687 example: 387687 nullable: true type: integer productPrice: description: |- Price of the subscribed product in cents e.g. 4999 example: 4999 nullable: true type: integer currencyCode: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string currentPeriodStart: description: |- Current period start datetime e.g. "2014-11-18" e.g. "1655792028" example: '1655792028' nullable: true type: string currentPeriodEnd: description: |- Current period end datetime e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string nextPeriodStart: description: |- Date next period starts e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string cancelAtEndOfPeriod: description: Boolean on if plan is canelled at the end of the current period example: true nullable: true type: boolean signupId: description: |- Signup id e.g. "user123" example: user123 nullable: true type: string signupRevenue: description: |- Signup revenue e.g. "250" example: '250' nullable: true type: string couponCode: description: |- Coupon code e.g. "PROMOCODE" example: PROMOCODE nullable: true type: string customerId: description: |- Customer id e.g. "123" example: '123' nullable: true type: string productId: description: |- Id for the subscribed product e.g. "321" example: '321' nullable: true type: string creditCardId: description: |- Credit card id e.g. "4250" example: '4250' nullable: true type: string created: description: |- The date and time the subscription is first created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time customerFirstName: description: |- Customer first name e.g. "Jane" example: Jane nullable: true type: string customerLastName: description: |- Customer last name e.g. "Doe" example: Doe nullable: true type: string startDate: description: |- Start datetime of the subscription e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time endDate: description: |- End datetime of the subscription e.g. "2015-11-18T02:17:40.080Z" example: '2015-11-18T02:17:40.080Z' nullable: true type: string format: date-time planName: description: |- Name of the plan of which this subscription is an instance e.g. "Basic Plan" example: Basic Plan nullable: true type: string activated: description: |- Indicates when the subscription was activated e.g. "Jan 23 2023" example: Jan 23 2023 nullable: true type: string remainingIntervals: description: |- Number of remaining subscription intervals e.g. 12 example: 12 nullable: true type: integer monthlyRevenue: description: |- Revenue per month in cents e.g. 500000 example: 500000 nullable: true type: integer netMonthlyRevenue: description: |- Monthly revenue after taxes e.g. 300000 example: 300000 nullable: true type: integer contractStartDate: description: "Date contract starts\n\t * e.g. \"2013-11-18T02:17:40.080Z\"" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time expiredTimestamp: description: |- When the current subscription expires e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time planInterval: description: |- Length of each subscription plan e.g. "Monthly" example: Monthly nullable: true type: string numOfIntervals: description: |- Number of subscription intervals e.g. 12 example: 12 nullable: true type: integer SubscriptionReplaceResourceRequest1: description: '' type: object properties: id: description: >- Unique identifier for this subscription note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Status of the subscription e.g. expired example: true nullable: true type: boolean balance: description: |- Amount in balance for the subscription in cents e.g. 500045 example: 500045 nullable: true type: integer totalRevenue: description: |- Total revenue from this specific subscription in cents e.g. 387687 example: 387687 nullable: true type: integer productPrice: description: |- Price of the subscribed product in cents e.g. 4999 example: 4999 nullable: true type: integer currencyCode: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string currentPeriodStart: description: |- Current period start datetime e.g. "2014-11-18" e.g. "1655792028" example: '1655792028' nullable: true type: string currentPeriodEnd: description: |- Current period end datetime e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string nextPeriodStart: description: |- Date next period starts e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string cancelAtEndOfPeriod: description: Boolean on if plan is canelled at the end of the current period example: true nullable: true type: boolean signupId: description: |- Signup id e.g. "user123" example: user123 nullable: true type: string signupRevenue: description: |- Signup revenue e.g. "250" example: '250' nullable: true type: string couponCode: description: |- Coupon code e.g. "PROMOCODE" example: PROMOCODE nullable: true type: string customerId: description: |- Customer id e.g. "123" example: '123' nullable: true type: string productId: description: |- Id for the subscribed product e.g. "321" example: '321' nullable: true type: string creditCardId: description: |- Credit card id e.g. "4250" example: '4250' nullable: true type: string created: description: |- The date and time the subscription is first created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time customerFirstName: description: |- Customer first name e.g. "Jane" example: Jane nullable: true type: string customerLastName: description: |- Customer last name e.g. "Doe" example: Doe nullable: true type: string startDate: description: |- Start datetime of the subscription e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time endDate: description: |- End datetime of the subscription e.g. "2015-11-18T02:17:40.080Z" example: '2015-11-18T02:17:40.080Z' nullable: true type: string format: date-time planName: description: |- Name of the plan of which this subscription is an instance e.g. "Basic Plan" example: Basic Plan nullable: true type: string activated: description: |- Indicates when the subscription was activated e.g. "Jan 23 2023" example: Jan 23 2023 nullable: true type: string remainingIntervals: description: |- Number of remaining subscription intervals e.g. 12 example: 12 nullable: true type: integer monthlyRevenue: description: |- Revenue per month in cents e.g. 500000 example: 500000 nullable: true type: integer netMonthlyRevenue: description: |- Monthly revenue after taxes e.g. 300000 example: 300000 nullable: true type: integer contractStartDate: description: "Date contract starts\n\t * e.g. \"2013-11-18T02:17:40.080Z\"" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time expiredTimestamp: description: |- When the current subscription expires e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time planInterval: description: |- Length of each subscription plan e.g. "Monthly" example: Monthly nullable: true type: string numOfIntervals: description: |- Number of subscription intervals e.g. 12 example: 12 nullable: true type: integer SubscriptionReplaceResourceRequest2: description: '' type: object properties: id: description: >- Unique identifier for this subscription note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Status of the subscription e.g. expired example: true nullable: true type: boolean balance: description: |- Amount in balance for the subscription in cents e.g. 500045 example: 500045 nullable: true type: integer totalRevenue: description: |- Total revenue from this specific subscription in cents e.g. 387687 example: 387687 nullable: true type: integer productPrice: description: |- Price of the subscribed product in cents e.g. 4999 example: 4999 nullable: true type: integer currencyCode: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string currentPeriodStart: description: |- Current period start datetime e.g. "2014-11-18" e.g. "1655792028" example: '1655792028' nullable: true type: string currentPeriodEnd: description: |- Current period end datetime e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string nextPeriodStart: description: |- Date next period starts e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string cancelAtEndOfPeriod: description: Boolean on if plan is canelled at the end of the current period example: true nullable: true type: boolean signupId: description: |- Signup id e.g. "user123" example: user123 nullable: true type: string signupRevenue: description: |- Signup revenue e.g. "250" example: '250' nullable: true type: string couponCode: description: |- Coupon code e.g. "PROMOCODE" example: PROMOCODE nullable: true type: string customerId: description: |- Customer id e.g. "123" example: '123' nullable: true type: string productId: description: |- Id for the subscribed product e.g. "321" example: '321' nullable: true type: string creditCardId: description: |- Credit card id e.g. "4250" example: '4250' nullable: true type: string created: description: |- The date and time the subscription is first created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time customerFirstName: description: |- Customer first name e.g. "Jane" example: Jane nullable: true type: string customerLastName: description: |- Customer last name e.g. "Doe" example: Doe nullable: true type: string startDate: description: |- Start datetime of the subscription e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time endDate: description: |- End datetime of the subscription e.g. "2015-11-18T02:17:40.080Z" example: '2015-11-18T02:17:40.080Z' nullable: true type: string format: date-time planName: description: |- Name of the plan of which this subscription is an instance e.g. "Basic Plan" example: Basic Plan nullable: true type: string activated: description: |- Indicates when the subscription was activated e.g. "Jan 23 2023" example: Jan 23 2023 nullable: true type: string remainingIntervals: description: |- Number of remaining subscription intervals e.g. 12 example: 12 nullable: true type: integer monthlyRevenue: description: |- Revenue per month in cents e.g. 500000 example: 500000 nullable: true type: integer netMonthlyRevenue: description: |- Monthly revenue after taxes e.g. 300000 example: 300000 nullable: true type: integer contractStartDate: description: "Date contract starts\n\t * e.g. \"2013-11-18T02:17:40.080Z\"" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time expiredTimestamp: description: |- When the current subscription expires e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time planInterval: description: |- Length of each subscription plan e.g. "Monthly" example: Monthly nullable: true type: string numOfIntervals: description: |- Number of subscription intervals e.g. 12 example: 12 nullable: true type: integer SubscriptionReplaceResourceRequest3: description: '' type: object properties: id: description: >- Unique identifier for this subscription note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Status of the subscription e.g. expired example: true nullable: true type: boolean balance: description: |- Amount in balance for the subscription in cents e.g. 500045 example: 500045 nullable: true type: integer totalRevenue: description: |- Total revenue from this specific subscription in cents e.g. 387687 example: 387687 nullable: true type: integer productPrice: description: |- Price of the subscribed product in cents e.g. 4999 example: 4999 nullable: true type: integer currencyCode: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string currentPeriodStart: description: |- Current period start datetime e.g. "2014-11-18" e.g. "1655792028" example: '1655792028' nullable: true type: string currentPeriodEnd: description: |- Current period end datetime e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string nextPeriodStart: description: |- Date next period starts e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string cancelAtEndOfPeriod: description: Boolean on if plan is canelled at the end of the current period example: true nullable: true type: boolean signupId: description: |- Signup id e.g. "user123" example: user123 nullable: true type: string signupRevenue: description: |- Signup revenue e.g. "250" example: '250' nullable: true type: string couponCode: description: |- Coupon code e.g. "PROMOCODE" example: PROMOCODE nullable: true type: string customerId: description: |- Customer id e.g. "123" example: '123' nullable: true type: string productId: description: |- Id for the subscribed product e.g. "321" example: '321' nullable: true type: string creditCardId: description: |- Credit card id e.g. "4250" example: '4250' nullable: true type: string created: description: |- The date and time the subscription is first created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time customerFirstName: description: |- Customer first name e.g. "Jane" example: Jane nullable: true type: string customerLastName: description: |- Customer last name e.g. "Doe" example: Doe nullable: true type: string startDate: description: |- Start datetime of the subscription e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time endDate: description: |- End datetime of the subscription e.g. "2015-11-18T02:17:40.080Z" example: '2015-11-18T02:17:40.080Z' nullable: true type: string format: date-time planName: description: |- Name of the plan of which this subscription is an instance e.g. "Basic Plan" example: Basic Plan nullable: true type: string activated: description: |- Indicates when the subscription was activated e.g. "Jan 23 2023" example: Jan 23 2023 nullable: true type: string remainingIntervals: description: |- Number of remaining subscription intervals e.g. 12 example: 12 nullable: true type: integer monthlyRevenue: description: |- Revenue per month in cents e.g. 500000 example: 500000 nullable: true type: integer netMonthlyRevenue: description: |- Monthly revenue after taxes e.g. 300000 example: 300000 nullable: true type: integer contractStartDate: description: "Date contract starts\n\t * e.g. \"2013-11-18T02:17:40.080Z\"" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time expiredTimestamp: description: |- When the current subscription expires e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time planInterval: description: |- Length of each subscription plan e.g. "Monthly" example: Monthly nullable: true type: string numOfIntervals: description: |- Number of subscription intervals e.g. 12 example: 12 nullable: true type: integer SubscriptionReplaceResourceRequest4: description: '' type: object properties: id: description: >- Unique identifier for this subscription note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Status of the subscription e.g. expired example: true nullable: true type: boolean balance: description: |- Amount in balance for the subscription in cents e.g. 500045 example: 500045 nullable: true type: integer totalRevenue: description: |- Total revenue from this specific subscription in cents e.g. 387687 example: 387687 nullable: true type: integer productPrice: description: |- Price of the subscribed product in cents e.g. 4999 example: 4999 nullable: true type: integer currencyCode: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string currentPeriodStart: description: |- Current period start datetime e.g. "2014-11-18" e.g. "1655792028" example: '1655792028' nullable: true type: string currentPeriodEnd: description: |- Current period end datetime e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string nextPeriodStart: description: |- Date next period starts e.g. "2014-11-18" e.g. "1653977628" example: '1653977628' nullable: true type: string cancelAtEndOfPeriod: description: Boolean on if plan is canelled at the end of the current period example: true nullable: true type: boolean signupId: description: |- Signup id e.g. "user123" example: user123 nullable: true type: string signupRevenue: description: |- Signup revenue e.g. "250" example: '250' nullable: true type: string couponCode: description: |- Coupon code e.g. "PROMOCODE" example: PROMOCODE nullable: true type: string customerId: description: |- Customer id e.g. "123" example: '123' nullable: true type: string productId: description: |- Id for the subscribed product e.g. "321" example: '321' nullable: true type: string creditCardId: description: |- Credit card id e.g. "4250" example: '4250' nullable: true type: string created: description: |- The date and time the subscription is first created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time customerFirstName: description: |- Customer first name e.g. "Jane" example: Jane nullable: true type: string customerLastName: description: |- Customer last name e.g. "Doe" example: Doe nullable: true type: string startDate: description: |- Start datetime of the subscription e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time endDate: description: |- End datetime of the subscription e.g. "2015-11-18T02:17:40.080Z" example: '2015-11-18T02:17:40.080Z' nullable: true type: string format: date-time planName: description: |- Name of the plan of which this subscription is an instance e.g. "Basic Plan" example: Basic Plan nullable: true type: string activated: description: |- Indicates when the subscription was activated e.g. "Jan 23 2023" example: Jan 23 2023 nullable: true type: string remainingIntervals: description: |- Number of remaining subscription intervals e.g. 12 example: 12 nullable: true type: integer monthlyRevenue: description: |- Revenue per month in cents e.g. 500000 example: 500000 nullable: true type: integer netMonthlyRevenue: description: |- Monthly revenue after taxes e.g. 300000 example: 300000 nullable: true type: integer contractStartDate: description: "Date contract starts\n\t * e.g. \"2013-11-18T02:17:40.080Z\"" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time expiredTimestamp: description: |- When the current subscription expires e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time planInterval: description: |- Length of each subscription plan e.g. "Monthly" example: Monthly nullable: true type: string numOfIntervals: description: |- Number of subscription intervals e.g. 12 example: 12 nullable: true type: integer VendorCreditCreateResourceRequest: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "3000000002075" example: '3000000002075' nullable: false type: string date: description: |- The date the vendor credit was created e.g. "2014-08-28" example: '2014-08-28' nullable: true type: string status: description: |- Status of recurring expense e.g. "open" example: open nullable: true type: string vendorId: description: |- ID of the vendor the vendor credit is associated with e.g. "460000000020029" example: '460000000020029' nullable: true type: string vendorName: description: |- Name of the vendor the vendor credit is associated with e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string subtotal: description: |- Subtotal of the vendor credits in cents e.g. 3000 example: 3000 nullable: true type: integer totalAmount: description: |- Total amount of the vendor credits in cents e.g. 3500 example: 3500 nullable: true type: integer balance: description: |- Balance in the vendor credit in cents e.g. 2150 example: 2150 nullable: true type: integer created: description: |- Time of the vendor credit creation e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time modified: description: |- Last modified time of vendor credit e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time required: - totalAmount VendorCreditCreateResourceRequest1: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "3000000002075" example: '3000000002075' nullable: false type: string date: description: |- The date the vendor credit was created e.g. "2014-08-28" example: '2014-08-28' nullable: true type: string status: description: |- Status of recurring expense e.g. "open" example: open nullable: true type: string vendorId: description: |- ID of the vendor the vendor credit is associated with e.g. "460000000020029" example: '460000000020029' nullable: true type: string vendorName: description: |- Name of the vendor the vendor credit is associated with e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string subtotal: description: |- Subtotal of the vendor credits in cents e.g. 3000 example: 3000 nullable: true type: integer totalAmount: description: |- Total amount of the vendor credits in cents e.g. 3500 example: 3500 nullable: true type: integer balance: description: |- Balance in the vendor credit in cents e.g. 2150 example: 2150 nullable: true type: integer created: description: |- Time of the vendor credit creation e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time modified: description: |- Last modified time of vendor credit e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time required: - totalAmount VendorCreditCreateResourceRequest2: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "3000000002075" example: '3000000002075' nullable: false type: string date: description: |- The date the vendor credit was created e.g. "2014-08-28" example: '2014-08-28' nullable: true type: string status: description: |- Status of recurring expense e.g. "open" example: open nullable: true type: string vendorId: description: |- ID of the vendor the vendor credit is associated with e.g. "460000000020029" example: '460000000020029' nullable: true type: string vendorName: description: |- Name of the vendor the vendor credit is associated with e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string subtotal: description: |- Subtotal of the vendor credits in cents e.g. 3000 example: 3000 nullable: true type: integer totalAmount: description: |- Total amount of the vendor credits in cents e.g. 3500 example: 3500 nullable: true type: integer balance: description: |- Balance in the vendor credit in cents e.g. 2150 example: 2150 nullable: true type: integer created: description: |- Time of the vendor credit creation e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time modified: description: |- Last modified time of vendor credit e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time required: - totalAmount VendorCreditCreateResourceRequest3: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "3000000002075" example: '3000000002075' nullable: false type: string date: description: |- The date the vendor credit was created e.g. "2014-08-28" example: '2014-08-28' nullable: true type: string status: description: |- Status of recurring expense e.g. "open" example: open nullable: true type: string vendorId: description: |- ID of the vendor the vendor credit is associated with e.g. "460000000020029" example: '460000000020029' nullable: true type: string vendorName: description: |- Name of the vendor the vendor credit is associated with e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string subtotal: description: |- Subtotal of the vendor credits in cents e.g. 3000 example: 3000 nullable: true type: integer totalAmount: description: |- Total amount of the vendor credits in cents e.g. 3500 example: 3500 nullable: true type: integer balance: description: |- Balance in the vendor credit in cents e.g. 2150 example: 2150 nullable: true type: integer created: description: |- Time of the vendor credit creation e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time modified: description: |- Last modified time of vendor credit e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time required: - totalAmount VendorCreditCreateResourceRequest4: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "3000000002075" example: '3000000002075' nullable: false type: string date: description: |- The date the vendor credit was created e.g. "2014-08-28" example: '2014-08-28' nullable: true type: string status: description: |- Status of recurring expense e.g. "open" example: open nullable: true type: string vendorId: description: |- ID of the vendor the vendor credit is associated with e.g. "460000000020029" example: '460000000020029' nullable: true type: string vendorName: description: |- Name of the vendor the vendor credit is associated with e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string subtotal: description: |- Subtotal of the vendor credits in cents e.g. 3000 example: 3000 nullable: true type: integer totalAmount: description: |- Total amount of the vendor credits in cents e.g. 3500 example: 3500 nullable: true type: integer balance: description: |- Balance in the vendor credit in cents e.g. 2150 example: 2150 nullable: true type: integer created: description: |- Time of the vendor credit creation e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time modified: description: |- Last modified time of vendor credit e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time required: - totalAmount VendorCreditReplaceResourceRequest: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "3000000002075" example: '3000000002075' nullable: false type: string date: description: |- The date the vendor credit was created e.g. "2014-08-28" example: '2014-08-28' nullable: true type: string status: description: |- Status of recurring expense e.g. "open" example: open nullable: true type: string vendorId: description: |- ID of the vendor the vendor credit is associated with e.g. "460000000020029" example: '460000000020029' nullable: true type: string vendorName: description: |- Name of the vendor the vendor credit is associated with e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string subtotal: description: |- Subtotal of the vendor credits in cents e.g. 3000 example: 3000 nullable: true type: integer totalAmount: description: |- Total amount of the vendor credits in cents e.g. 3500 example: 3500 nullable: true type: integer balance: description: |- Balance in the vendor credit in cents e.g. 2150 example: 2150 nullable: true type: integer created: description: |- Time of the vendor credit creation e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time modified: description: |- Last modified time of vendor credit e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time required: - totalAmount VendorCreditReplaceResourceRequest1: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "3000000002075" example: '3000000002075' nullable: false type: string date: description: |- The date the vendor credit was created e.g. "2014-08-28" example: '2014-08-28' nullable: true type: string status: description: |- Status of recurring expense e.g. "open" example: open nullable: true type: string vendorId: description: |- ID of the vendor the vendor credit is associated with e.g. "460000000020029" example: '460000000020029' nullable: true type: string vendorName: description: |- Name of the vendor the vendor credit is associated with e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string subtotal: description: |- Subtotal of the vendor credits in cents e.g. 3000 example: 3000 nullable: true type: integer totalAmount: description: |- Total amount of the vendor credits in cents e.g. 3500 example: 3500 nullable: true type: integer balance: description: |- Balance in the vendor credit in cents e.g. 2150 example: 2150 nullable: true type: integer created: description: |- Time of the vendor credit creation e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time modified: description: |- Last modified time of vendor credit e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time required: - totalAmount VendorCreditReplaceResourceRequest2: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "3000000002075" example: '3000000002075' nullable: false type: string date: description: |- The date the vendor credit was created e.g. "2014-08-28" example: '2014-08-28' nullable: true type: string status: description: |- Status of recurring expense e.g. "open" example: open nullable: true type: string vendorId: description: |- ID of the vendor the vendor credit is associated with e.g. "460000000020029" example: '460000000020029' nullable: true type: string vendorName: description: |- Name of the vendor the vendor credit is associated with e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string subtotal: description: |- Subtotal of the vendor credits in cents e.g. 3000 example: 3000 nullable: true type: integer totalAmount: description: |- Total amount of the vendor credits in cents e.g. 3500 example: 3500 nullable: true type: integer balance: description: |- Balance in the vendor credit in cents e.g. 2150 example: 2150 nullable: true type: integer created: description: |- Time of the vendor credit creation e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time modified: description: |- Last modified time of vendor credit e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time required: - totalAmount VendorCreditReplaceResourceRequest3: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "3000000002075" example: '3000000002075' nullable: false type: string date: description: |- The date the vendor credit was created e.g. "2014-08-28" example: '2014-08-28' nullable: true type: string status: description: |- Status of recurring expense e.g. "open" example: open nullable: true type: string vendorId: description: |- ID of the vendor the vendor credit is associated with e.g. "460000000020029" example: '460000000020029' nullable: true type: string vendorName: description: |- Name of the vendor the vendor credit is associated with e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string subtotal: description: |- Subtotal of the vendor credits in cents e.g. 3000 example: 3000 nullable: true type: integer totalAmount: description: |- Total amount of the vendor credits in cents e.g. 3500 example: 3500 nullable: true type: integer balance: description: |- Balance in the vendor credit in cents e.g. 2150 example: 2150 nullable: true type: integer created: description: |- Time of the vendor credit creation e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time modified: description: |- Last modified time of vendor credit e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time required: - totalAmount VendorCreditReplaceResourceRequest4: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "3000000002075" example: '3000000002075' nullable: false type: string date: description: |- The date the vendor credit was created e.g. "2014-08-28" example: '2014-08-28' nullable: true type: string status: description: |- Status of recurring expense e.g. "open" example: open nullable: true type: string vendorId: description: |- ID of the vendor the vendor credit is associated with e.g. "460000000020029" example: '460000000020029' nullable: true type: string vendorName: description: |- Name of the vendor the vendor credit is associated with e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string subtotal: description: |- Subtotal of the vendor credits in cents e.g. 3000 example: 3000 nullable: true type: integer totalAmount: description: |- Total amount of the vendor credits in cents e.g. 3500 example: 3500 nullable: true type: integer balance: description: |- Balance in the vendor credit in cents e.g. 2150 example: 2150 nullable: true type: integer created: description: |- Time of the vendor credit creation e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time modified: description: |- Last modified time of vendor credit e.g. "2014-08-28T22:53:31-0700" example: 2014-08-28T22:53:31-0700 nullable: true type: string format: date-time required: - totalAmount VendorPaymentCreateResourceRequest: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string vendorId: description: |- Unique identifier for the vendor e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of vendor payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the vendor payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the vendor payment in cents e.g. 12500 example: 12500 nullable: true type: integer balance: description: |- Balance due for the bill in cents e.g. 3500 example: 3500 nullable: true type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time required: - amount VendorPaymentCreateResourceRequest1: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string vendorId: description: |- Unique identifier for the vendor e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of vendor payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the vendor payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the vendor payment in cents e.g. 12500 example: 12500 nullable: true type: integer balance: description: |- Balance due for the bill in cents e.g. 3500 example: 3500 nullable: true type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time required: - amount VendorPaymentCreateResourceRequest2: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string vendorId: description: |- Unique identifier for the vendor e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of vendor payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the vendor payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the vendor payment in cents e.g. 12500 example: 12500 nullable: true type: integer balance: description: |- Balance due for the bill in cents e.g. 3500 example: 3500 nullable: true type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time required: - amount VendorPaymentCreateResourceRequest3: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string vendorId: description: |- Unique identifier for the vendor e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of vendor payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the vendor payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the vendor payment in cents e.g. 12500 example: 12500 nullable: true type: integer balance: description: |- Balance due for the bill in cents e.g. 3500 example: 3500 nullable: true type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time required: - amount VendorPaymentCreateResourceRequest4: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string vendorId: description: |- Unique identifier for the vendor e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of vendor payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the vendor payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the vendor payment in cents e.g. 12500 example: 12500 nullable: true type: integer balance: description: |- Balance due for the bill in cents e.g. 3500 example: 3500 nullable: true type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time required: - amount VendorPaymentReplaceResourceRequest: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string vendorId: description: |- Unique identifier for the vendor e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of vendor payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the vendor payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the vendor payment in cents e.g. 12500 example: 12500 nullable: true type: integer balance: description: |- Balance due for the bill in cents e.g. 3500 example: 3500 nullable: true type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time required: - amount VendorPaymentReplaceResourceRequest1: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string vendorId: description: |- Unique identifier for the vendor e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of vendor payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the vendor payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the vendor payment in cents e.g. 12500 example: 12500 nullable: true type: integer balance: description: |- Balance due for the bill in cents e.g. 3500 example: 3500 nullable: true type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time required: - amount VendorPaymentReplaceResourceRequest2: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string vendorId: description: |- Unique identifier for the vendor e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of vendor payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the vendor payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the vendor payment in cents e.g. 12500 example: 12500 nullable: true type: integer balance: description: |- Balance due for the bill in cents e.g. 3500 example: 3500 nullable: true type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time required: - amount VendorPaymentReplaceResourceRequest3: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string vendorId: description: |- Unique identifier for the vendor e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of vendor payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the vendor payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the vendor payment in cents e.g. 12500 example: 12500 nullable: true type: integer balance: description: |- Balance due for the bill in cents e.g. 3500 example: 3500 nullable: true type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time required: - amount VendorPaymentReplaceResourceRequest4: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string vendorId: description: |- Unique identifier for the vendor e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of vendor payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the vendor payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the vendor payment in cents e.g. 12500 example: 12500 nullable: true type: integer balance: description: |- Balance due for the bill in cents e.g. 3500 example: 3500 nullable: true type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the vendor payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time required: - amount VendorCreateResourceRequest: description: '' type: object properties: id: description: >- Unique identifier for this vendor note that no particular pattern in this field is guaranteed, only that this field is unique e.g: "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string givenName: description: |- First name of the vendor e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the vendor e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company e.g. "Doyle-Koch LLC" example: Doyle-Koch LLC nullable: true type: string displayName: description: |- Name displayed for vendor e.g. "Doyle-Koch" example: Doyle-Koch nullable: true type: string contactName: description: |- Name of the main contact for the vendor e.g. "John Smith" example: John Smith nullable: true type: string contactTitle: description: |- Title of the main contact for the vendor e.g. "Account Manager" example: Account Manager nullable: true type: string accountNumber: description: |- Account number for the vendor e.g. "420042" example: '420042' nullable: true type: string phone: description: |- Phone number e.g. "281-381-4241" example: 281-381-4241 nullable: true type: string mobile: description: |- Mobile number e.g. "786-258-0182" example: 786-258-0182 nullable: true type: string fax: description: |- Fax number e.g. "281-381-4255" example: 281-381-4255 nullable: true type: string email: description: |- Email address for the vendor e.g. "doyle-koch@email.com" example: doyle-koch@email.com nullable: true type: string website: description: |- Vendor website e.g. "https://www.doylekoch.com" example: https://www.doylekoch.com nullable: true type: string address: description: |- First line of vendor address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Vendor address line 2 e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string country: description: |- Country of the address * e.g. "United States" example: United States nullable: true type: string postalCode: description: |- Postal code of the address * e.g. "99660" example: '99660' nullable: true type: string currency: description: |- Currency code used by vendor e.g. "USD" example: USD nullable: true type: string balance: description: |- Balance in ledger for vendor in cents e.g. 650000 example: 650000 nullable: true type: integer bankAccountName: description: |- Bank account name associated with the vendor e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank acount number associated with the vendor e.g. "123654" example: '123654' nullable: true type: string notes: description: |- Additional note attached to vendor e.g. "Quality vendor" example: Quality vendor nullable: true type: string taxType: description: |- Type of tax applied to vendor e.g. "Global" example: Global nullable: true type: string isContractor: description: Whether the vendor is a contractor example: true nullable: true type: boolean active: description: Whether the vendor is active example: true nullable: true type: boolean created: description: |- Date of vendor account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time termId: description: >- Reference to a Term object (payment terms) associated with this Vendor e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Vendor e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Vendor e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string VendorCreateResourceRequest1: description: '' type: object properties: id: description: >- Unique identifier for this vendor note that no particular pattern in this field is guaranteed, only that this field is unique e.g: "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string givenName: description: |- First name of the vendor e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the vendor e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company e.g. "Doyle-Koch LLC" example: Doyle-Koch LLC nullable: true type: string displayName: description: |- Name displayed for vendor e.g. "Doyle-Koch" example: Doyle-Koch nullable: true type: string contactName: description: |- Name of the main contact for the vendor e.g. "John Smith" example: John Smith nullable: true type: string contactTitle: description: |- Title of the main contact for the vendor e.g. "Account Manager" example: Account Manager nullable: true type: string accountNumber: description: |- Account number for the vendor e.g. "420042" example: '420042' nullable: true type: string phone: description: |- Phone number e.g. "281-381-4241" example: 281-381-4241 nullable: true type: string mobile: description: |- Mobile number e.g. "786-258-0182" example: 786-258-0182 nullable: true type: string fax: description: |- Fax number e.g. "281-381-4255" example: 281-381-4255 nullable: true type: string email: description: |- Email address for the vendor e.g. "doyle-koch@email.com" example: doyle-koch@email.com nullable: true type: string website: description: |- Vendor website e.g. "https://www.doylekoch.com" example: https://www.doylekoch.com nullable: true type: string address: description: |- First line of vendor address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Vendor address line 2 e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string country: description: |- Country of the address * e.g. "United States" example: United States nullable: true type: string postalCode: description: |- Postal code of the address * e.g. "99660" example: '99660' nullable: true type: string currency: description: |- Currency code used by vendor e.g. "USD" example: USD nullable: true type: string balance: description: |- Balance in ledger for vendor in cents e.g. 650000 example: 650000 nullable: true type: integer bankAccountName: description: |- Bank account name associated with the vendor e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank acount number associated with the vendor e.g. "123654" example: '123654' nullable: true type: string notes: description: |- Additional note attached to vendor e.g. "Quality vendor" example: Quality vendor nullable: true type: string taxType: description: |- Type of tax applied to vendor e.g. "Global" example: Global nullable: true type: string isContractor: description: Whether the vendor is a contractor example: true nullable: true type: boolean active: description: Whether the vendor is active example: true nullable: true type: boolean created: description: |- Date of vendor account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time termId: description: >- Reference to a Term object (payment terms) associated with this Vendor e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Vendor e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Vendor e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string VendorCreateResourceRequest2: description: '' type: object properties: id: description: >- Unique identifier for this vendor note that no particular pattern in this field is guaranteed, only that this field is unique e.g: "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string givenName: description: |- First name of the vendor e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the vendor e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company e.g. "Doyle-Koch LLC" example: Doyle-Koch LLC nullable: true type: string displayName: description: |- Name displayed for vendor e.g. "Doyle-Koch" example: Doyle-Koch nullable: true type: string contactName: description: |- Name of the main contact for the vendor e.g. "John Smith" example: John Smith nullable: true type: string contactTitle: description: |- Title of the main contact for the vendor e.g. "Account Manager" example: Account Manager nullable: true type: string accountNumber: description: |- Account number for the vendor e.g. "420042" example: '420042' nullable: true type: string phone: description: |- Phone number e.g. "281-381-4241" example: 281-381-4241 nullable: true type: string mobile: description: |- Mobile number e.g. "786-258-0182" example: 786-258-0182 nullable: true type: string fax: description: |- Fax number e.g. "281-381-4255" example: 281-381-4255 nullable: true type: string email: description: |- Email address for the vendor e.g. "doyle-koch@email.com" example: doyle-koch@email.com nullable: true type: string website: description: |- Vendor website e.g. "https://www.doylekoch.com" example: https://www.doylekoch.com nullable: true type: string address: description: |- First line of vendor address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Vendor address line 2 e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string country: description: |- Country of the address * e.g. "United States" example: United States nullable: true type: string postalCode: description: |- Postal code of the address * e.g. "99660" example: '99660' nullable: true type: string currency: description: |- Currency code used by vendor e.g. "USD" example: USD nullable: true type: string balance: description: |- Balance in ledger for vendor in cents e.g. 650000 example: 650000 nullable: true type: integer bankAccountName: description: |- Bank account name associated with the vendor e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank acount number associated with the vendor e.g. "123654" example: '123654' nullable: true type: string notes: description: |- Additional note attached to vendor e.g. "Quality vendor" example: Quality vendor nullable: true type: string taxType: description: |- Type of tax applied to vendor e.g. "Global" example: Global nullable: true type: string isContractor: description: Whether the vendor is a contractor example: true nullable: true type: boolean active: description: Whether the vendor is active example: true nullable: true type: boolean created: description: |- Date of vendor account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time termId: description: >- Reference to a Term object (payment terms) associated with this Vendor e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Vendor e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Vendor e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string VendorCreateResourceRequest3: description: '' type: object properties: id: description: >- Unique identifier for this vendor note that no particular pattern in this field is guaranteed, only that this field is unique e.g: "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string givenName: description: |- First name of the vendor e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the vendor e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company e.g. "Doyle-Koch LLC" example: Doyle-Koch LLC nullable: true type: string displayName: description: |- Name displayed for vendor e.g. "Doyle-Koch" example: Doyle-Koch nullable: true type: string contactName: description: |- Name of the main contact for the vendor e.g. "John Smith" example: John Smith nullable: true type: string contactTitle: description: |- Title of the main contact for the vendor e.g. "Account Manager" example: Account Manager nullable: true type: string accountNumber: description: |- Account number for the vendor e.g. "420042" example: '420042' nullable: true type: string phone: description: |- Phone number e.g. "281-381-4241" example: 281-381-4241 nullable: true type: string mobile: description: |- Mobile number e.g. "786-258-0182" example: 786-258-0182 nullable: true type: string fax: description: |- Fax number e.g. "281-381-4255" example: 281-381-4255 nullable: true type: string email: description: |- Email address for the vendor e.g. "doyle-koch@email.com" example: doyle-koch@email.com nullable: true type: string website: description: |- Vendor website e.g. "https://www.doylekoch.com" example: https://www.doylekoch.com nullable: true type: string address: description: |- First line of vendor address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Vendor address line 2 e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string country: description: |- Country of the address * e.g. "United States" example: United States nullable: true type: string postalCode: description: |- Postal code of the address * e.g. "99660" example: '99660' nullable: true type: string currency: description: |- Currency code used by vendor e.g. "USD" example: USD nullable: true type: string balance: description: |- Balance in ledger for vendor in cents e.g. 650000 example: 650000 nullable: true type: integer bankAccountName: description: |- Bank account name associated with the vendor e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank acount number associated with the vendor e.g. "123654" example: '123654' nullable: true type: string notes: description: |- Additional note attached to vendor e.g. "Quality vendor" example: Quality vendor nullable: true type: string taxType: description: |- Type of tax applied to vendor e.g. "Global" example: Global nullable: true type: string isContractor: description: Whether the vendor is a contractor example: true nullable: true type: boolean active: description: Whether the vendor is active example: true nullable: true type: boolean created: description: |- Date of vendor account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time termId: description: >- Reference to a Term object (payment terms) associated with this Vendor e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Vendor e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Vendor e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string VendorCreateResourceRequest4: description: '' type: object properties: id: description: >- Unique identifier for this vendor note that no particular pattern in this field is guaranteed, only that this field is unique e.g: "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string givenName: description: |- First name of the vendor e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the vendor e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company e.g. "Doyle-Koch LLC" example: Doyle-Koch LLC nullable: true type: string displayName: description: |- Name displayed for vendor e.g. "Doyle-Koch" example: Doyle-Koch nullable: true type: string contactName: description: |- Name of the main contact for the vendor e.g. "John Smith" example: John Smith nullable: true type: string contactTitle: description: |- Title of the main contact for the vendor e.g. "Account Manager" example: Account Manager nullable: true type: string accountNumber: description: |- Account number for the vendor e.g. "420042" example: '420042' nullable: true type: string phone: description: |- Phone number e.g. "281-381-4241" example: 281-381-4241 nullable: true type: string mobile: description: |- Mobile number e.g. "786-258-0182" example: 786-258-0182 nullable: true type: string fax: description: |- Fax number e.g. "281-381-4255" example: 281-381-4255 nullable: true type: string email: description: |- Email address for the vendor e.g. "doyle-koch@email.com" example: doyle-koch@email.com nullable: true type: string website: description: |- Vendor website e.g. "https://www.doylekoch.com" example: https://www.doylekoch.com nullable: true type: string address: description: |- First line of vendor address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Vendor address line 2 e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string country: description: |- Country of the address * e.g. "United States" example: United States nullable: true type: string postalCode: description: |- Postal code of the address * e.g. "99660" example: '99660' nullable: true type: string currency: description: |- Currency code used by vendor e.g. "USD" example: USD nullable: true type: string balance: description: |- Balance in ledger for vendor in cents e.g. 650000 example: 650000 nullable: true type: integer bankAccountName: description: |- Bank account name associated with the vendor e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank acount number associated with the vendor e.g. "123654" example: '123654' nullable: true type: string notes: description: |- Additional note attached to vendor e.g. "Quality vendor" example: Quality vendor nullable: true type: string taxType: description: |- Type of tax applied to vendor e.g. "Global" example: Global nullable: true type: string isContractor: description: Whether the vendor is a contractor example: true nullable: true type: boolean active: description: Whether the vendor is active example: true nullable: true type: boolean created: description: |- Date of vendor account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time termId: description: >- Reference to a Term object (payment terms) associated with this Vendor e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Vendor e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Vendor e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string VendorReplaceResourceRequest: description: '' type: object properties: id: description: >- Unique identifier for this vendor note that no particular pattern in this field is guaranteed, only that this field is unique e.g: "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string givenName: description: |- First name of the vendor e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the vendor e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company e.g. "Doyle-Koch LLC" example: Doyle-Koch LLC nullable: true type: string displayName: description: |- Name displayed for vendor e.g. "Doyle-Koch" example: Doyle-Koch nullable: true type: string contactName: description: |- Name of the main contact for the vendor e.g. "John Smith" example: John Smith nullable: true type: string contactTitle: description: |- Title of the main contact for the vendor e.g. "Account Manager" example: Account Manager nullable: true type: string accountNumber: description: |- Account number for the vendor e.g. "420042" example: '420042' nullable: true type: string phone: description: |- Phone number e.g. "281-381-4241" example: 281-381-4241 nullable: true type: string mobile: description: |- Mobile number e.g. "786-258-0182" example: 786-258-0182 nullable: true type: string fax: description: |- Fax number e.g. "281-381-4255" example: 281-381-4255 nullable: true type: string email: description: |- Email address for the vendor e.g. "doyle-koch@email.com" example: doyle-koch@email.com nullable: true type: string website: description: |- Vendor website e.g. "https://www.doylekoch.com" example: https://www.doylekoch.com nullable: true type: string address: description: |- First line of vendor address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Vendor address line 2 e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string country: description: |- Country of the address * e.g. "United States" example: United States nullable: true type: string postalCode: description: |- Postal code of the address * e.g. "99660" example: '99660' nullable: true type: string currency: description: |- Currency code used by vendor e.g. "USD" example: USD nullable: true type: string balance: description: |- Balance in ledger for vendor in cents e.g. 650000 example: 650000 nullable: true type: integer bankAccountName: description: |- Bank account name associated with the vendor e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank acount number associated with the vendor e.g. "123654" example: '123654' nullable: true type: string notes: description: |- Additional note attached to vendor e.g. "Quality vendor" example: Quality vendor nullable: true type: string taxType: description: |- Type of tax applied to vendor e.g. "Global" example: Global nullable: true type: string isContractor: description: Whether the vendor is a contractor example: true nullable: true type: boolean active: description: Whether the vendor is active example: true nullable: true type: boolean created: description: |- Date of vendor account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time termId: description: >- Reference to a Term object (payment terms) associated with this Vendor e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Vendor e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Vendor e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string VendorReplaceResourceRequest1: description: '' type: object properties: id: description: >- Unique identifier for this vendor note that no particular pattern in this field is guaranteed, only that this field is unique e.g: "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string givenName: description: |- First name of the vendor e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the vendor e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company e.g. "Doyle-Koch LLC" example: Doyle-Koch LLC nullable: true type: string displayName: description: |- Name displayed for vendor e.g. "Doyle-Koch" example: Doyle-Koch nullable: true type: string contactName: description: |- Name of the main contact for the vendor e.g. "John Smith" example: John Smith nullable: true type: string contactTitle: description: |- Title of the main contact for the vendor e.g. "Account Manager" example: Account Manager nullable: true type: string accountNumber: description: |- Account number for the vendor e.g. "420042" example: '420042' nullable: true type: string phone: description: |- Phone number e.g. "281-381-4241" example: 281-381-4241 nullable: true type: string mobile: description: |- Mobile number e.g. "786-258-0182" example: 786-258-0182 nullable: true type: string fax: description: |- Fax number e.g. "281-381-4255" example: 281-381-4255 nullable: true type: string email: description: |- Email address for the vendor e.g. "doyle-koch@email.com" example: doyle-koch@email.com nullable: true type: string website: description: |- Vendor website e.g. "https://www.doylekoch.com" example: https://www.doylekoch.com nullable: true type: string address: description: |- First line of vendor address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Vendor address line 2 e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string country: description: |- Country of the address * e.g. "United States" example: United States nullable: true type: string postalCode: description: |- Postal code of the address * e.g. "99660" example: '99660' nullable: true type: string currency: description: |- Currency code used by vendor e.g. "USD" example: USD nullable: true type: string balance: description: |- Balance in ledger for vendor in cents e.g. 650000 example: 650000 nullable: true type: integer bankAccountName: description: |- Bank account name associated with the vendor e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank acount number associated with the vendor e.g. "123654" example: '123654' nullable: true type: string notes: description: |- Additional note attached to vendor e.g. "Quality vendor" example: Quality vendor nullable: true type: string taxType: description: |- Type of tax applied to vendor e.g. "Global" example: Global nullable: true type: string isContractor: description: Whether the vendor is a contractor example: true nullable: true type: boolean active: description: Whether the vendor is active example: true nullable: true type: boolean created: description: |- Date of vendor account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time termId: description: >- Reference to a Term object (payment terms) associated with this Vendor e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Vendor e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Vendor e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string VendorReplaceResourceRequest2: description: '' type: object properties: id: description: >- Unique identifier for this vendor note that no particular pattern in this field is guaranteed, only that this field is unique e.g: "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string givenName: description: |- First name of the vendor e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the vendor e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company e.g. "Doyle-Koch LLC" example: Doyle-Koch LLC nullable: true type: string displayName: description: |- Name displayed for vendor e.g. "Doyle-Koch" example: Doyle-Koch nullable: true type: string contactName: description: |- Name of the main contact for the vendor e.g. "John Smith" example: John Smith nullable: true type: string contactTitle: description: |- Title of the main contact for the vendor e.g. "Account Manager" example: Account Manager nullable: true type: string accountNumber: description: |- Account number for the vendor e.g. "420042" example: '420042' nullable: true type: string phone: description: |- Phone number e.g. "281-381-4241" example: 281-381-4241 nullable: true type: string mobile: description: |- Mobile number e.g. "786-258-0182" example: 786-258-0182 nullable: true type: string fax: description: |- Fax number e.g. "281-381-4255" example: 281-381-4255 nullable: true type: string email: description: |- Email address for the vendor e.g. "doyle-koch@email.com" example: doyle-koch@email.com nullable: true type: string website: description: |- Vendor website e.g. "https://www.doylekoch.com" example: https://www.doylekoch.com nullable: true type: string address: description: |- First line of vendor address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Vendor address line 2 e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string country: description: |- Country of the address * e.g. "United States" example: United States nullable: true type: string postalCode: description: |- Postal code of the address * e.g. "99660" example: '99660' nullable: true type: string currency: description: |- Currency code used by vendor e.g. "USD" example: USD nullable: true type: string balance: description: |- Balance in ledger for vendor in cents e.g. 650000 example: 650000 nullable: true type: integer bankAccountName: description: |- Bank account name associated with the vendor e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank acount number associated with the vendor e.g. "123654" example: '123654' nullable: true type: string notes: description: |- Additional note attached to vendor e.g. "Quality vendor" example: Quality vendor nullable: true type: string taxType: description: |- Type of tax applied to vendor e.g. "Global" example: Global nullable: true type: string isContractor: description: Whether the vendor is a contractor example: true nullable: true type: boolean active: description: Whether the vendor is active example: true nullable: true type: boolean created: description: |- Date of vendor account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time termId: description: >- Reference to a Term object (payment terms) associated with this Vendor e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Vendor e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Vendor e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string VendorReplaceResourceRequest3: description: '' type: object properties: id: description: >- Unique identifier for this vendor note that no particular pattern in this field is guaranteed, only that this field is unique e.g: "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string givenName: description: |- First name of the vendor e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the vendor e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company e.g. "Doyle-Koch LLC" example: Doyle-Koch LLC nullable: true type: string displayName: description: |- Name displayed for vendor e.g. "Doyle-Koch" example: Doyle-Koch nullable: true type: string contactName: description: |- Name of the main contact for the vendor e.g. "John Smith" example: John Smith nullable: true type: string contactTitle: description: |- Title of the main contact for the vendor e.g. "Account Manager" example: Account Manager nullable: true type: string accountNumber: description: |- Account number for the vendor e.g. "420042" example: '420042' nullable: true type: string phone: description: |- Phone number e.g. "281-381-4241" example: 281-381-4241 nullable: true type: string mobile: description: |- Mobile number e.g. "786-258-0182" example: 786-258-0182 nullable: true type: string fax: description: |- Fax number e.g. "281-381-4255" example: 281-381-4255 nullable: true type: string email: description: |- Email address for the vendor e.g. "doyle-koch@email.com" example: doyle-koch@email.com nullable: true type: string website: description: |- Vendor website e.g. "https://www.doylekoch.com" example: https://www.doylekoch.com nullable: true type: string address: description: |- First line of vendor address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Vendor address line 2 e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string country: description: |- Country of the address * e.g. "United States" example: United States nullable: true type: string postalCode: description: |- Postal code of the address * e.g. "99660" example: '99660' nullable: true type: string currency: description: |- Currency code used by vendor e.g. "USD" example: USD nullable: true type: string balance: description: |- Balance in ledger for vendor in cents e.g. 650000 example: 650000 nullable: true type: integer bankAccountName: description: |- Bank account name associated with the vendor e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank acount number associated with the vendor e.g. "123654" example: '123654' nullable: true type: string notes: description: |- Additional note attached to vendor e.g. "Quality vendor" example: Quality vendor nullable: true type: string taxType: description: |- Type of tax applied to vendor e.g. "Global" example: Global nullable: true type: string isContractor: description: Whether the vendor is a contractor example: true nullable: true type: boolean active: description: Whether the vendor is active example: true nullable: true type: boolean created: description: |- Date of vendor account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time termId: description: >- Reference to a Term object (payment terms) associated with this Vendor e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Vendor e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Vendor e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string VendorReplaceResourceRequest4: description: '' type: object properties: id: description: >- Unique identifier for this vendor note that no particular pattern in this field is guaranteed, only that this field is unique e.g: "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string givenName: description: |- First name of the vendor e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the vendor e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company e.g. "Doyle-Koch LLC" example: Doyle-Koch LLC nullable: true type: string displayName: description: |- Name displayed for vendor e.g. "Doyle-Koch" example: Doyle-Koch nullable: true type: string contactName: description: |- Name of the main contact for the vendor e.g. "John Smith" example: John Smith nullable: true type: string contactTitle: description: |- Title of the main contact for the vendor e.g. "Account Manager" example: Account Manager nullable: true type: string accountNumber: description: |- Account number for the vendor e.g. "420042" example: '420042' nullable: true type: string phone: description: |- Phone number e.g. "281-381-4241" example: 281-381-4241 nullable: true type: string mobile: description: |- Mobile number e.g. "786-258-0182" example: 786-258-0182 nullable: true type: string fax: description: |- Fax number e.g. "281-381-4255" example: 281-381-4255 nullable: true type: string email: description: |- Email address for the vendor e.g. "doyle-koch@email.com" example: doyle-koch@email.com nullable: true type: string website: description: |- Vendor website e.g. "https://www.doylekoch.com" example: https://www.doylekoch.com nullable: true type: string address: description: |- First line of vendor address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Vendor address line 2 e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string country: description: |- Country of the address * e.g. "United States" example: United States nullable: true type: string postalCode: description: |- Postal code of the address * e.g. "99660" example: '99660' nullable: true type: string currency: description: |- Currency code used by vendor e.g. "USD" example: USD nullable: true type: string balance: description: |- Balance in ledger for vendor in cents e.g. 650000 example: 650000 nullable: true type: integer bankAccountName: description: |- Bank account name associated with the vendor e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank acount number associated with the vendor e.g. "123654" example: '123654' nullable: true type: string notes: description: |- Additional note attached to vendor e.g. "Quality vendor" example: Quality vendor nullable: true type: string taxType: description: |- Type of tax applied to vendor e.g. "Global" example: Global nullable: true type: string isContractor: description: Whether the vendor is a contractor example: true nullable: true type: boolean active: description: Whether the vendor is active example: true nullable: true type: boolean created: description: |- Date of vendor account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time termId: description: >- Reference to a Term object (payment terms) associated with this Vendor e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Vendor e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Vendor e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string AccountingTransactionGetCollectionResponse: type: array items: description: '' type: object properties: description: description: Transaction description type: string nullable: true id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-34" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string transactionId: description: |- Transaction type e.g. Payment type: string nullable: true transactionType: description: |- Transaction type e.g. Payment type: string nullable: true transactionNumber: description: |- Transaction number e.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 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 e.g: 870 type: integer nullable: true taxType: description: |- Amount of the transaction in cents e.g: 870 type: string nullable: true totalAmount: description: |- Amount of the transaction in cents e.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: {} AccountingTransactionGetCollection200Response: type: array items: description: '' type: object properties: description: description: Transaction description type: string nullable: true id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-34" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string transactionId: description: |- Transaction type e.g. Payment type: string nullable: true transactionType: description: |- Transaction type e.g. Payment type: string nullable: true transactionNumber: description: |- Transaction number e.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 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 e.g: 870 type: integer nullable: true taxType: description: |- Amount of the transaction in cents e.g: 870 type: string nullable: true totalAmount: description: |- Amount of the transaction in cents e.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: {} AccountingTransactionGetResourceResponse: description: '' type: object properties: description: description: Transaction description type: string nullable: true id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-34" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string transactionId: description: |- Transaction type e.g. Payment type: string nullable: true transactionType: description: |- Transaction type e.g. Payment type: string nullable: true transactionNumber: description: |- Transaction number e.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 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 e.g: 870 type: integer nullable: true taxType: description: |- Amount of the transaction in cents e.g: 870 type: string nullable: true totalAmount: description: |- Amount of the transaction in cents e.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: {} AccountingTransactionGetResource200Response: description: '' type: object properties: description: description: Transaction description type: string nullable: true id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-34" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string transactionId: description: |- Transaction type e.g. Payment type: string nullable: true transactionType: description: |- Transaction type e.g. Payment type: string nullable: true transactionNumber: description: |- Transaction number e.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 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 e.g: 870 type: integer nullable: true taxType: description: |- Amount of the transaction in cents e.g: 870 type: string nullable: true totalAmount: description: |- Amount of the transaction in cents e.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: {} AccountGetCollectionResponse: type: array items: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: >- when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name AccountGetCollection200Response: type: array items: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: >- when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name AccountCreateResourceResponse: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name AccountCreateResource201Response: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name AccountGetResourceResponse: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name AccountGetResource200Response: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name AccountReplaceResourceResponse: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name AccountReplaceResource200Response: description: Accounting chart of accounts type: object properties: description: description: |- a user definable long form description of the account e.g. "This is the main company account for income and expenses" example: This is the main company account for income and expenses nullable: true type: string id: description: >- unique identifier for this account note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string code: description: |- customer defined code for the account e.g. "400" e.g. "SALES" example: '400' nullable: true type: string taxType: description: |- a tax code used for the account e.g. "TAX001" example: TAX001 nullable: true type: string bankAccountNumber: description: >- a code used to identify a bank account, only applies to accounts directly linked to a bank account e.g. "823772-2828773-09826" example: 823772-2828773-09826 nullable: true type: string bankAccountType: description: |- indicates the type of bank account being used e.g. "BANK" e.g. "CREDITCARD" e.g. "PAYPAL" example: CREDITCARD nullable: true type: string currencyCode: description: |- the currency code e.g. "USD" example: USD nullable: true type: string fullyQualifiedName: description: |- full canonical name for the account e.g. Short term cash example: Short Term Cash nullable: true type: string name: description: |- short name for the account e.g. "Sandra's Bank Account" example: Sandra's Bank Account nullable: true type: string classification: description: >- The accounting classification of the account, typically one of Asset, Liability, Equity, Revenue, or Expense. example: Asset nullable: true type: string accountSubType: description: |- application based classification of the account e.g. "BANK" example: BANK nullable: true type: string currentBalanceWithSubAccounts: description: >- represents the total value of the account including any sub accounts in cents example: '387687' nullable: true type: string created: description: when the account was created example: '2021-06-24 22:35:07' nullable: true type: string format: date-time modified: description: when any user modifiable attributes of the object were last changed example: '2021-06-24 22:35:07' nullable: true type: string format: date-time accountType: description: |- the type or class of the account e.g. "ASSET" example: ASSET nullable: true type: string currentBalance: description: the value of the account excluding any sub accounts in cents example: '29872' nullable: true type: string active: description: >- whether or not the account is active and should be included in calculations example: true nullable: true type: boolean subAccount: description: whether this account is actually a subaccount of another account example: false nullable: true type: boolean srcId: description: |- the unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: true type: string parentAccountId: description: |- if this is a subaccount then the id of the parent account e.g. "JS882-67283H-YW82KHX-2883KK-DJ3SK" example: JS882-67283H-YW82KHX-2883KK-DJ3SK nullable: true type: string deleted: description: whether or not the account is active example: false nullable: true type: boolean required: - name ActivityGetCollectionResponse: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: type: string date: type: string format: date-time nullable: true emailsSent: type: integer nullable: true totalItems: type: integer nullable: true ActivityGetCollection200Response: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: type: string date: type: string format: date-time nullable: true emailsSent: type: integer nullable: true totalItems: type: integer nullable: true ActivityGetResourceResponse: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: type: string date: type: string format: date-time nullable: true emailsSent: type: integer nullable: true totalItems: type: integer nullable: true ActivityGetResource200Response: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: type: string date: type: string format: date-time nullable: true emailsSent: type: integer nullable: true totalItems: type: integer nullable: true AgedPayablesExcelGetWorkbookResponse: description: provides an excel workbook of an aged payables report type: object properties: asOf: example: This endpoint returns an .xlsx file. AgedPayablesExcelGetWorkbook200Response: description: provides an excel workbook of an aged payables report type: object properties: asOf: example: This endpoint returns an .xlsx file. AgedPayablesReportGetReportResponse: description: Provides an Aged Payables Report type: object properties: 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: 32X name: Cal Telephone current: 0 1to30: 56.5 31to60: 0 61to90: 0 91andOver: 0 total: 56.5 - id: 48X 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 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 sources: type: array items: type: string example: - xero AgedPayablesReportGetReport200Response: description: Provides an Aged Payables Report type: object properties: 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: 32X name: Cal Telephone current: 0 1to30: 56.5 31to60: 0 61to90: 0 91andOver: 0 total: 56.5 - id: 48X 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 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 sources: type: array items: type: string example: - xero AgedReceivablesExcelGetWorkbookResponse: description: provides an excel workbook of an aged receivables report type: object properties: file: example: This endpoint returns an .xlsx file. AgedReceivablesExcelGetWorkbook200Response: description: provides an excel workbook of an aged receivables report type: object properties: file: example: This endpoint returns an .xlsx file. AgedReceivablesReportGetResourceResponse: description: Provides an Aged Receivables Report type: object properties: 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: 1X name: Amy's Bird Sanctuary current: 0 1to30: 0 31to60: 239 61to90: 0 91andOver: 0 total: 239 - id: 2X name: Bill's Windsurf Shop current: 0 1to30: 0 31to60: 85 61to90: 0 91andOver: 0 total: 85 - id: 8X name: Freeman Sporting Goods|0969 Ocean View Road current: 0 1to30: 477.5 31to60: 0 61to90: 0 91andOver: 0 total: 477.5 - id: 9X name: Freeman Sporting Goods|55 Twin Lane current: 0 1to30: 4 31to60: 81 61to90: 0 91andOver: 0 total: 85 - id: 10X name: Geeta Kalapatapu current: 0 1to30: 629.1 31to60: 0 61to90: 0 91andOver: 0 total: 629.1 - id: 12X name: Jeff's Jalopies current: 0 1to30: 0 31to60: 81 61to90: 0 91andOver: 0 total: 81 - id: 13X name: John Melton current: 0 1to30: 0 31to60: 450 61to90: 0 91andOver: 0 total: 450 - id: 16X name: Kookies by Kathy current: 0 1to30: 0 31to60: 0 61to90: 75 91andOver: 0 total: 75 - id: 17X name: Mark Cho current: 0 1to30: 314.28 31to60: 0 61to90: 0 91andOver: 0 total: 314.28 - id: 18X name: Paulsen Medical Supplies current: 0 1to30: 954.75 31to60: 0 61to90: 0 91andOver: 0 total: 954.75 - id: 20X name: Red Rock Diner current: 0 1to30: 70 31to60: 0 61to90: 156 91andOver: 0 total: 226 - id: 21X name: Rondonuwu Fruit and Vegi current: 0 1to30: 78.6 31to60: 0 61to90: 0 91andOver: 0 total: 78.6 - id: 23X name: Shara Barnett|Barnett Design current: 0 1to30: 274.5 31to60: 0 61to90: 0 91andOver: 0 total: 274.5 - id: 24X name: Sonnenschein Family Store current: 0 1to30: 362.07 31to60: 0 61to90: 0 91andOver: 0 total: 362.07 - id: 25X name: Sushi by Katsuyuki current: 0 1to30: 160 31to60: 0 61to90: 0 91andOver: 0 total: 160 - id: 26X name: Travis Waldron current: 0 1to30: 414.72 31to60: 0 61to90: 0 91andOver: 0 total: 414.72 - id: 29X 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 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 sources: type: array items: type: string example: - xero AgedReceivablesReportGetResource200Response: description: Provides an Aged Receivables Report type: object properties: 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: 1X name: Amy's Bird Sanctuary current: 0 1to30: 0 31to60: 239 61to90: 0 91andOver: 0 total: 239 - id: 2X name: Bill's Windsurf Shop current: 0 1to30: 0 31to60: 85 61to90: 0 91andOver: 0 total: 85 - id: 8X name: Freeman Sporting Goods|0969 Ocean View Road current: 0 1to30: 477.5 31to60: 0 61to90: 0 91andOver: 0 total: 477.5 - id: 9X name: Freeman Sporting Goods|55 Twin Lane current: 0 1to30: 4 31to60: 81 61to90: 0 91andOver: 0 total: 85 - id: 10X name: Geeta Kalapatapu current: 0 1to30: 629.1 31to60: 0 61to90: 0 91andOver: 0 total: 629.1 - id: 12X name: Jeff's Jalopies current: 0 1to30: 0 31to60: 81 61to90: 0 91andOver: 0 total: 81 - id: 13X name: John Melton current: 0 1to30: 0 31to60: 450 61to90: 0 91andOver: 0 total: 450 - id: 16X name: Kookies by Kathy current: 0 1to30: 0 31to60: 0 61to90: 75 91andOver: 0 total: 75 - id: 17X name: Mark Cho current: 0 1to30: 314.28 31to60: 0 61to90: 0 91andOver: 0 total: 314.28 - id: 18X name: Paulsen Medical Supplies current: 0 1to30: 954.75 31to60: 0 61to90: 0 91andOver: 0 total: 954.75 - id: 20X name: Red Rock Diner current: 0 1to30: 70 31to60: 0 61to90: 156 91andOver: 0 total: 226 - id: 21X name: Rondonuwu Fruit and Vegi current: 0 1to30: 78.6 31to60: 0 61to90: 0 91andOver: 0 total: 78.6 - id: 23X name: Shara Barnett|Barnett Design current: 0 1to30: 274.5 31to60: 0 61to90: 0 91andOver: 0 total: 274.5 - id: 24X name: Sonnenschein Family Store current: 0 1to30: 362.07 31to60: 0 61to90: 0 91andOver: 0 total: 362.07 - id: 25X name: Sushi by Katsuyuki current: 0 1to30: 160 31to60: 0 61to90: 0 91andOver: 0 total: 160 - id: 26X name: Travis Waldron current: 0 1to30: 414.72 31to60: 0 61to90: 0 91andOver: 0 total: 414.72 - id: 29X 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 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 sources: type: array items: type: string example: - xero ApplicationChargeGetCollectionResponse: type: array items: description: A one time charge within an application type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "pending" e.g. "accepted" e.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 ApplicationChargeGetCollection200Response: type: array items: description: A one time charge within an application type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "pending" e.g. "accepted" e.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 ApplicationChargeGetResourceResponse: description: A one time charge within an application type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "pending" e.g. "accepted" e.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 ApplicationChargeGetResource200Response: description: A one time charge within an application type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "pending" e.g. "accepted" e.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 ApplicationCreditGetCollectionResponse: type: array items: description: >- Application credit represents credits issued to merchants that can be used towards future app purchases type: object properties: description: description: A description of the application credit type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false readOnly: true type: string srcId: description: Unique identifier for each application credit type: string amount: description: Amount refunded by the application credit type: integer ApplicationCreditGetCollection200Response: type: array items: description: >- Application credit represents credits issued to merchants that can be used towards future app purchases type: object properties: description: description: A description of the application credit type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false readOnly: true type: string srcId: description: Unique identifier for each application credit type: string amount: description: Amount refunded by the application credit type: integer ApplicationCreditGetResourceResponse: description: >- Application credit represents credits issued to merchants that can be used towards future app purchases type: object properties: description: description: A description of the application credit type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false readOnly: true type: string srcId: description: Unique identifier for each application credit type: string amount: description: Amount refunded by the application credit type: integer ApplicationCreditGetResource200Response: description: >- Application credit represents credits issued to merchants that can be used towards future app purchases type: object properties: description: description: A description of the application credit type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false readOnly: true type: string srcId: description: Unique identifier for each application credit type: string amount: description: Amount refunded by the application credit type: integer AssetGetCollectionResponse: type: array items: description: '' type: object properties: description: description: Additional details about the asset type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 AssetGetCollection200Response: type: array items: description: '' type: object properties: description: description: Additional details about the asset type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 AssetGetResourceResponse: description: '' type: object properties: description: description: Additional details about the asset type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 AssetGetResource200Response: description: '' type: object properties: description: description: Additional details about the asset type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 BalanceHistoryGetCollectionResponse: type: array items: description: >- Balance history represents charges that have contributed to the account balance e.g. charges & transfers type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.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 e.g. "available", "pending" type: string nullable: true balanceType: description: |- The type of transaction e.g. "Charge" e.g. "Refund" type: string nullable: true BalanceHistoryGetCollection200Response: type: array items: description: >- Balance history represents charges that have contributed to the account balance e.g. charges & transfers type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.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 e.g. "available", "pending" type: string nullable: true balanceType: description: |- The type of transaction e.g. "Charge" e.g. "Refund" type: string nullable: true BalanceHistoryGetResourceResponse: description: >- Balance history represents charges that have contributed to the account balance e.g. charges & transfers type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.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 e.g. "available", "pending" type: string nullable: true balanceType: description: |- The type of transaction e.g. "Charge" e.g. "Refund" type: string nullable: true BalanceHistoryGetResource200Response: description: >- Balance history represents charges that have contributed to the account balance e.g. charges & transfers type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.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 e.g. "available", "pending" type: string nullable: true balanceType: description: |- The type of transaction e.g. "Charge" e.g. "Refund" type: string nullable: true BalanceSheetExcelGetWorkbookResponse: description: provides an excel workbook of a series of mapped balance sheets type: object properties: file: example: This endpoint returns an .xlsx file. BalanceSheetExcelGetWorkbook200Response: description: provides an excel workbook of a series of mapped balance sheets type: object properties: file: example: This endpoint returns an .xlsx file. BalanceSheetReportGetMappedReportResponse: description: provides a mapped balance sheet type: object 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: 56X name: Cash on hand value: 279325.6 mapping: Assets - Cash - id: 59X name: Accounts Receivable (A/R) value: 59325 mapping: Assets - AR - id: 54X name: Inventory Asset value: 4000 mapping: Assets - Inventory - id: 62X name: Accounts Payable (A/P) value: 0 mapping: Liabilities - AP - id: 57X name: GST/HST Payable value: 40386.34 mapping: Liabilities - Taxes - id: 61X name: Bank loans value: 25000 - id: 55X name: Opening Balance Equity value: -5000 mapping: Equity - Investment - id: 50X 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 BalanceSheetReportGetMappedReport200Response: description: provides a mapped balance sheet type: object 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: 56X name: Cash on hand value: 279325.6 mapping: Assets - Cash - id: 59X name: Accounts Receivable (A/R) value: 59325 mapping: Assets - AR - id: 54X name: Inventory Asset value: 4000 mapping: Assets - Inventory - id: 62X name: Accounts Payable (A/P) value: 0 mapping: Liabilities - AP - id: 57X name: GST/HST Payable value: 40386.34 mapping: Liabilities - Taxes - id: 61X name: Bank loans value: 25000 - id: 55X name: Opening Balance Equity value: -5000 mapping: Equity - Investment - id: 50X 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 BalanceSheetGetResourceResponse: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string reportTitle: description: 'e.g: BalanceSheet' example: Balance Sheet nullable: true type: string companyName: description: 'e.g: the company legal name' example: Flux Capacitors Inc nullable: true 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: description: >- accounting method: a set of rules under which revenues and expenses are reported in financial statements e.g: cash example: cash nullable: false type: string start: description: start datetime of the balancesheet coverage example: '2021-01-01' nullable: true type: string format: date-time end: description: end datetime of the balancesheet coverage example: '2021-01-31' nullable: true type: string format: date-time currencyCode: example: USD nullable: true type: string totalAssets: description: Total assets in cents example: 2786282 nullable: true type: integer totalLiabilities: description: Total liabilities in cents example: 287622 nullable: true type: integer totalCurrentAssets: description: Total current assets in cents example: 89792 nullable: true type: integer totalCurrentLiabilities: description: Total current liabilities in cents example: 198339 nullable: true type: integer totalEquity: description: Total equity in cents example: 625282 nullable: true type: integer netIncome: type: integer nullable: true BalanceSheetGetResource200Response: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string reportTitle: description: 'e.g: BalanceSheet' example: Balance Sheet nullable: true type: string companyName: description: 'e.g: the company legal name' example: Flux Capacitors Inc nullable: true 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: description: >- accounting method: a set of rules under which revenues and expenses are reported in financial statements e.g: cash example: cash nullable: false type: string start: description: start datetime of the balancesheet coverage example: '2021-01-01' nullable: true type: string format: date-time end: description: end datetime of the balancesheet coverage example: '2021-01-31' nullable: true type: string format: date-time currencyCode: example: USD nullable: true type: string totalAssets: description: Total assets in cents example: 2786282 nullable: true type: integer totalLiabilities: description: Total liabilities in cents example: 287622 nullable: true type: integer totalCurrentAssets: description: Total current assets in cents example: 89792 nullable: true type: integer totalCurrentLiabilities: description: Total current liabilities in cents example: 198339 nullable: true type: integer totalEquity: description: Total equity in cents example: 625282 nullable: true type: integer netIncome: type: integer nullable: true BankAccountListResourcesResponse: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 BankAccountListResources200Response: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 BankAccountGetResourceResponse: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 BankAccountGetResource200Response: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 BankOpeningBalanceGetCollectionResponse: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 BankOpeningBalanceGetCollection200Response: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 BankOpeningBalanceGetResourceResponse: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 BankOpeningBalanceGetResource200Response: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 BankReconciliationGetCollectionResponse: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 BankReconciliationGetCollection200Response: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 BankReconciliationGetResourceResponse: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 BankReconciliationGetResource200Response: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 BankSummaryGetCollectionResponse: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string report_id: description: |- Report ID e.g: BankSummary readOnly: true type: string nullable: true name: description: |- Report Name e.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 BankSummaryGetCollection200Response: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string report_id: description: |- Report ID e.g: BankSummary readOnly: true type: string nullable: true name: description: |- Report Name e.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 BankSummaryGetResourceResponse: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string report_id: description: |- Report ID e.g: BankSummary readOnly: true type: string nullable: true name: description: |- Report Name e.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 BankSummaryGetResource200Response: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string report_id: description: |- Report ID e.g: BankSummary readOnly: true type: string nullable: true name: description: |- Report Name e.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 BankTransactionListResourcesResponse: type: array items: description: >- Bank transaction represents spend and receive money transactions, overpayments and prepayments type: object properties: description: type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "RECEIVE" e.g. "RECEIVE-OVERPAYMENT" type: string nullable: true lineAmountTypes: description: |- The type of line amount e.g. "Exclusive" e.g. "Inclusive" e.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 e.g. "INPUT" e.g. "OUTPUT e.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 BankTransactionListResources200Response: type: array items: description: >- Bank transaction represents spend and receive money transactions, overpayments and prepayments type: object properties: description: type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "RECEIVE" e.g. "RECEIVE-OVERPAYMENT" type: string nullable: true lineAmountTypes: description: |- The type of line amount e.g. "Exclusive" e.g. "Inclusive" e.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 e.g. "INPUT" e.g. "OUTPUT e.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 BankTransactionGetByIdResponse: description: >- Bank transaction represents spend and receive money transactions, overpayments and prepayments type: object properties: description: type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "RECEIVE" e.g. "RECEIVE-OVERPAYMENT" type: string nullable: true lineAmountTypes: description: |- The type of line amount e.g. "Exclusive" e.g. "Inclusive" e.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 e.g. "INPUT" e.g. "OUTPUT e.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 BankTransactionGetById200Response: description: >- Bank transaction represents spend and receive money transactions, overpayments and prepayments type: object properties: description: type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "RECEIVE" e.g. "RECEIVE-OVERPAYMENT" type: string nullable: true lineAmountTypes: description: |- The type of line amount e.g. "Exclusive" e.g. "Inclusive" e.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 e.g. "INPUT" e.g. "OUTPUT e.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 BankTransferGetCollectionResponse: type: array items: description: The transfer of money from one bank account to another type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 BankTransferGetCollection200Response: type: array items: description: The transfer of money from one bank account to another type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 BankTransferGetResourceResponse: description: The transfer of money from one bank account to another type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 BankTransferGetResource200Response: description: The transfer of money from one bank account to another type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 BatchPaymentListResourcesResponse: type: array items: description: >- Batch payment represents a single payment transaction that includes multiple bills or invoices type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "PAYBATCH" e.g. "RECBATCH" type: string nullable: true status: description: |- Status of the batch payment e.g. "authorised" e.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 BatchPaymentListResources200Response: type: array items: description: >- Batch payment represents a single payment transaction that includes multiple bills or invoices type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "PAYBATCH" e.g. "RECBATCH" type: string nullable: true status: description: |- Status of the batch payment e.g. "authorised" e.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 BatchPaymentGetResourceResponse: description: >- Batch payment represents a single payment transaction that includes multiple bills or invoices type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "PAYBATCH" e.g. "RECBATCH" type: string nullable: true status: description: |- Status of the batch payment e.g. "authorised" e.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 BatchPaymentGetResource200Response: description: >- Batch payment represents a single payment transaction that includes multiple bills or invoices type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "PAYBATCH" e.g. "RECBATCH" type: string nullable: true status: description: |- Status of the batch payment e.g. "authorised" e.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 BillPaymentGetCollectionResponse: type: array items: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time BillPaymentGetCollection200Response: type: array items: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time BillPaymentCreateResourceResponse: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time BillPaymentCreateResource201Response: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time BillPaymentGetResourceResponse: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time BillPaymentGetResource200Response: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time BillPaymentReplaceResourceResponse: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time BillPaymentReplaceResource200Response: description: '' type: object properties: id: example: quickbooks-321 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- the unique identifier of the source 3rd party integration e.g. "460000000053219" example: '460000000053219' nullable: false type: string billId: description: The source ID of the bill being paid example: '34' nullable: false type: string vendorPaymentId: description: >- The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: true type: string vendorId: description: |- Unique identifier for the vendor of the bill e.g. "460000000026049" example: '460000000026049' nullable: true type: string vendorName: description: |- Name of the vendor of the bill e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string paymentMode: description: |- Mode of payment e.g. "Stripe" example: Stripe nullable: true type: string txnDate: description: |- Date the payment is made e.g. "2013-10-07" example: '2013-10-07' nullable: true type: string format: date-time referenceNumber: description: |- Reference number for the payment recorded e.g. REF#912300 example: REF#912300 nullable: true type: string amount: description: |- Total amount of the payment in cents e.g. 12500 example: 12500 nullable: false type: integer currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string created: description: |- Creation time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time modified: description: |- Last modified time of the payment e.g. 2016-12-16T00:18:42-0500 example: 2016-12-16T00:18:42-0500 nullable: true type: string format: date-time BillGetCollectionResponse: type: array items: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer BillGetCollection200Response: type: array items: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer BillCreateResourceResponse: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer BillCreateResource201Response: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer BillGetResourceResponse: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer BillGetResource200Response: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer BillUpdateResourceResponse: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer BillUpdateResource200Response: description: '' type: object properties: id: description: >- Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345" example: quickbooks-345 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string vendorId: description: |- Vendor Id e.g. "15" example: '15' nullable: false type: string vendorName: description: |- Vendor full name e.g. "Acme Corp" example: Acme Corp nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string balance: description: |- Total balance of the bill in cents e.g. 70000 example: 70000 nullable: false type: integer txnDate: description: |- Transaction date e.g. "2021-05-12" example: '2021-05-12' nullable: true type: string format: date-time totalAmount: description: |- Total amount of the bill in cents e.g. 550000 example: 550000 nullable: false type: integer apAccountId: description: |- Account Id e.g. "15" example: '15' nullable: true type: string apAccountName: description: |- Account full name e.g. "Accounts Payable" example: Accounts Payable nullable: true type: string modified: description: |- Date entry was last modified e.g. "2013-11-18T02:17:40.080Z" example: '2013-12-18T02:17:40.080Z' nullable: false type: string format: date-time created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string status: description: |- Bill status e.g. "Paid" example: Paid nullable: true type: string identifier: description: |- The bill number e.g. "4560" example: '4560' nullable: true type: string referenceNumber: description: |- Reference number e.g. "1234" example: '1234' nullable: true type: string dueDate: description: |- Date bill is due e.g. "2021-05-30" example: '2021-05-30' nullable: true type: string format: date-time subtotal: description: |- Bill subtotal in cents e.g. 65000 example: 65000 nullable: true type: integer taxAmount: description: |- Bill tax amount in cents e.g. 12000 example: 12000 nullable: true type: integer BlogPostingGetCollectionResponse: type: array items: description: A blog post. type: object properties: title: description: The title of the blog post type: string nullable: true id: type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 BlogPostingGetCollection200Response: type: array items: description: A blog post. type: object properties: title: description: The title of the blog post type: string nullable: true id: type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 BlogPostingGetResourceResponse: description: A blog post. type: object properties: title: description: The title of the blog post type: string nullable: true id: type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 BlogPostingGetResource200Response: description: A blog post. type: object properties: title: description: The title of the blog post type: string nullable: true id: type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 BlogGetCollectionResponse: type: array items: description: A blog. type: object properties: description: description: A description of the blog type: string nullable: true id: type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 name: description: The name of the blog type: string updated: description: The date and time the blog was last modified type: string nullable: true BlogGetCollection200Response: type: array items: description: A blog. type: object properties: description: description: A description of the blog type: string nullable: true id: type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 name: description: The name of the blog type: string updated: description: The date and time the blog was last modified type: string nullable: true BlogGetResourceResponse: description: A blog. type: object properties: description: description: A description of the blog type: string nullable: true id: type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 name: description: The name of the blog type: string updated: description: The date and time the blog was last modified type: string nullable: true BlogGetResource200Response: description: A blog. type: object properties: description: description: A description of the blog type: string nullable: true id: type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 name: description: The name of the blog type: string updated: description: The date and time the blog was last modified type: string nullable: true BudgetSummaryGetResourceResponse: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string report_id: description: |- Report ID e.g: BudgetSummary readOnly: true type: string nullable: true name: description: |- Report name e.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 BudgetSummaryGetResource200Response: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string report_id: description: |- Report ID e.g: BudgetSummary readOnly: true type: string nullable: true name: description: |- Report name e.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 BudgetSummaryGetCollectionResponse: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string report_id: description: |- Report ID e.g: BudgetSummary readOnly: true type: string nullable: true name: description: |- Report name e.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 BudgetSummaryGetCollection200Response: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string report_id: description: |- Report ID e.g: BudgetSummary readOnly: true type: string nullable: true name: description: |- Report name e.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 CallGetCollectionResponse: type: array items: description: '' type: object properties: description: description: details about the call type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 CallGetCollection200Response: type: array items: description: '' type: object properties: description: description: details about the call type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 CallGetResourceResponse: description: '' type: object properties: description: description: details about the call type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 CallGetResource200Response: description: '' type: object properties: description: description: details about the call type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 CampaignReportGetCollectionResponse: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 CampaignReportGetCollection200Response: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 CampaignReportGetResourceResponse: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 CampaignReportGetResource200Response: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 CampaignGetCollectionResponse: type: array items: description: '' type: object properties: description: description: details about the campaign type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 e.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 CampaignGetCollection200Response: type: array items: description: '' type: object properties: description: description: details about the campaign type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 e.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 CampaignGetResourceResponse: description: '' type: object properties: description: description: details about the campaign type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 e.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 CampaignGetResource200Response: description: '' type: object properties: description: description: details about the campaign type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 e.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 ChargeGetCollectionResponse: type: array items: description: Charge represents charges made to a debit or credit card type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "succeeded" e.g. "pending" e.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 ChargeGetCollection200Response: type: array items: description: Charge represents charges made to a debit or credit card type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "succeeded" e.g. "pending" e.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 ChargeGetResourceResponse: description: Charge represents charges made to a debit or credit card type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "succeeded" e.g. "pending" e.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 ChargeGetResource200Response: description: Charge represents charges made to a debit or credit card type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "succeeded" e.g. "pending" e.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 ClientGetCollectionResponse: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: type: string emailClient: type: string nullable: true numMembers: type: integer nullable: true totalItems: type: integer nullable: true ClientGetCollection200Response: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: type: string emailClient: type: string nullable: true numMembers: type: integer nullable: true totalItems: type: integer nullable: true ClientGetResourceResponse: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: type: string emailClient: type: string nullable: true numMembers: type: integer nullable: true totalItems: type: integer nullable: true ClientGetResource200Response: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: type: string emailClient: type: string nullable: true numMembers: type: integer nullable: true totalItems: type: integer nullable: true CompanyGetCollectionResponse: type: array items: description: Company represents any type of organization type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 CompanyGetCollection200Response: type: array items: description: Company represents any type of organization type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 CompanyGetResourceResponse: description: Company represents any type of organization type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 CompanyGetResource200Response: description: Company represents any type of organization type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 ContactGroupGetCollectionResponse: type: array items: description: >- Contact groups represent contacts that are segmented into groups based on specific characteristics type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 ContactGroupGetCollection200Response: type: array items: description: >- Contact groups represent contacts that are segmented into groups based on specific characteristics type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 ContactGroupGetResourceResponse: description: >- Contact groups represent contacts that are segmented into groups based on specific characteristics type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 ContactGroupGetResource200Response: description: >- Contact groups represent contacts that are segmented into groups based on specific characteristics type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 ContractGetCollectionResponse: type: array items: description: '' type: object properties: description: description: additional details about the contract type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 status: description: |- status of the contract e.g: activated, draft type: string nullable: true ContractGetCollection200Response: type: array items: description: '' type: object properties: description: description: additional details about the contract type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 status: description: |- status of the contract e.g: activated, draft type: string nullable: true ContractGetResourceResponse: description: '' type: object properties: description: description: additional details about the contract type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 status: description: |- status of the contract e.g: activated, draft type: string nullable: true ContractGetResource200Response: description: '' type: object properties: description: description: additional details about the contract type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 status: description: |- status of the contract e.g: activated, draft type: string nullable: true ConversionListDocumentsResponse: type: array items: description: '' type: object properties: id: description: identifier readOnly: true 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: description: conversion processing status readOnly: true type: string file: description: name of file type: string ConversionListDocuments200Response: type: array items: description: '' type: object properties: id: description: identifier readOnly: true 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: description: conversion processing status readOnly: true type: string file: description: name of file type: string ConversionDocumentFormatResponse: description: '' type: object properties: id: description: identifier readOnly: true 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: description: conversion processing status readOnly: true type: string file: description: name of file type: string ConversionDocumentFormat201Response: description: '' type: object properties: id: description: identifier readOnly: true 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: description: conversion processing status readOnly: true type: string file: description: name of file type: string ConversionGetResultResponse: description: '' type: object properties: id: description: identifier readOnly: true 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: description: conversion processing status readOnly: true type: string file: description: name of file type: string ConversionGetResult200Response: description: '' type: object properties: id: description: identifier readOnly: true 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: description: conversion processing status readOnly: true type: string file: description: name of file type: string CreditNoteGetCollectionResponse: type: array items: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time CreditNoteGetCollection200Response: type: array items: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time CreditNoteCreateResourceResponse: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time CreditNoteCreateResource201Response: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time CreditNoteGetResourceResponse: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time CreditNoteGetResource200Response: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time CreditNoteReplaceResourceResponse: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time CreditNoteReplaceResource200Response: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: Unique identifier of the source 3rd party integration example: '90300000072369' nullable: true type: string creditnoteNumber: description: >- Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29 example: CN-29 nullable: true type: string date: description: |- The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05" example: '2016-06-05' nullable: true type: string status: description: |- Status of the credit note. This can be open, closed or void eg. "open" example: open nullable: true type: string customerId: description: |- Customer ID of the customer for whom the credit note is raised eg. 903000000000099 example: '903000000000099' nullable: true type: string customerName: description: >- Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture" example: Bowman Furniture nullable: true type: string referenceNumber: description: >- Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384" example: INV-384 nullable: true type: string totalAmount: description: |- Total of credit note eg. "400" example: '400' nullable: true type: string balance: description: |- Unapplied credits eg. 10 example: 10 nullable: true type: integer currency: description: |- Customers currency code eg. "USD" example: USD nullable: true type: string notes: description: |- Notes on the credit notes eg. "Offer for the referral" example: Offer for the referral nullable: true type: string created: description: |- Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time CustomerOpeningBalanceGetCollectionResponse: type: array items: description: '' type: object properties: description: description: A description of the opening balance type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 totalAmount: description: The total amount of the opening balance type: integer nullable: true currency: description: Currency of the account type: string nullable: true CustomerOpeningBalanceGetCollection200Response: type: array items: description: '' type: object properties: description: description: A description of the opening balance type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 totalAmount: description: The total amount of the opening balance type: integer nullable: true currency: description: Currency of the account type: string nullable: true CustomerOpeningBalanceGetResourceResponse: description: '' type: object properties: description: description: A description of the opening balance type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 totalAmount: description: The total amount of the opening balance type: integer nullable: true currency: description: Currency of the account type: string nullable: true CustomerOpeningBalanceGetResource200Response: description: '' type: object properties: description: description: A description of the opening balance type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 totalAmount: description: The total amount of the opening balance type: integer nullable: true currency: description: Currency of the account type: string nullable: true CustomerGetCollectionResponse: type: array items: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string CustomerGetCollection200Response: type: array items: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string CustomerCreateResourceResponse: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string CustomerCreateResource201Response: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string CustomerGetResourceResponse: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string CustomerGetResource200Response: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string CustomerReplaceResourceResponse: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string CustomerReplaceResource200Response: description: '' type: object properties: title: description: |- Job title of the customer e.g. "Manager" example: Manager nullable: true type: string description: description: |- A note about the customer e.g. "Great customer" example: Great customer nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "stripe-5050" example: stripe-5050 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "50" example: '50' nullable: false type: string email: description: |- Email address for the customer e.g. "janedoe@email.com" example: janedoe@email.com nullable: true type: string name: description: |- Full name of the customer e.g. "Jane Doe" example: Jane Doe nullable: true type: string givenName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string familyName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string companyName: description: |- Name of the company the customer is working on e.g. "Acme Corp." example: Acme Corp. nullable: true type: string fullyQualifiedName: description: |- Fully qualified name of the company the customer is working on e.g. "Acme Corporation" example: Acme Corporation nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string addressLine2: description: |- Second line of customer address e.g. "Unit 105" example: Unit 105 nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string billingAddress: description: "Billing address line 1\n\te.g. \"4348 Candlelight Drive\"" example: 4348 Candlelight Drive nullable: true type: string billingAddressLine2: description: "Billing address line 2\n\te.g. \"Apartment 78\"" example: Apartment 78 nullable: true type: string billingCity: description: "Billing address city\n\te.g. \"Panama City\"" example: Panama City nullable: true type: string billingState: description: "Billing address state or province\n\te.g. \"Florida\"" example: Florida nullable: true type: string billingPostalCode: description: "Billing address postal code\n\te.g. \"32417\"" example: '32417' nullable: true type: string billingCountry: description: "Billing address country\n\te.g. \"United States\"" example: United States nullable: true type: string phone: description: "Phone number\n\te.g. \"281-381-4241\"" example: 281-381-4241 nullable: true type: string mobile: description: "Mobile number\n\te.g. \"786-258-0182\"" example: 786-258-0182 nullable: true type: string fax: description: "Fax number\n\te.g. \"281-381-4255\"" example: 281-381-4255 nullable: true type: string ddi: description: "Direct dial number\n\te.g. \"5050\"" example: '5050' nullable: true type: string balance: description: "Balance owed by customer in cents\n\te.g. 19999" example: 19999 nullable: true type: integer currency: description: |- Currency used by customer e.g. "USD" example: USD nullable: true type: string taxable: description: Taxable status example: true nullable: true type: boolean customerAccountStatus: description: |- Accounting status of the customer e.g. "Enabled" example: Enabled nullable: true type: string monthlyRecurringRevenue: description: |- Monthly recurring revenue in cents e.g. 4500000 example: 4500000 nullable: true type: integer netMonthlyRecurringRevenue: description: |- Net monthly recurring revenue e.g. 2500000 example: 2500000 nullable: true type: integer created: description: |- Date of customer account creation e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time modified: description: |- Date entry was last modified e.g. "2013-11-22T02:17:40.080Z" example: '2013-11-22T02:17:40.080Z' nullable: true type: string format: date-time department: description: |- Department where customer works in e.g. "Administrative office" example: Administrative office nullable: true type: string customerOwner: description: |- User in touch with the customer e.g. "josh_jameson" example: josh_jameson nullable: true type: string totalSpent: description: |- Total spent by customer in cents e.g. 76000 example: 76000 nullable: true type: integer acceptsMarketing: description: Whether the customer has consented to receiving promotional emails example: true nullable: true type: boolean username: description: |- Username of the customer e.g. "jane_doe123" example: jane_doe123 nullable: true type: string taxType: description: |- Tax type applied for the customer e.g. "Global" example: Global nullable: true type: string bankAccountName: description: |- Bank account name for the customer e.g. "Business Bank Account" example: Business Bank Account nullable: true type: string bankAccountNumber: description: |- Bank account number for the customer e.g. "123654" example: '123654' nullable: true type: string termId: description: >- Reference to a Term object (payment terms) associated with this Customer e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d" example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string termDays: description: |- The days value of the payment terms for this Customer e.g. "15" example: 15 nullable: true type: integer termType: description: |- The type of the payment terms for this Customer e.g. "DAYSAFTERBILLDATE" example: DAYSAFTERBILLDATE nullable: true type: string DataSyncGetResourceResponse: description: '' type: object properties: message: type: string example: xero synced successfully DataSyncGetResource200Response: description: '' type: object properties: message: type: string example: xero synced successfully DealGetCollectionResponse: type: array items: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer DealGetCollection200Response: type: array items: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer DealCreateResourceResponse: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer DealCreateResource201Response: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer DealGetResourceResponse: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer DealGetResource200Response: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer DealUpdateResourceResponse: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer DealUpdateResource200Response: description: '' type: object properties: description: description: Details about the deal type: string nullable: true id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: User name of deal responsible example: Dave Simpson nullable: true type: string stage: description: |- Deal's stage e.g: decision example: decision nullable: true type: string dealName: description: name of 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: description: |- currency code of the deal e.g: USD example: USD nullable: true type: string created: description: date and time the deal is first created example: '2021-07-28 00:00:00' nullable: true type: string closed: description: date and time the deal is closed example: '2021-07-28 00:00:00' nullable: true 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: description: The number of associated contacts example: 5 nullable: true type: integer DepartmentGetCollectionResponse: type: array items: 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. type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: type: string directory: description: |- List the directory of the current department e.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 DepartmentGetCollection200Response: type: array items: 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. type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: type: string directory: description: |- List the directory of the current department e.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 DepartmentGetResourceResponse: 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. type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: type: string directory: description: |- List the directory of the current department e.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 DepartmentGetResource200Response: 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. type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: type: string directory: description: |- List the directory of the current department e.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 EmployeeGetCollectionResponse: type: array items: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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 EmployeeGetCollection200Response: type: array items: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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 EmployeeCreateResourceResponse: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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 EmployeeCreateResource201Response: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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 EmployeeGetResourceResponse: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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 EmployeeGetResource200Response: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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 EmployeeReplaceResourceResponse: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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 EmployeeReplaceResource200Response: description: Someone working for this organization. type: object properties: title: example: Mr nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string firstName: description: First name of employee example: Steve nullable: true type: string lastName: description: Last name of employee example: James nullable: true 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: description: Link to an external resource of the employee example: steve.james.com nullable: true 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 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 EngagementGetCollectionResponse: type: array items: description: >- Engagement represents CRM actions stored as notes, tasks, meetings and calls type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "MEETING" e.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 EngagementGetCollection200Response: type: array items: description: >- Engagement represents CRM actions stored as notes, tasks, meetings and calls type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "MEETING" e.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 EngagementGetResourceResponse: description: >- Engagement represents CRM actions stored as notes, tasks, meetings and calls type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "MEETING" e.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 EngagementGetResource200Response: description: >- Engagement represents CRM actions stored as notes, tasks, meetings and calls type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "MEETING" e.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 EstimateGetCollectionResponse: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string estimateNumber: description: For searching estimates type: string nullable: true txnStatus: description: |- Transaction status e.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 EstimateGetCollection200Response: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string estimateNumber: description: For searching estimates type: string nullable: true txnStatus: description: |- Transaction status e.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 EstimateGetResourceResponse: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string estimateNumber: description: For searching estimates type: string nullable: true txnStatus: description: |- Transaction status e.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 EstimateGetResource200Response: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string estimateNumber: description: For searching estimates type: string nullable: true txnStatus: description: |- Transaction status e.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 EventGetCollectionResponse: type: array items: description: '' type: object properties: title: description: title of the event type: string nullable: true description: description: details about the event type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: the unique identifier of the source 3rd party integration type: string 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 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 e.g. "SCHEDULED" e.g. "DONE" type: string nullable: true type: description: |- The type of event e.g. "CONTENT" e.g. "SOCIAL" type: string nullable: true url: description: Public url for the event type: string nullable: true EventGetCollection200Response: type: array items: description: '' type: object properties: title: description: title of the event type: string nullable: true description: description: details about the event type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: the unique identifier of the source 3rd party integration type: string 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 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 e.g. "SCHEDULED" e.g. "DONE" type: string nullable: true type: description: |- The type of event e.g. "CONTENT" e.g. "SOCIAL" type: string nullable: true url: description: Public url for the event type: string nullable: true EventGetResourceResponse: description: '' type: object properties: title: description: title of the event type: string nullable: true description: description: details about the event type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: the unique identifier of the source 3rd party integration type: string 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 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 e.g. "SCHEDULED" e.g. "DONE" type: string nullable: true type: description: |- The type of event e.g. "CONTENT" e.g. "SOCIAL" type: string nullable: true url: description: Public url for the event type: string nullable: true EventGetResource200Response: description: '' type: object properties: title: description: title of the event type: string nullable: true description: description: details about the event type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: the unique identifier of the source 3rd party integration type: string 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 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 e.g. "SCHEDULED" e.g. "DONE" type: string nullable: true type: description: |- The type of event e.g. "CONTENT" e.g. "SOCIAL" type: string nullable: true url: description: Public url for the event type: string nullable: true ExecutiveSummaryGetResourceResponse: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string report_id: description: |- Report ID e.g: ExecutiveSummary readOnly: true type: string nullable: true name: description: |- Report Name e.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 ExecutiveSummaryGetResource200Response: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string report_id: description: |- Report ID e.g: ExecutiveSummary readOnly: true type: string nullable: true name: description: |- Report Name e.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 ExecutiveSummaryGetCollectionResponse: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string report_id: description: |- Report ID e.g: ExecutiveSummary readOnly: true type: string nullable: true name: description: |- Report Name e.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 ExecutiveSummaryGetCollection200Response: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string report_id: description: |- Report ID e.g: ExecutiveSummary readOnly: true type: string nullable: true name: description: |- Report Name e.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 ExpenseGetCollectionResponse: type: array items: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean ExpenseGetCollection200Response: type: array items: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean ExpenseCreateResourceResponse: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean ExpenseCreateResource201Response: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean ExpenseGetResponse: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean ExpenseGet200Response: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean ExpenseReplaceResourceResponse: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean ExpenseReplaceResource200Response: description: '' type: object properties: description: description: |- A note, memo, or description for the expense e.g. "GPS rent" example: GPS rent nullable: true type: string id: description: >- Unique identifier for this customer note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "xero-70" example: xero-70 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "982000000030049" example: '982000000030049' nullable: false type: string txnId: description: |- Transaction ID e.g. "9856" example: '9856' nullable: false type: string type: description: |- Type of expense: e.g. "expense" example: expense nullable: false type: string accountId: description: |- ID of account associated with expense e.g. "1057" example: '1057' nullable: false type: string currency: description: |- Currency code e.g. "EUR" example: EUR nullable: true type: string subtotal: description: |- Subtotal of expense in cents e.g. 9000 example: 9000 nullable: true type: integer totalAmount: description: |- Total of expense in cents e.g. 12000 example: 12000 nullable: true type: integer referenceNumber: description: |- Reference number of the expense, max length of 100 e.g. "782364" example: '782364' nullable: true type: string status: description: |- Status of expense e.g. "Unbilled" example: Unbilled nullable: true type: string invoiceId: description: |- ID of the invoice e.g. "460000000028192" example: '460000000028192' nullable: true type: string invoiceNumber: description: |- Invoice number e.g. "INV-00003" example: INV-00003 nullable: true type: string modified: description: |- Time at which the expense details were last updated e.g. "2019-05-25T02:17:40.080Z" example: '2019-05-25T02:17:40.080Z' nullable: true type: string format: date-time accountName: description: |- Expense account name e.g. "Rent" example: Rent nullable: true type: string created: description: |- Time at which the expense details were created e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time accountCode: description: |- Chart of accounts identifier for the account e.g. "4560" example: '4560' nullable: true type: string contactId: description: |- Id of the contact which is usually a payee e.g. "23" example: '23' nullable: true type: string contactName: description: |- Name of the contact which is usually a payee e.g. "Cool Cars" example: Cool Cars nullable: true type: string contactType: description: Type of the contact which can be customer, vendor, or employee example: Vendor nullable: true type: string paymentMethodId: description: Reference to the related Payment Method object example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string date: description: |- Date of the expense e.g. "2019-05-22T02:17:40.080Z" example: '2019-05-22T02:17:40.080Z' nullable: true type: string format: date-time taxAmount: description: |- Total tax amount in cents e.g. 3000 example: 3000 nullable: true type: integer deleted: description: Indicates if the expense has been deleted example: true nullable: false type: boolean FinancialMappingGetCollectionResponse: type: array items: description: Accounting financial mapping type: object properties: id: {} account_id: readOnly: true account_type: readOnly: true period_id: readOnly: true created: {} modified: {} verified: {} accountId: {} accountType: {} periodId: {} FinancialMappingGetCollection200Response: type: array items: description: Accounting financial mapping type: object properties: id: {} account_id: readOnly: true account_type: readOnly: true period_id: readOnly: true created: {} modified: {} verified: {} accountId: {} accountType: {} periodId: {} FinancialMappingGetResourceResponse: description: Accounting financial mapping type: object properties: id: {} account_id: readOnly: true account_type: readOnly: true period_id: readOnly: true created: {} modified: {} verified: {} accountId: {} accountType: {} periodId: {} FinancialMappingGetResource200Response: description: Accounting financial mapping type: object properties: id: {} account_id: readOnly: true account_type: readOnly: true period_id: readOnly: true created: {} modified: {} verified: {} accountId: {} accountType: {} periodId: {} FinancialPeriodGetCollectionResponse: type: array items: description: Accounting financial period type: object properties: id: {} name: {} start: {} integration: {} year_end: readOnly: true deleted: {} created: {} modified: {} yearEnd: {} FinancialPeriodGetCollection200Response: type: array items: description: Accounting financial period type: object properties: id: {} name: {} start: {} integration: {} year_end: readOnly: true deleted: {} created: {} modified: {} yearEnd: {} FinancialPeriodGetResourceResponse: description: Accounting financial period type: object properties: id: {} name: {} start: {} integration: {} year_end: readOnly: true deleted: {} created: {} modified: {} yearEnd: {} FinancialPeriodGetResource200Response: description: Accounting financial period type: object properties: id: {} name: {} start: {} integration: {} year_end: readOnly: true deleted: {} created: {} modified: {} yearEnd: {} FormDataGetJsonDataResponse: description: '' type: object properties: formInput1: type: string example: value formInput2: type: string example: value formInput3: type: string example: value formInput4: type: string example: value FormDataGetJsonData200Response: description: '' type: object properties: formInput1: type: string example: value formInput2: type: string example: value formInput3: type: string example: value formInput4: type: string example: value FormGetCollectionResponse: type: array items: description: >- Forms are standard website forms that can be used to generate website leads. type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 FormGetCollection200Response: type: array items: description: >- Forms are standard website forms that can be used to generate website leads. type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 FormGetResourceResponse: description: >- Forms are standard website forms that can be used to generate website leads. type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 FormGetResource200Response: description: >- Forms are standard website forms that can be used to generate website leads. type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 GrowthHistoryGetCollectionResponse: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 GrowthHistoryGetCollection200Response: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 GrowthHistoryGetResourceResponse: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 GrowthHistoryGetResource200Response: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 IntegrationsListGetListResponse: description: provides a mapped balance sheet type: object properties: file: example: This endpoint returns an connected integrations IntegrationsListGetList200Response: description: provides a mapped balance sheet type: object properties: file: example: This endpoint returns an connected integrations InventoryGetCollectionResponse: type: array items: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} InventoryGetCollection200Response: type: array items: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} InventoryCreateResourceResponse: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} InventoryCreateResource201Response: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} InventoryGetResourceResponse: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} InventoryGetResource200Response: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} InventoryReplaceResourceResponse: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} InventoryReplaceResource200Response: description: '' type: object 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: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string productName: type: string totalQuantity: type: integer fulfillableQuantity: {} InvoiceItemListResourcesResponse: type: array items: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer InvoiceItemListResources200Response: type: array items: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer InvoiceItemCreateResourceResponse: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer InvoiceItemCreateResource201Response: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer InvoiceItemGetResourceResponse: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer InvoiceItemGetResource200Response: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer InvoiceItemReplaceResourceResponse: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer InvoiceItemReplaceResource200Response: description: A line item from an invoice. type: object properties: description: description: Description of the line item example: Bag of soil nullable: true type: string id: description: >- Unique identifier for this line e.g. "quickbooks-34-1" Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34-1 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: >- Unique identifier for the invoice line, from the source 3rd party integration example: '1' nullable: false type: string invoiceId: description: >- The Boss Insights identifier for the invoice that this line belongs to Note that no particular pattern in this field is guaranteed, only that this field is unique example: quickbooks-34 nullable: false type: string quantity: description: Number of items for the line example: 2.25 nullable: true type: number unitPrice: description: Unit price of the item in cents example: 18900 nullable: true type: integer itemId: description: >- Unique identifier for the item, from the source 3rd party integration example: '1002' nullable: true type: string itemName: description: Name of the item example: Bag of soil nullable: true type: string lineAmount: description: Amount for the line item in cents example: 42525 nullable: true type: integer InvoiceGetCollectionResponse: type: array items: description: A statement of the money due for goods or services; a bill. type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-34" example: quickbooks-34 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string additionalType: description: >- An additional type for the item. This is a relationship between something and a class that the thing is in. example: '' nullable: true type: string category: description: >- A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. example: Spare Parts Division nullable: true type: string confirmationNumber: description: >- a number that confirms the given order or payment has been received example: 2798-2929 nullable: true type: string customerId: description: party placing the order or paying the invoice example: '672' nullable: true type: string paymentMethod: description: >- the name of the credit card or other method of payment for the order example: PayPal nullable: true type: string paymentMethodId: description: >- An identifier for the method of payment used (e.g. the last 4 digits of the credit card). example: '3009' nullable: true type: string paymentDueDate: description: The date the payment is due example: '2020-10-22T19:30:17.697Z' nullable: true externalDocs: url: http://schema.org/DateTime type: string format: date-time provider: 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. example: Amazon nullable: true type: string potentialAction: description: >- indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role example: '' nullable: true type: string broker: 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. example: '' nullable: true type: string minimumPaymentDue: description: the minimum payment required at this time example: 2000 nullable: true type: integer accountId: description: the identifier for the account the payment will be applied to example: '127362' nullable: true type: string scheduledPaymentDate: description: the date the invoice is scheduled to be paid example: '2021-10-22T19:30:17.697Z' nullable: true externalDocs: url: http://schema.org/Date type: string format: date-time billingPeriod: description: >- the time interval used to compute the invoice in ISO 8601 duration format example: P0Y2M0DT12H30M5S nullable: true type: string status: description: the status of payment; whether the invoice has been paid or not example: PastDue nullable: true type: string paymentStatus: type: string nullable: true created: description: The date and time the invoice was first created example: '2020-09-07T19:58:50.550Z' nullable: true type: string format: date-time modified: description: The date and time the invoice was last updated example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time subtotal: description: Total payment amount, before tax example: 8750 nullable: true type: integer taxAmount: description: Tax amount example: 1225 nullable: true type: integer currencyCode: description: Currency code example: USD nullable: true type: string invoiceNumber: description: Invoice number example: BP-27719 nullable: true type: string amountPaid: description: Amount paid so far example: 0 nullable: true type: integer amountCredited: description: The amount remaining that is due example: 9975 nullable: true type: integer customerName: description: The customer's name example: Bobs Bait Shop nullable: true type: string customerMemo: example: >- It's a pleasure doing business with you. Remember, referrals are appreciated! nullable: true type: string billingEmail: description: The customer's email example: ben@arima.com nullable: true type: string billingAddressType: example: HOME nullable: true type: string billingAddressLine1: description: |- * @ApiProperty( swaggerContext={"example"="4567 Finch St.", "required"=false}, openapiContext={"example"="4567 Finch St.", "nullable"=true}) 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: description: the unique identifier of the source 3rd party integration example: '129' nullable: false type: string url: description: Invoice url example: https://bobsburger.com nullable: true type: string txnDate: description: Transaction date example: '2020-09-07T19:58:50.550Z' nullable: true type: string format: date-time jsonAddress: description: Billing address in json format example: '{}' nullable: true type: string subscriptionId: description: The ID of the subscription the invoice was prepared for example: '342' nullable: true type: string referenceNumber: description: Reference number of sale order example: B1-7855 nullable: true type: string balance: description: Ending customer balance after the invoice is finalized example: 9975 nullable: true type: integer accountName: description: The name of the business associated with the invoice example: Bills Bait Shop nullable: true type: string purchaseOrderNum: description: Purchase order number example: 342 nullable: true type: integer billingCountry: description: Billing address country example: United States nullable: true type: string totalAmount: description: Total amount of the invoice example: 9975 nullable: true type: integer billingState: description: State the billing address is addressed to example: CA nullable: true type: string shippingCountry: description: Country the shipping address is addressed to example: United States nullable: true type: string shippingState: description: State the shipping address is addressed to example: CA nullable: true type: string amountDue: description: The unpaid amount that is due on the invoice example: 6275 nullable: true type: integer InvoiceGetCollection200Response: type: array items: description: A statement of the money due for goods or services; a bill. type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-34" example: quickbooks-34 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string additionalType: description: >- An additional type for the item. This is a relationship between something and a class that the thing is in. example: '' nullable: true type: string category: description: >- A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. example: Spare Parts Division nullable: true type: string confirmationNumber: description: >- a number that confirms the given order or payment has been received example: 2798-2929 nullable: true type: string customerId: description: party placing the order or paying the invoice example: '672' nullable: true type: string paymentMethod: description: >- the name of the credit card or other method of payment for the order example: PayPal nullable: true type: string paymentMethodId: description: >- An identifier for the method of payment used (e.g. the last 4 digits of the credit card). example: '3009' nullable: true type: string paymentDueDate: description: The date the payment is due example: '2020-10-22T19:30:17.697Z' nullable: true externalDocs: url: http://schema.org/DateTime type: string format: date-time provider: 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. example: Amazon nullable: true type: string potentialAction: description: >- indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role example: '' nullable: true type: string broker: 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. example: '' nullable: true type: string minimumPaymentDue: description: the minimum payment required at this time example: 2000 nullable: true type: integer accountId: description: the identifier for the account the payment will be applied to example: '127362' nullable: true type: string scheduledPaymentDate: description: the date the invoice is scheduled to be paid example: '2021-10-22T19:30:17.697Z' nullable: true externalDocs: url: http://schema.org/Date type: string format: date-time billingPeriod: description: >- the time interval used to compute the invoice in ISO 8601 duration format example: P0Y2M0DT12H30M5S nullable: true type: string status: description: the status of payment; whether the invoice has been paid or not example: PastDue nullable: true type: string paymentStatus: type: string nullable: true created: description: The date and time the invoice was first created example: '2020-09-07T19:58:50.550Z' nullable: true type: string format: date-time modified: description: The date and time the invoice was last updated example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time subtotal: description: Total payment amount, before tax example: 8750 nullable: true type: integer taxAmount: description: Tax amount example: 1225 nullable: true type: integer currencyCode: description: Currency code example: USD nullable: true type: string invoiceNumber: description: Invoice number example: BP-27719 nullable: true type: string amountPaid: description: Amount paid so far example: 0 nullable: true type: integer amountCredited: description: The amount remaining that is due example: 9975 nullable: true type: integer customerName: description: The customer's name example: Bobs Bait Shop nullable: true type: string customerMemo: example: >- It's a pleasure doing business with you. Remember, referrals are appreciated! nullable: true type: string billingEmail: description: The customer's email example: ben@arima.com nullable: true type: string billingAddressType: example: HOME nullable: true type: string billingAddressLine1: description: |- * @ApiProperty( swaggerContext={"example"="4567 Finch St.", "required"=false}, openapiContext={"example"="4567 Finch St.", "nullable"=true}) 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: description: the unique identifier of the source 3rd party integration example: '129' nullable: false type: string url: description: Invoice url example: https://bobsburger.com nullable: true type: string txnDate: description: Transaction date example: '2020-09-07T19:58:50.550Z' nullable: true type: string format: date-time jsonAddress: description: Billing address in json format example: '{}' nullable: true type: string subscriptionId: description: The ID of the subscription the invoice was prepared for example: '342' nullable: true type: string referenceNumber: description: Reference number of sale order example: B1-7855 nullable: true type: string balance: description: Ending customer balance after the invoice is finalized example: 9975 nullable: true type: integer accountName: description: The name of the business associated with the invoice example: Bills Bait Shop nullable: true type: string purchaseOrderNum: description: Purchase order number example: 342 nullable: true type: integer billingCountry: description: Billing address country example: United States nullable: true type: string totalAmount: description: Total amount of the invoice example: 9975 nullable: true type: integer billingState: description: State the billing address is addressed to example: CA nullable: true type: string shippingCountry: description: Country the shipping address is addressed to example: United States nullable: true type: string shippingState: description: State the shipping address is addressed to example: CA nullable: true type: string amountDue: description: The unpaid amount that is due on the invoice example: 6275 nullable: true type: integer InvoiceGetResourceResponse: description: A statement of the money due for goods or services; a bill. type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-34" example: quickbooks-34 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string additionalType: description: >- An additional type for the item. This is a relationship between something and a class that the thing is in. example: '' nullable: true type: string category: description: >- A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. example: Spare Parts Division nullable: true type: string confirmationNumber: description: a number that confirms the given order or payment has been received example: 2798-2929 nullable: true type: string customerId: description: party placing the order or paying the invoice example: '672' nullable: true type: string paymentMethod: description: the name of the credit card or other method of payment for the order example: PayPal nullable: true type: string paymentMethodId: description: >- An identifier for the method of payment used (e.g. the last 4 digits of the credit card). example: '3009' nullable: true type: string paymentDueDate: description: The date the payment is due example: '2020-10-22T19:30:17.697Z' nullable: true externalDocs: url: http://schema.org/DateTime type: string format: date-time provider: 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. example: Amazon nullable: true type: string potentialAction: description: >- indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role example: '' nullable: true type: string broker: 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. example: '' nullable: true type: string minimumPaymentDue: description: the minimum payment required at this time example: 2000 nullable: true type: integer accountId: description: the identifier for the account the payment will be applied to example: '127362' nullable: true type: string scheduledPaymentDate: description: the date the invoice is scheduled to be paid example: '2021-10-22T19:30:17.697Z' nullable: true externalDocs: url: http://schema.org/Date type: string format: date-time billingPeriod: description: >- the time interval used to compute the invoice in ISO 8601 duration format example: P0Y2M0DT12H30M5S nullable: true type: string status: description: the status of payment; whether the invoice has been paid or not example: PastDue nullable: true type: string paymentStatus: type: string nullable: true created: description: The date and time the invoice was first created example: '2020-09-07T19:58:50.550Z' nullable: true type: string format: date-time modified: description: The date and time the invoice was last updated example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time subtotal: description: Total payment amount, before tax example: 8750 nullable: true type: integer taxAmount: description: Tax amount example: 1225 nullable: true type: integer currencyCode: description: Currency code example: USD nullable: true type: string invoiceNumber: description: Invoice number example: BP-27719 nullable: true type: string amountPaid: description: Amount paid so far example: 0 nullable: true type: integer amountCredited: description: The amount remaining that is due example: 9975 nullable: true type: integer customerName: description: The customer's name example: Bobs Bait Shop nullable: true type: string customerMemo: example: >- It's a pleasure doing business with you. Remember, referrals are appreciated! nullable: true type: string billingEmail: description: The customer's email example: ben@arima.com nullable: true type: string billingAddressType: example: HOME nullable: true type: string billingAddressLine1: description: |- * @ApiProperty( swaggerContext={"example"="4567 Finch St.", "required"=false}, openapiContext={"example"="4567 Finch St.", "nullable"=true}) 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: description: the unique identifier of the source 3rd party integration example: '129' nullable: false type: string url: description: Invoice url example: https://bobsburger.com nullable: true type: string txnDate: description: Transaction date example: '2020-09-07T19:58:50.550Z' nullable: true type: string format: date-time jsonAddress: description: Billing address in json format example: '{}' nullable: true type: string subscriptionId: description: The ID of the subscription the invoice was prepared for example: '342' nullable: true type: string referenceNumber: description: Reference number of sale order example: B1-7855 nullable: true type: string balance: description: Ending customer balance after the invoice is finalized example: 9975 nullable: true type: integer accountName: description: The name of the business associated with the invoice example: Bills Bait Shop nullable: true type: string purchaseOrderNum: description: Purchase order number example: 342 nullable: true type: integer billingCountry: description: Billing address country example: United States nullable: true type: string totalAmount: description: Total amount of the invoice example: 9975 nullable: true type: integer billingState: description: State the billing address is addressed to example: CA nullable: true type: string shippingCountry: description: Country the shipping address is addressed to example: United States nullable: true type: string shippingState: description: State the shipping address is addressed to example: CA nullable: true type: string amountDue: description: The unpaid amount that is due on the invoice example: 6275 nullable: true type: integer InvoiceGetResource200Response: description: A statement of the money due for goods or services; a bill. type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-34" example: quickbooks-34 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string additionalType: description: >- An additional type for the item. This is a relationship between something and a class that the thing is in. example: '' nullable: true type: string category: description: >- A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. example: Spare Parts Division nullable: true type: string confirmationNumber: description: a number that confirms the given order or payment has been received example: 2798-2929 nullable: true type: string customerId: description: party placing the order or paying the invoice example: '672' nullable: true type: string paymentMethod: description: the name of the credit card or other method of payment for the order example: PayPal nullable: true type: string paymentMethodId: description: >- An identifier for the method of payment used (e.g. the last 4 digits of the credit card). example: '3009' nullable: true type: string paymentDueDate: description: The date the payment is due example: '2020-10-22T19:30:17.697Z' nullable: true externalDocs: url: http://schema.org/DateTime type: string format: date-time provider: 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. example: Amazon nullable: true type: string potentialAction: description: >- indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role example: '' nullable: true type: string broker: 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. example: '' nullable: true type: string minimumPaymentDue: description: the minimum payment required at this time example: 2000 nullable: true type: integer accountId: description: the identifier for the account the payment will be applied to example: '127362' nullable: true type: string scheduledPaymentDate: description: the date the invoice is scheduled to be paid example: '2021-10-22T19:30:17.697Z' nullable: true externalDocs: url: http://schema.org/Date type: string format: date-time billingPeriod: description: >- the time interval used to compute the invoice in ISO 8601 duration format example: P0Y2M0DT12H30M5S nullable: true type: string status: description: the status of payment; whether the invoice has been paid or not example: PastDue nullable: true type: string paymentStatus: type: string nullable: true created: description: The date and time the invoice was first created example: '2020-09-07T19:58:50.550Z' nullable: true type: string format: date-time modified: description: The date and time the invoice was last updated example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time subtotal: description: Total payment amount, before tax example: 8750 nullable: true type: integer taxAmount: description: Tax amount example: 1225 nullable: true type: integer currencyCode: description: Currency code example: USD nullable: true type: string invoiceNumber: description: Invoice number example: BP-27719 nullable: true type: string amountPaid: description: Amount paid so far example: 0 nullable: true type: integer amountCredited: description: The amount remaining that is due example: 9975 nullable: true type: integer customerName: description: The customer's name example: Bobs Bait Shop nullable: true type: string customerMemo: example: >- It's a pleasure doing business with you. Remember, referrals are appreciated! nullable: true type: string billingEmail: description: The customer's email example: ben@arima.com nullable: true type: string billingAddressType: example: HOME nullable: true type: string billingAddressLine1: description: |- * @ApiProperty( swaggerContext={"example"="4567 Finch St.", "required"=false}, openapiContext={"example"="4567 Finch St.", "nullable"=true}) 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: description: the unique identifier of the source 3rd party integration example: '129' nullable: false type: string url: description: Invoice url example: https://bobsburger.com nullable: true type: string txnDate: description: Transaction date example: '2020-09-07T19:58:50.550Z' nullable: true type: string format: date-time jsonAddress: description: Billing address in json format example: '{}' nullable: true type: string subscriptionId: description: The ID of the subscription the invoice was prepared for example: '342' nullable: true type: string referenceNumber: description: Reference number of sale order example: B1-7855 nullable: true type: string balance: description: Ending customer balance after the invoice is finalized example: 9975 nullable: true type: integer accountName: description: The name of the business associated with the invoice example: Bills Bait Shop nullable: true type: string purchaseOrderNum: description: Purchase order number example: 342 nullable: true type: integer billingCountry: description: Billing address country example: United States nullable: true type: string totalAmount: description: Total amount of the invoice example: 9975 nullable: true type: integer billingState: description: State the billing address is addressed to example: CA nullable: true type: string shippingCountry: description: Country the shipping address is addressed to example: United States nullable: true type: string shippingState: description: State the shipping address is addressed to example: CA nullable: true type: string amountDue: description: The unpaid amount that is due on the invoice example: 6275 nullable: true type: integer ItemGetCollectionResponse: type: array items: description: '' type: object properties: description: description: Description of item type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.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 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 ItemGetCollection200Response: type: array items: description: '' type: object properties: description: description: Description of item type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.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 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 ItemGetResourceResponse: description: '' type: object properties: description: description: Description of item type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.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 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 ItemGetResource200Response: description: '' type: object properties: description: description: Description of item type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.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 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 JournalLineListResourcesResponse: type: array items: description: Journal Lines represent a single line of a larger Journal entity type: object properties: description: description: A description of line item type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "200" e.g. "SALES type: string nullable: true accountType: description: |- Type of account e.g. "BANK" e.g. "CURRENT" e.g. "CURRLIAB" type: string nullable: true accountName: description: Name of account 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 JournalLineListResources200Response: type: array items: description: Journal Lines represent a single line of a larger Journal entity type: object properties: description: description: A description of line item type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "200" e.g. "SALES type: string nullable: true accountType: description: |- Type of account e.g. "BANK" e.g. "CURRENT" e.g. "CURRLIAB" type: string nullable: true accountName: description: Name of account 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 JournalLineGetResourceResponse: description: Journal Lines represent a single line of a larger Journal entity type: object properties: description: description: A description of line item type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "200" e.g. "SALES type: string nullable: true accountType: description: |- Type of account e.g. "BANK" e.g. "CURRENT" e.g. "CURRLIAB" type: string nullable: true accountName: description: Name of account 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 JournalLineGetResource200Response: description: Journal Lines represent a single line of a larger Journal entity type: object properties: description: description: A description of line item type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "200" e.g. "SALES type: string nullable: true accountType: description: |- Type of account e.g. "BANK" e.g. "CURRENT" e.g. "CURRLIAB" type: string nullable: true accountName: description: Name of account 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 JournalGetCollectionResponse: type: array items: description: >- Journal represents recorded transactions and adjustments to the 3rd party account type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 JournalGetCollection200Response: type: array items: description: >- Journal represents recorded transactions and adjustments to the 3rd party account type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 JournalGetResourceResponse: description: >- Journal represents recorded transactions and adjustments to the 3rd party account type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 JournalGetResource200Response: description: >- Journal represents recorded transactions and adjustments to the 3rd party account type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 LeadGetCollectionResponse: type: array items: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LeadGetCollection200Response: type: array items: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LeadCreateResourceResponse: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LeadCreateResource201Response: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LeadGetResourceResponse: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LeadGetResource200Response: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LeadReplaceResourceResponse: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LeadReplaceResource200Response: description: '' type: object properties: id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: '90300000072369' nullable: false type: string email: description: lead email address example: ron.aurthor@gmail.com nullable: true type: string firstName: description: lead first name example: Ronald nullable: true type: string lastName: description: lead last anme example: Aurthor nullable: true type: string primaryPhone: description: lead phone number example: 416-555-0126 nullable: true type: string addressLine1: description: line1 address of the lead example: 39 Parliment road nullable: true type: string city: description: city address of the lead example: Detroit nullable: true type: string country: description: country address of the lead example: United States nullable: true type: string company: description: company where lead is working on example: Ronalds Hot Rods nullable: true type: string postalCode: description: postal code of the lead example: '48653' nullable: true type: string website: description: website of the lead example: https://www.ronshotrods.com nullable: true type: string industry: description: the industry lead belongs to example: Automotive nullable: true type: string skypeUsername: description: skype username of the lead example: ronaldAurthor0127 nullable: true type: string twitter: description: twitter account of the lead example: '@ronaldAutomotive' nullable: true type: string annualRevenue: description: annual revenue of the company lead is working example: '50000000' nullable: true type: string employeeCount: description: number of employees in the company lead works in example: 113 nullable: true type: integer created: description: date and time lead's information is first created example: '2021-07-28 00:00:00' nullable: true type: string format: date-time modified: description: date and time lead's information is last updated example: '2021-09-15 00:00:00' nullable: true type: string format: date-time LedgerAccountOpeningBalanceGetCollectionResponse: type: array items: description: '' type: object properties: description: description: A description of the opening balance type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 LedgerAccountOpeningBalanceGetCollection200Response: type: array items: description: '' type: object properties: description: description: A description of the opening balance type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 LedgerAccountOpeningBalanceGetResourceResponse: description: '' type: object properties: description: description: A description of the opening balance type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 LedgerAccountOpeningBalanceGetResource200Response: description: '' type: object properties: description: description: A description of the opening balance type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 LedgerAccountTypeListOfResourcesResponse: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 LedgerAccountTypeListOfResources200Response: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 LedgerAccountTypeGetResourceResponse: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 LedgerAccountTypeGetResource200Response: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 LedgerAccountsGetCollectionResponse: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: Is ledger account debit or credit readOnly: true 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 LedgerAccountsGetCollection200Response: type: array items: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: Is ledger account debit or credit readOnly: true 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 LedgerAccountsGetResourceResponse: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: Is ledger account debit or credit readOnly: true 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 LedgerAccountsGetResource200Response: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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: description: Is ledger account debit or credit readOnly: true 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 LedgerEntryGetCollectionResponse: type: array items: description: '' type: object properties: description: description: Description of the ledger entry type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 ledgerAccount: description: Ledger account id type: string nullable: true LedgerEntryGetCollection200Response: type: array items: description: '' type: object properties: description: description: Description of the ledger entry type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 ledgerAccount: description: Ledger account id type: string nullable: true LedgerEntryGetResourceResponse: description: '' type: object properties: description: description: Description of the ledger entry type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 ledgerAccount: description: Ledger account id type: string nullable: true LedgerEntryGetResource200Response: description: '' type: object properties: description: description: Description of the ledger entry type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 ledgerAccount: description: Ledger account id type: string nullable: true LinkedTransactionListResourcesResponse: type: array items: description: >- Linked transaction represent transactions that form part of a single scheme, arrangement or series of transactions between the same vendor and customer type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.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 e.g. "ACCPAY" e.g. "SPEND" type: string nullable: true LinkedTransactionListResources200Response: type: array items: description: >- Linked transaction represent transactions that form part of a single scheme, arrangement or series of transactions between the same vendor and customer type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.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 e.g. "ACCPAY" e.g. "SPEND" type: string nullable: true LinkedTransactionGetResourceResponse: description: >- Linked transaction represent transactions that form part of a single scheme, arrangement or series of transactions between the same vendor and customer type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.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 e.g. "ACCPAY" e.g. "SPEND" type: string nullable: true LinkedTransactionGetResource200Response: description: >- Linked transaction represent transactions that form part of a single scheme, arrangement or series of transactions between the same vendor and customer type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.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 e.g. "ACCPAY" e.g. "SPEND" type: string nullable: true LocationGetCollectionResponse: type: array items: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string LocationGetCollection200Response: type: array items: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string LocationCreateResourceResponse: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string LocationCreateResource201Response: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string LocationGetResourceResponse: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string LocationGetResource200Response: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string LocationReplaceResourceResponse: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string LocationReplaceResource200Response: description: '' type: object properties: id: description: >- unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y" example: quickbooks-34 nullable: false type: string integration: description: |- The key of the integration source e.g. "square"" example: square nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration type: string created: description: |- Date entry was created e.g. "2013-11-18T02:17:40.080Z" example: '2013-11-18T02:17:40.080Z' nullable: true type: string format: date-time businessName: description: |- Name of the business e.g. "Bowman and Co" example: Bowman and Co nullable: true type: string currency: description: |- Currency code e.g. "USD" example: USD nullable: true type: string type: description: |- Type of the Sales term e.g. STANDARD type: string nullable: true country: description: "Country of the address\n\t * e.g. \"United States\"" example: United States nullable: true type: string city: description: |- City of the address e.g. "St Paul" example: St Paul nullable: true type: string state: description: |- Vendor state address e.g. "Alaska" example: Alaska nullable: true type: string postalCode: description: "Postal code of the address\n\t * e.g. \"99660\"" example: '99660' nullable: true type: string address: description: |- First line of customer address e.g. "708 Woodland Avenue" example: 708 Woodland Avenue nullable: true type: string ManualJournalGetCollectionResponse: type: array items: description: Manual journal represents manually logged transactions type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "Inclusive" e.g. "Exclusive", e.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 e.g. "OUTPUT" e.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 ManualJournalGetCollection200Response: type: array items: description: Manual journal represents manually logged transactions type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "Inclusive" e.g. "Exclusive", e.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 e.g. "OUTPUT" e.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 ManualJournalGetResourceResponse: description: Manual journal represents manually logged transactions type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "Inclusive" e.g. "Exclusive", e.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 e.g. "OUTPUT" e.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 ManualJournalGetResource200Response: description: Manual journal represents manually logged transactions type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "Inclusive" e.g. "Exclusive", e.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 e.g. "OUTPUT" e.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 MetricsGetSetResponse: description: provides a set of business metrics type: object 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: description: '' 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: '' current_ratio: description: '' 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: '' 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 MetricsGetSet200Response: description: provides a set of business metrics type: object 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: description: '' 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: '' current_ratio: description: '' 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: '' 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 OrderReturnListResourcesResponse: type: array items: description: >- Order return represents the full or partial return of a number of order items type: object properties: description: description: A description of the order return type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 OrderReturnListResources200Response: type: array items: description: >- Order return represents the full or partial return of a number of order items type: object properties: description: description: A description of the order return type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 OrderReturnGetResourceResponse: description: >- Order return represents the full or partial return of a number of order items type: object properties: description: description: A description of the order return type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 OrderReturnGetResource200Response: description: >- Order return represents the full or partial return of a number of order items type: object properties: description: description: A description of the order return type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 OrderGetCollectionResponse: type: array items: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string OrderGetCollection200Response: type: array items: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string OrderCreateResourceResponse: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string OrderCreateResource201Response: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string OrderGetResourceResponse: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string OrderGetResource200Response: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string OrderReplaceResourceResponse: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string OrderReplaceResource200Response: description: >- Order represents customer purchases made on defined products in the system type: object properties: description: description: |- Additional details about the order e.g. "Monthly bundle" example: Monthly bundle nullable: true type: string id: description: >- Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcID: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string name: description: |- Order name e.g. "New order" example: New order nullable: true type: string orderDate: description: |- Date and time the order is created e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time orderStatus: description: |- Status of the order e.g. "activated" example: activated nullable: true type: string amount: description: |- Amount of the order e.g. "1200" example: '1200' nullable: true type: string quantity: description: |- The number of items included in the order e.g. 5 example: 5 nullable: true type: integer modified: description: |- When the order was last modified e.g. "2019-08-25T02:17:40.080Z" example: '2019-08-25T02:17:40.080Z' nullable: true type: string format: date-time customerId: description: |- Id of the customer the order is by e.g. "C005" example: C005 nullable: true type: string firstName: description: |- First name of the customer e.g. "Jane" example: Jane nullable: true type: string lastName: description: |- Last name of the customer e.g. "Doe" example: Doe nullable: true type: string currency: description: |- The currency the order was made in e.g. "USD" example: USD nullable: true type: string OrganizationGetCollectionResponse: type: array items: description: '' type: object properties: description: description: Further details about the company example: Best burgers in the world nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: description: Company name example: Bobs Sandwiches nullable: false type: string legalName: description: legal name example: Bobs Sandwiches nullable: true type: string primaryPhone: description: Primary phone number of the company example: '4165769834' nullable: true type: string email: description: Primary email address associated to the company example: bobs.sandwiches@gmail.com nullable: true type: string addressLine1: description: Line1 address of the company example: 23 berkly street nullable: true type: string addressLine2: example: 45 portland road nullable: true type: string city: example: Toronto nullable: true type: string country: description: Country of the company location example: Canada nullable: true type: string postalCode: description: Postalcode of the company location example: H7F5R3 nullable: true 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: description: |- Type of the organization e.g: charity e.g: not_for_profit e.g: partnership example: charity nullable: true type: string employeeCount: description: Number of employees in the company example: 75 nullable: true type: integer website: description: Website address of the comapny example: bobssandwiches.com nullable: true type: string annualRevenue: example: '45000000000' nullable: true type: string industry: description: |- The industry company belongs to e.g: banking example: hospitality nullable: true type: string locationCount: description: Number of locations company has example: 4 nullable: true type: integer industryCode: description: NAICS/SIC industry code for the company example: '441221' nullable: true type: string organisationType: type: string nullable: true OrganizationGetCollection200Response: type: array items: description: '' type: object properties: description: description: Further details about the company example: Best burgers in the world nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: description: Company name example: Bobs Sandwiches nullable: false type: string legalName: description: legal name example: Bobs Sandwiches nullable: true type: string primaryPhone: description: Primary phone number of the company example: '4165769834' nullable: true type: string email: description: Primary email address associated to the company example: bobs.sandwiches@gmail.com nullable: true type: string addressLine1: description: Line1 address of the company example: 23 berkly street nullable: true type: string addressLine2: example: 45 portland road nullable: true type: string city: example: Toronto nullable: true type: string country: description: Country of the company location example: Canada nullable: true type: string postalCode: description: Postalcode of the company location example: H7F5R3 nullable: true 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: description: |- Type of the organization e.g: charity e.g: not_for_profit e.g: partnership example: charity nullable: true type: string employeeCount: description: Number of employees in the company example: 75 nullable: true type: integer website: description: Website address of the comapny example: bobssandwiches.com nullable: true type: string annualRevenue: example: '45000000000' nullable: true type: string industry: description: |- The industry company belongs to e.g: banking example: hospitality nullable: true type: string locationCount: description: Number of locations company has example: 4 nullable: true type: integer industryCode: description: NAICS/SIC industry code for the company example: '441221' nullable: true type: string organisationType: type: string nullable: true OrganizationGetResourceResponse: description: '' type: object properties: description: description: Further details about the company example: Best burgers in the world nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: description: Company name example: Bobs Sandwiches nullable: false type: string legalName: description: legal name example: Bobs Sandwiches nullable: true type: string primaryPhone: description: Primary phone number of the company example: '4165769834' nullable: true type: string email: description: Primary email address associated to the company example: bobs.sandwiches@gmail.com nullable: true type: string addressLine1: description: Line1 address of the company example: 23 berkly street nullable: true type: string addressLine2: example: 45 portland road nullable: true type: string city: example: Toronto nullable: true type: string country: description: Country of the company location example: Canada nullable: true type: string postalCode: description: Postalcode of the company location example: H7F5R3 nullable: true 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: description: |- Type of the organization e.g: charity e.g: not_for_profit e.g: partnership example: charity nullable: true type: string employeeCount: description: Number of employees in the company example: 75 nullable: true type: integer website: description: Website address of the comapny example: bobssandwiches.com nullable: true type: string annualRevenue: example: '45000000000' nullable: true type: string industry: description: |- The industry company belongs to e.g: banking example: hospitality nullable: true type: string locationCount: description: Number of locations company has example: 4 nullable: true type: integer industryCode: description: NAICS/SIC industry code for the company example: '441221' nullable: true type: string organisationType: type: string nullable: true OrganizationGetResource200Response: description: '' type: object properties: description: description: Further details about the company example: Best burgers in the world nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string name: description: Company name example: Bobs Sandwiches nullable: false type: string legalName: description: legal name example: Bobs Sandwiches nullable: true type: string primaryPhone: description: Primary phone number of the company example: '4165769834' nullable: true type: string email: description: Primary email address associated to the company example: bobs.sandwiches@gmail.com nullable: true type: string addressLine1: description: Line1 address of the company example: 23 berkly street nullable: true type: string addressLine2: example: 45 portland road nullable: true type: string city: example: Toronto nullable: true type: string country: description: Country of the company location example: Canada nullable: true type: string postalCode: description: Postalcode of the company location example: H7F5R3 nullable: true 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: description: |- Type of the organization e.g: charity e.g: not_for_profit e.g: partnership example: charity nullable: true type: string employeeCount: description: Number of employees in the company example: 75 nullable: true type: integer website: description: Website address of the comapny example: bobssandwiches.com nullable: true type: string annualRevenue: example: '45000000000' nullable: true type: string industry: description: |- The industry company belongs to e.g: banking example: hospitality nullable: true type: string locationCount: description: Number of locations company has example: 4 nullable: true type: integer industryCode: description: NAICS/SIC industry code for the company example: '441221' nullable: true type: string organisationType: type: string nullable: true OtherIncomeGetCollectionResponse: type: array items: description: '' type: object properties: description: type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: type: string totalAmount: type: integer currencyCode: type: string category: type: string nullable: true dateReceived: type: string format: date-time nullable: true paymentType: type: string nullable: true source: type: string created: type: string format: date-time modified: type: string format: date-time OtherIncomeGetCollection200Response: type: array items: description: '' type: object properties: description: type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: type: string totalAmount: type: integer currencyCode: type: string category: type: string nullable: true dateReceived: type: string format: date-time nullable: true paymentType: type: string nullable: true source: type: string created: type: string format: date-time modified: type: string format: date-time OtherIncomeGetResourceResponse: description: '' type: object properties: description: type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: type: string totalAmount: type: integer currencyCode: type: string category: type: string nullable: true dateReceived: type: string format: date-time nullable: true paymentType: type: string nullable: true source: type: string created: type: string format: date-time modified: type: string format: date-time OtherIncomeGetResource200Response: description: '' type: object properties: description: type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: type: string totalAmount: type: integer currencyCode: type: string category: type: string nullable: true dateReceived: type: string format: date-time nullable: true paymentType: type: string nullable: true source: type: string created: type: string format: date-time modified: type: string format: date-time OwnerGetCollectionResponse: type: array items: description: >- Owner represents accounts in the system that are able to view and edit customer information. type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 OwnerGetCollection200Response: type: array items: description: >- Owner represents accounts in the system that are able to view and edit customer information. type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 OwnerGetResourceResponse: description: >- Owner represents accounts in the system that are able to view and edit customer information. type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 OwnerGetResource200Response: description: >- Owner represents accounts in the system that are able to view and edit customer information. type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 PaymentIntentGetCollectionResponse: type: array items: description: >- Payment intent captures the process of collecting a payment from customers type: object properties: description: description: A description about the payment intent type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 e.g. "requires_payment_method" e.g. "requires_confirmation" e.g. "succeeded" type: string nullable: true PaymentIntentGetCollection200Response: type: array items: description: >- Payment intent captures the process of collecting a payment from customers type: object properties: description: description: A description about the payment intent type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 e.g. "requires_payment_method" e.g. "requires_confirmation" e.g. "succeeded" type: string nullable: true PaymentIntentGetResourceResponse: description: >- Payment intent captures the process of collecting a payment from customers type: object properties: description: description: A description about the payment intent type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 e.g. "requires_payment_method" e.g. "requires_confirmation" e.g. "succeeded" type: string nullable: true PaymentIntentGetResource200Response: description: >- Payment intent captures the process of collecting a payment from customers type: object properties: description: description: A description about the payment intent type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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 e.g. "requires_payment_method" e.g. "requires_confirmation" e.g. "succeeded" type: string nullable: true PaymentMethodGetCollectionResponse: type: array items: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentMethodGetCollection200Response: type: array items: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentMethodCreateResourceResponse: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentMethodCreateResource201Response: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentMethodGetResourceResponse: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentMethodGetResource200Response: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentMethodReplaceResourceResponse: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentMethodReplaceResource200Response: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string name: description: Name for the payment method example: Diners Club nullable: true type: string type: description: Type of the payment method example: CREDIT_CARD nullable: true type: string created: description: Date the payment method was created example: '2021-10-22 19:30:17' nullable: true type: string format: date-time modified: description: Date the payment method was last modified example: '2021-10-22 19:30:17' nullable: true type: string format: date-time PaymentServiceGetCollectionResponse: type: array items: description: >- Payment service represents services used that allow for online payments type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "AwesomePay" e.g. "CUSTOM type: string nullable: true PaymentServiceGetCollection200Response: type: array items: description: >- Payment service represents services used that allow for online payments type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "AwesomePay" e.g. "CUSTOM type: string nullable: true PaymentServiceGetResourceResponse: description: Payment service represents services used that allow for online payments type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "AwesomePay" e.g. "CUSTOM type: string nullable: true PaymentServiceGetResource200Response: description: Payment service represents services used that allow for online payments type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 e.g. "AwesomePay" e.g. "CUSTOM type: string nullable: true PaymentGetCollectionResponse: type: array items: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PaymentGetCollection200Response: type: array items: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PaymentCreateResourceResponse: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PaymentCreateResource201Response: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PaymentGetResourceResponse: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PaymentGetResource200Response: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PaymentReplaceResourceResponse: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PaymentReplaceResource200Response: description: '' type: object properties: id: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: The unique identifier of the source 3rd party integration example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: false type: string paymentDate: description: Date of the payment example: '2020-10-22T19:30:17.697Z' nullable: false type: string format: date-time totalAmount: description: Total amount listed in the payment in cents example: '8750' nullable: true type: string status: description: |- Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED example: PAID nullable: true type: string modified: description: Date entry was last modified example: '2020-10-09T14:52:50.550Z' nullable: true type: string format: date-time accountId: description: Account Id the payment was made from example: 562555f2-8cde-4ce9-8203-0363922537a4 nullable: true type: string customerId: description: Customer Id example: 1d80716b-427e-4cad-80c6-c4b3a18eb23d nullable: true type: string customerName: description: Customer name example: Gateway Motors nullable: true type: string linkedTxnId: description: Transaction Id example: 361a4980-7f53-4b68-820c-f6487f613284 nullable: true type: string linkedTxnType: description: |- Transaction type e.g. Deposit, Invoice example: Deposit nullable: true type: string created: description: Date entry was created example: '2021-10-22T19:30:17.697Z' nullable: true type: string format: date-time invoiceId: description: Invoice Id example: '129' nullable: true type: string currencyCode: description: Currency code example: USD nullable: true type: string paymentType: description: |- Payment type e.g. CreditCard example: PayPal nullable: true type: string PayoutGetCollectionResponse: type: array items: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: >- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string PayoutGetCollection200Response: type: array items: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: >- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string PayoutCreateResourceResponse: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: |- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string PayoutCreateResource201Response: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: |- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string PayoutGetResourceResponse: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: |- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string PayoutGetResource200Response: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: |- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string PayoutReplaceResourceResponse: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: |- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string PayoutReplaceResource200Response: description: >- Payout represents received funds made out to a bank account or debit card type: object properties: id: description: >- Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726" example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: description: |- The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S" example: GH2JK-67283H-YW82KHX-2883KK-KS78S nullable: false type: string amount: description: >- The amount to be transferred to a bank account or debit card in cents e.g. 74753 example: 74753 nullable: false type: integer arrivalDate: description: |- The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z" example: '2020-11-03T02:17:40.080Z' nullable: true type: string automatic: description: >- Whether the payout was created by an automated payout schedule or not e.g. "true" example: 'true' nullable: true type: string balanceTransactionId: description: >- The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464" example: '7464' nullable: true type: string created: description: |- The date and time this payout was created e.g. "2020-11-03" example: '2020-11-03' nullable: true type: string currency: description: |- Currency the payout is made in e.g. "USD" example: USD nullable: true type: string payoutDescription: description: |- A description of the payout e.g. "Payout description" example: Payout description nullable: true type: string destinationId: description: |- The ID of the bank account or card the payout is sent to e.g. "44" example: '44' nullable: true type: string failureBalanceTransactionId: description: |- The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77" example: py_1L9D8G2eZgTElo2CaKQjce77 nullable: true type: string failureCode: description: Error code explaining reason for payout failure. example: error 43 nullable: true type: string failureMessage: description: |- Message to user further explaining reason for payout failure e.g. "payment failed" example: payment failed nullable: true type: string method: description: |- Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard" example: Standard nullable: true type: string sourceType: description: |- The source balance this payout came from e.g. "card" e.g. "bank_account" example: card nullable: true type: string status: description: |- Current status of the payout e.g. "paid" e.g. "pending" example: pending nullable: true type: string payoutType: description: |- Type of payout e.g. "bank_account" e.g. "card" example: card nullable: true type: string PayrollGetCollectionResponse: type: array items: description: '' type: object properties: description: example: '' nullable: true 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 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 PayrollGetCollection200Response: type: array items: description: '' type: object properties: description: example: '' nullable: true 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 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 PlanGetCollectionResponse: type: array items: description: >- Plan represents the base price, currency and billing cycle for subscriptions type: object properties: description: description: plan description example: Monthly streaming subscription nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: true type: string isActive: example: true nullable: true type: boolean aggregateUsage: description: |- A usage aggregation strategy for metered usage plans e.g. "sum" e.g. "last_during_period" e.g. "max" example: sum nullable: true type: string amount: description: price of the plan example: 200 nullable: true type: integer billingScheme: description: |- Describes how to compute the price per period e.g. "per_unit" e.g. "tiered" example: per_unit nullable: true 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 productId: description: id for the plan example: '2' nullable: true type: string tiersMode: description: |- Defines if the tier pricing should be graduated or volume e.g. "graduated" e.g. "volume" example: volume nullable: true type: string transformUsage: description: Division transformation applied to the reported usage type: integer nullable: true usageType: description: |- Configures how the quantity per period should be determined e.g. "metered" e.g. "licensed" example: metered nullable: true type: string intervalCount: type: integer nullable: true trialPeriodDays: type: integer nullable: true PlanGetCollection200Response: type: array items: description: >- Plan represents the base price, currency and billing cycle for subscriptions type: object properties: description: description: plan description example: Monthly streaming subscription nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: true type: string isActive: example: true nullable: true type: boolean aggregateUsage: description: |- A usage aggregation strategy for metered usage plans e.g. "sum" e.g. "last_during_period" e.g. "max" example: sum nullable: true type: string amount: description: price of the plan example: 200 nullable: true type: integer billingScheme: description: |- Describes how to compute the price per period e.g. "per_unit" e.g. "tiered" example: per_unit nullable: true 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 productId: description: id for the plan example: '2' nullable: true type: string tiersMode: description: |- Defines if the tier pricing should be graduated or volume e.g. "graduated" e.g. "volume" example: volume nullable: true type: string transformUsage: description: Division transformation applied to the reported usage type: integer nullable: true usageType: description: |- Configures how the quantity per period should be determined e.g. "metered" e.g. "licensed" example: metered nullable: true type: string intervalCount: type: integer nullable: true trialPeriodDays: type: integer nullable: true PlanGetResourceResponse: description: >- Plan represents the base price, currency and billing cycle for subscriptions type: object properties: description: description: plan description example: Monthly streaming subscription nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: true type: string isActive: example: true nullable: true type: boolean aggregateUsage: description: |- A usage aggregation strategy for metered usage plans e.g. "sum" e.g. "last_during_period" e.g. "max" example: sum nullable: true type: string amount: description: price of the plan example: 200 nullable: true type: integer billingScheme: description: |- Describes how to compute the price per period e.g. "per_unit" e.g. "tiered" example: per_unit nullable: true 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 productId: description: id for the plan example: '2' nullable: true type: string tiersMode: description: |- Defines if the tier pricing should be graduated or volume e.g. "graduated" e.g. "volume" example: volume nullable: true type: string transformUsage: description: Division transformation applied to the reported usage type: integer nullable: true usageType: description: |- Configures how the quantity per period should be determined e.g. "metered" e.g. "licensed" example: metered nullable: true type: string intervalCount: type: integer nullable: true trialPeriodDays: type: integer nullable: true PlanGetResource200Response: description: >- Plan represents the base price, currency and billing cycle for subscriptions type: object properties: description: description: plan description example: Monthly streaming subscription nullable: true type: string id: example: quickbooks-726 nullable: false readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string srcId: example: 706f68c5-46b2-43d8-9aa8-41d1cc2a317f nullable: true type: string isActive: example: true nullable: true type: boolean aggregateUsage: description: |- A usage aggregation strategy for metered usage plans e.g. "sum" e.g. "last_during_period" e.g. "max" example: sum nullable: true type: string amount: description: price of the plan example: 200 nullable: true type: integer billingScheme: description: |- Describes how to compute the price per period e.g. "per_unit" e.g. "tiered" example: per_unit nullable: true 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 productId: description: id for the plan example: '2' nullable: true type: string tiersMode: description: |- Defines if the tier pricing should be graduated or volume e.g. "graduated" e.g. "volume" example: volume nullable: true type: string transformUsage: description: Division transformation applied to the reported usage type: integer nullable: true usageType: description: |- Configures how the quantity per period should be determined e.g. "metered" e.g. "licensed" example: metered nullable: true type: string intervalCount: type: integer nullable: true trialPeriodDays: type: integer nullable: true ProductGetCollectionResponse: type: array items: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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 ProductGetCollection200Response: type: array items: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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 ProductCreateResourceResponse: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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 ProductCreateResource201Response: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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 ProductGetResourceResponse: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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 ProductGetResource200Response: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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 ProductReplaceResourceResponse: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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 ProductReplaceResource200Response: 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. type: object properties: description: description: a description of the item externalDocs: url: http://schema.org/description type: string nullable: true id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false 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 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\](https://api.bossinsights.com/) 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 ProfitAndLossGetResourceResponse: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string reportTitle: description: 'e.g: ProfitAndLoss' example: Profit and Loss Statement nullable: true type: string companyName: description: 'e.g: the company legal name' example: Flux Capacitors Inc nullable: true 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: description: >- accounting method: a set of rules under which revenues and expenses are reported in financial statements e.g: cash example: cash nullable: true 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: description: Total income in cents example: 786532 nullable: true type: integer totalExpenses: description: Total expenses in cents example: 756282 nullable: true type: integer ProfitAndLossGetResource200Response: description: '' type: object properties: id: readOnly: true type: string integration: description: |- The key of the integration source e.g. "quickbooks", or "xero" example: quickbooks nullable: false type: string reportTitle: description: 'e.g: ProfitAndLoss' example: Profit and Loss Statement nullable: true type: string companyName: description: 'e.g: the company legal name' example: Flux Capacitors Inc nullable: true 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: description: >- accounting method: a set of rules under which revenues and expenses are reported in financial statements e.g: cash example: cash nullable: true 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: description: Total income in cents example: 786532 nullable: true type: integer totalExpenses: description: Total expenses in cents example: 756282 nullable: true type: integer ProfitAndLossExcelGetWorkbookResponse: description: provides an excel workbook of a series of mapped profit and loss reports type: object properties: file: example: This endpoint returns an .xlsx file. ProfitAndLossExcelGetWorkbook200Response: description: provides an excel workbook of a series of mapped profit and loss reports type: object properties: file: example: This endpoint returns an .xlsx file. ProfitAndLossReportGetMappedReportResponse: description: provides a mapped profit and loss report type: object 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

Total Income: 148440.00

EXPENSES
Advertising: 500.00
Repair and maintenance: 8000.00

Total Expenses: 8500.00

PROFIT: 139940.00