From 77c0af8d298df227a7f98414ebf22c00fe8c1b91 Mon Sep 17 00:00:00 2001 From: Vignesh Kennadi Date: Thu, 12 Sep 2024 17:39:17 +0530 Subject: [PATCH] Removed Quotes in Examples for accounting.yml --- xero_accounting.yaml | 1164 +++++++++++++++++++++--------------------- 1 file changed, 586 insertions(+), 578 deletions(-) diff --git a/xero_accounting.yaml b/xero_accounting.yaml index 2a4b80398..205704e18 100644 --- a/xero_accounting.yaml +++ b/xero_accounting.yaml @@ -47,7 +47,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Accounts' - example: '{ + example: { "Accounts": [{ "AccountID": "ebd06280-af70-4bed-97c6-7451a454ad85", "Code": "091", @@ -67,7 +67,7 @@ paths: "Description": "Income from any normal business activity", "EnablePaymentsToAccount": false }] - }' + } put: security: - OAuth2: [accounting.settings] @@ -118,7 +118,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Accounts' - example: '{ + example: { "Id": "11814c9d-3b5e-492e-93b0-fad16bf3244f", "Status": "OK", "ProviderName": "Xero API Partner", @@ -140,14 +140,14 @@ paths: "UpdatedDateUTC": "\/Date(1550793549320+0000)\/" } ] - }' + } '400': description: Validation Error - some data was incorrect returns response of type Error content: application/json: schema: $ref: '#/components/schemas/Error' - example: '{ + example: { "ErrorNumber": 10, "Type": "ValidationException", "Message": "A validation exception occurred", @@ -165,7 +165,7 @@ paths: ] } ] - }' + } requestBody: required: true description: Account object in body of request @@ -173,12 +173,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Account' - example: '{ + example: { "Code":"123456", "Name":"Foobar", "Type":"EXPENSE", "Description":"Hello World" - }' + } '/Accounts/{AccountID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -198,7 +198,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Accounts' - example: '{ + example: { "Id": "323455cc-9511-4451-a873-248d2983f38e", "Status": "OK", "ProviderName": "Xero API Partner", @@ -220,7 +220,7 @@ paths: "UpdatedDateUTC": "\/Date(1550797359120+0000)\/" } ] - }' + } post: security: - OAuth2: [accounting.settings] @@ -290,7 +290,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Accounts' - example: '{ + example: { "Id": "9012e75c-ec08-40a9-ae15-153fc1f35c4d", "Status": "OK", "ProviderName": "Xero API Partner", @@ -312,14 +312,14 @@ paths: "UpdatedDateUTC": "\/Date(1550795389333+0000)\/" } ] - }' + } '400': description: Validation Error - some data was incorrect returns response of type Error content: application/json: schema: $ref: '#/components/schemas/Error' - example: '{ + example: { "ErrorNumber": 10, "Type": "ValidationException", "Message": "A validation exception occurred", @@ -337,7 +337,7 @@ paths: ] } ] - }' + } requestBody: required: true description: Request of type Accounts array with one Account @@ -345,7 +345,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Accounts' - example: '{ + example: { "Accounts":[ { "Code":"123456", @@ -362,7 +362,7 @@ paths: "UpdatedDateUTC":"2019-02-21T16:29:47.96-08:00" } ] - }' + } delete: security: - OAuth2: [accounting.settings] @@ -380,7 +380,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Accounts' - example: '{ + example: { "Id": "76bb0543-8efe-4acc-b7f6-67dfcdec37b4", "Status": "OK", "ProviderName": "Xero API Partner", @@ -402,14 +402,14 @@ paths: "UpdatedDateUTC": "\/Date(1550798217210+0000)\/" } ] - }' + } '400': description: Validation Error - some data was incorrect returns response of type Error content: application/json: schema: $ref: '#/components/schemas/Error' - example: '{ + example: { "ErrorNumber": 10, "Type": "ValidationException", "Message": "A validation exception occurred", @@ -427,7 +427,7 @@ paths: ] } ] - }' + } '/Accounts/{AccountID}/Attachments': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -448,7 +448,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "439c1573-3cd8-4697-a9f6-81fa651ee8f3", "Status": "OK", "ProviderName": "Xero API Partner", @@ -462,7 +462,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '/Accounts/{AccountID}/Attachments/{AttachmentID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -527,7 +527,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "c8d6413a-1da2-4faa-9848-21f60443e906", "Status": "OK", "ProviderName": "Xero API Partner", @@ -541,7 +541,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': description: Validation Error - some data was incorrect returns response of type Error content: @@ -576,7 +576,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "724cdff5-bcd1-4c5c-977e-e864c24258e0", "Status": "OK", "ProviderName": "Xero API Partner", @@ -590,7 +590,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -637,7 +637,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BatchPayments' - example: '{ + example: { "Id": "6ab84949-4fe5-4788-a135-4d8f690d24d7", "Status": "OK", "ProviderName": "Xero API Partner", @@ -730,7 +730,7 @@ paths: "IsReconciled": false } ] - }' + } put: security: - OAuth2: [accounting.transactions] @@ -899,7 +899,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BatchPayments' - example: '{ + example: { "Id": "424745ed-6356-46ad-87d4-3585f9062fb4", "Status": "OK", "ProviderName": "Xero API Partner", @@ -964,7 +964,7 @@ paths: "IsReconciled": false } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -974,7 +974,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BatchPayments' - example: '{ + example: { "BatchPayments": [ { "Account": { @@ -999,7 +999,7 @@ paths: ] } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -1036,7 +1036,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BatchPayments' - example: '{ + example: { "Id": "ee23328c-4a8b-4ee7-8fb6-9796ffab9cb0", "Status": "OK", "ProviderName": "provider-name", @@ -1057,7 +1057,7 @@ paths: "IsReconciled": false } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -1066,10 +1066,10 @@ paths: application/json: schema: $ref: '#/components/schemas/BatchPaymentDelete' - example: '{ + example: { "BatchPaymentID": "9bf296e9-0748-4d29-a3dc-24dde1098030", "Status":"DELETED" - }' + } '/BatchPayments/{BatchPaymentID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -1089,7 +1089,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BatchPayments' - example: '{ + example: { "Id": "6ab84949-4fe5-4788-a135-4d8f690d24d7", "Status": "OK", "ProviderName": "Xero API Partner", @@ -1155,7 +1155,7 @@ paths: "IsReconciled": false } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -1173,7 +1173,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BatchPayments' - example: '{ + example: { "Id": "ee23328c-4a8b-4ee7-8fb6-9796ffab9cb0", "Status": "OK", "ProviderName": "provider-name", @@ -1194,7 +1194,7 @@ paths: "IsReconciled": false } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -1203,9 +1203,9 @@ paths: application/json: schema: $ref: '#/components/schemas/BatchPaymentDeleteByUrlParam' - example: '{ + example: { "Status":"DELETED" - }' + } '/BatchPayments/{BatchPaymentID}/History': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -1225,7 +1225,7 @@ paths: application/json: schema: $ref: '#/components/schemas/HistoryRecords' - example: '{ + example: { "Id": "c58e2f9c-baad-42a4-8bb7-f32b6f88fa04", "Status": "OK", "ProviderName": "Xero API Partner", @@ -1239,7 +1239,7 @@ paths: "Details": "" } ] - }' + } put: security: - OAuth2: [accounting.transactions] @@ -1285,7 +1285,7 @@ paths: application/json: schema: $ref: '#/components/schemas/HistoryRecords' - example: '{ + example: { "Id": "d7525479-3392-44c0-bb37-ff4a0b5df5bd", "Status": "OK", "ProviderName": "Xero API Partner", @@ -1298,7 +1298,7 @@ paths: "ValidationErrors": [] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -1346,7 +1346,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BankTransactions' - example: '{ + example: { "Id": "18e7e80c-5dca-4a57-974e-8b572cc5efe8", "Status": "OK", "ProviderName": "Xero API Partner", @@ -1464,7 +1464,7 @@ paths: "CurrencyCode": "USD" } ] - }' + } put: security: - OAuth2: [accounting.transactions] @@ -1617,7 +1617,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BankTransactions' - example: '{ + example: { "Id": "5bc1d776-3c7f-4fe8-9b2d-09e747077a88", "Status": "OK", "ProviderName": "Xero API Partner", @@ -1725,7 +1725,7 @@ paths: ] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -1735,7 +1735,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BankTransactions' - example: '{ bankTransactions: [{ type: BankTransaction.TypeEnum.SPEND, contact: { contactID: "00000000-0000-0000-0000-000000000000" }, lineItems: [{ description: "Foobar", quantity: 1.0, unitAmount: 20.0, accountCode: "000" } ], bankAccount: { code: "000" }}]}' + example: { bankTransactions: [{ type: BankTransaction.TypeEnum.SPEND, contact: { contactID: "00000000-0000-0000-0000-000000000000" }, lineItems: [{ description: "Foobar", quantity: 1.0, unitAmount: 20.0, accountCode: "000" } ], bankAccount: { code: "000" }}]} post: security: - OAuth2: [accounting.transactions] @@ -1888,7 +1888,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BankTransactions' - example: '{ + example: { "Id": "5bc1d776-3c7f-4fe8-9b2d-09e747077a88", "Status": "OK", "ProviderName": "Xero API Partner", @@ -1996,7 +1996,7 @@ paths: ] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -2005,7 +2005,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BankTransactions' - example: '{ + example: { "BankTransactions": [ { "Type": "SPEND", @@ -2025,7 +2025,7 @@ paths: } } ] - }' + } '/BankTransactions/{BankTransactionID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -2046,7 +2046,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BankTransactions' - example: '{ + example: { "Id": "612e204d-21ab-469b-ac84-afe0697b4461", "Status": "OK", "ProviderName": "Xero API Partner", @@ -2165,7 +2165,7 @@ paths: "CurrencyCode": "USD" } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -2323,7 +2323,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BankTransactions' - example: '{ + example: { "Id": "f2c7f037-96fc-49bd-8f59-d3c7bfdd4746", "Status": "OK", "ProviderName": "Xero API Partner", @@ -2427,7 +2427,7 @@ paths: "CurrencyCode": "USD" } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -2436,7 +2436,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BankTransactions' - example: '{ + example: { "BankTransactions": [ { "Type": "SPEND", @@ -2516,7 +2516,7 @@ paths: "UpdatedDateUTC": "2019-02-26T12:39:27.813-08:00" } ] - }' + } '/BankTransactions/{BankTransactionID}/Attachments': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -2537,7 +2537,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "c50798e1-29e9-4a30-a452-bb6e42e400c8", "Status": "OK", "ProviderName": "Xero API Partner", @@ -2558,7 +2558,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '/BankTransactions/{BankTransactionID}/Attachments/{AttachmentID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -2623,7 +2623,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "572ad2fe-8c23-45aa-82f9-864485327685", "Status": "OK", "ProviderName": "Xero API Partner", @@ -2637,7 +2637,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -2668,7 +2668,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "572ad2fe-8c23-45aa-82f9-864485327685", "Status": "OK", "ProviderName": "Xero API Partner", @@ -2682,7 +2682,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -2784,7 +2784,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BankTransfers' - example: '{ + example: { "Id": "dfc0d130-9007-4a98-a5ef-6f01700f18e2", "Status": "OK", "ProviderName": "Xero API Partner", @@ -2835,7 +2835,7 @@ paths: "HasAttachments": false } ] - }' + } put: security: - OAuth2: [accounting.transactions] @@ -2922,7 +2922,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BankTransfers' - example: '{ + example: { "Id": "ae767b68-affd-4e17-bac0-83eaf1854dcd", "Status": "OK", "ProviderName": "Xero API Partner", @@ -2952,7 +2952,7 @@ paths: "ValidationErrors": [] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -2962,7 +2962,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BankTransfers' - example: '{ + example: { "BankTransfers": [ { "FromBankAccount": { @@ -3007,7 +3007,7 @@ paths: "Reference": "Sub 098801" } ] - }' + } '/BankTransfers/{BankTransferID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -3027,7 +3027,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BankTransfers' - example: '{ + example: { "Id": "1a5fa46d-5ece-4ef2-89b1-77c293b5d833", "Status": "OK", "ProviderName": "Xero API Partner", @@ -3068,7 +3068,7 @@ paths: ] } ] - }' + } '/BankTransfers/{BankTransferID}/Attachments': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -3089,7 +3089,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "5cb6b587-7b02-46b6-97fe-d8ad8f20321b", "Status": "OK", "ProviderName": "Xero API Partner", @@ -3103,7 +3103,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '/BankTransfers/{BankTransferID}/Attachments/{AttachmentID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -3167,7 +3167,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "c7810140-19c2-4ff7-b3ec-b7e95ce7becf", "Status": "OK", "ProviderName": "Xero API Partner", @@ -3181,7 +3181,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -3211,7 +3211,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "b73ba149-76a9-4e7c-a5c6-b9230022f416", "Status": "OK", "ProviderName": "Xero API Partner", @@ -3225,7 +3225,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -3313,7 +3313,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BrandingThemes' - example: '{ + example: { "Id": "d1a1beea-bdfe-4ee4-9dbc-27226a26cd68", "Status": "OK", "ProviderName": "Xero API Partner", @@ -3326,7 +3326,7 @@ paths: "CreatedDateUTC": "\/Date(1464967643813+0000)\/" } ] - }' + } '/BrandingThemes/{BrandingThemeID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -3346,7 +3346,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BrandingThemes' - example: '{ + example: { "Id": "df671650-cf14-4a7f-b609-4166933719bc", "Status": "OK", "ProviderName": "Xero API Partner", @@ -3359,7 +3359,7 @@ paths: "CreatedDateUTC": "\/Date(1464967643813+0000)\/" } ] - }' + } '/BrandingThemes/{BrandingThemeID}/PaymentServices': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -3380,7 +3380,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PaymentServices' - example: '{ + example: { "Id": "bfd5adbe-0e92-48f0-8c5a-39072f6c4ed3", "Status": "OK", "ProviderName": "Xero API Partner", @@ -3399,7 +3399,7 @@ paths: "PayNowText": "Pay Now" } ] - }' + } post: security: - OAuth2: [paymentservices] @@ -3463,7 +3463,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PaymentServices' - example: '{ + example: { "Id": "918feecb-067a-4ed9-841b-571c04eaada3", "Status": "OK", "ProviderName": "Xero API Partner", @@ -3477,7 +3477,7 @@ paths: "PayNowText": "Pay Now" } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -3487,7 +3487,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PaymentServices' - example: '{ + example: { "PaymentServices": [ { "PaymentServiceID": "54b3b4f6-0443-4fba-bcd1-61ec0c35ca55", @@ -3497,7 +3497,7 @@ paths: "PayNowText": "Time To Pay" } ] - }' + } '/Budgets': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -3547,7 +3547,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Budgets' - example: '{ + example: { "Id": "04e93d48-e72f-4775-b7dd-15a041fab972", "Status": "OK", "ProviderName": "Xero API Partner", @@ -3572,7 +3572,7 @@ paths: "Tracking": [] } ] - }' + } '/Budgets/{BudgetID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -3608,7 +3608,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Budgets' - example: '{ + example: { "Id": "04e93d48-e72f-4775-b7dd-15a041fab972", "Status": "OK", "ProviderName": "Xero API Partner", @@ -3677,7 +3677,7 @@ paths: } ] } - }' + } '/Contacts': parameters: @@ -3752,7 +3752,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Contacts' - example: '{ + example: { "Id": "04e93d48-e72f-4775-b7dd-15a041fab972", "Status": "OK", "ProviderName": "Xero API Partner", @@ -3902,7 +3902,7 @@ paths: "HasValidationErrors": false } ] - }' + } put: security: - OAuth2: [accounting.contacts] @@ -3991,7 +3991,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Contacts' - example: '{ + example: { "Id": "e997d6d7-6dad-4458-beb8-d9c1bf7f2edf", "Status": "OK", "ProviderName": "Xero API Partner", @@ -4068,14 +4068,14 @@ paths: "HasValidationErrors": false } ] - }' + } '400': description: Validation Error - some data was incorrect returns response of type Error content: application/json: schema: $ref: '#/components/schemas/Error' - example: '{ + example: { "ErrorNumber": 10, "Type": "ValidationException", "Message": "A validation exception occurred", @@ -4130,7 +4130,7 @@ paths: ] } ] - }' + } requestBody: required: true description: Contacts with an array of Contact objects to create in body of request @@ -4138,7 +4138,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Contacts' - example: '{ + example: { "Contacts": [ { "ContactID": "3ff6d40c-af9a-40a3-89ce-3c1556a25591", @@ -4207,7 +4207,7 @@ paths: "ContactPersons": [] } ] - }' + } post: security: - OAuth2: [accounting.contacts] @@ -4296,7 +4296,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Contacts' - example: '{ + example: { "Id": "e997d6d7-6dad-4458-beb8-d9c1bf7f2edf", "Status": "OK", "ProviderName": "Xero API Partner", @@ -4373,14 +4373,14 @@ paths: "HasValidationErrors": false } ] - }' + } '400': description: Validation Error - some data was incorrect returns response of type Error content: application/json: schema: $ref: '#/components/schemas/Error' - example: '{ + example: { "ErrorNumber": 10, "Type": "ValidationException", "Message": "A validation exception occurred", @@ -4435,14 +4435,14 @@ paths: ] } ] - }' + } requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Contacts' - example: '{ + example: { "Contacts": [ { "Name": "Bruce Banner", @@ -4466,7 +4466,7 @@ paths: } } ] - }' + } '/Contacts/{ContactNumber}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -4493,7 +4493,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Contacts' - example: '{ + example: { "Id": "5c83b115-a6e8-4f2a-877f-ba63d009235b", "Status": "OK", "ProviderName": "Xero API Partner", @@ -4622,7 +4622,7 @@ paths: "HasValidationErrors": false } ] - }' + } '/Contacts/{ContactID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -4642,7 +4642,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Contacts' - example: '{ + example: { "Id": "5c83b115-a6e8-4f2a-877f-ba63d009235b", "Status": "OK", "ProviderName": "Xero API Partner", @@ -4771,7 +4771,7 @@ paths: "HasValidationErrors": false } ] - }' + } post: security: - OAuth2: [accounting.contacts] @@ -4819,7 +4819,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Contacts' - example: '{ + example: { "Id": "4166b727-c3f0-4881-acd0-d4f7c0e8fcda", "Status": "OK", "ProviderName": "Xero API Partner", @@ -4895,7 +4895,7 @@ paths: "HasValidationErrors": false } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -4905,7 +4905,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Contacts' - example: '{ "Contacts": [{ "ContactID": "00000000-0000-0000-0000-000000000000", "Name": "Thanos" }]}' + example: { "Contacts": [{ "ContactID": "00000000-0000-0000-0000-000000000000", "Name": "Thanos" }]} '/Contacts/{ContactID}/Attachments': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -4925,7 +4925,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "0f63b631-a205-496d-b1d2-e6b13a9b497b", "Status": "OK", "ProviderName": "Xero API Partner", @@ -4939,7 +4939,7 @@ paths: "ContentLength": 2878711 } ] - }' + } parameters: - $ref: '#/components/parameters/ContactID' '/Contacts/{ContactID}/Attachments/{AttachmentID}': @@ -5005,7 +5005,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "8543ae1a-297c-49b8-bf91-47decac452d5", "Status": "OK", "ProviderName": "Provider Name Example", @@ -5019,7 +5019,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -5049,7 +5049,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "a5eddf71-86aa-42f5-99e2-0aaf9caf96b6", "Status": "OK", "ProviderName": "Provider Name Example", @@ -5063,7 +5063,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -5187,7 +5187,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ContactGroups' - example: '{ + example: { "Id": "b825df86-1a72-49c9-97dd-36afc7d04bd5", "Status": "OK", "ProviderName": "Provider Name Example", @@ -5208,7 +5208,7 @@ paths: "HasValidationErrors": false } ] - }' + } put: security: - OAuth2: [accounting.contacts] @@ -5253,7 +5253,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ContactGroups' - example: '{ + example: { "Id": "5afe53f9-2271-45b8-9767-88d023b71d34", "Status": "OK", "ProviderName": "Provider Name Example", @@ -5267,14 +5267,14 @@ paths: "HasValidationErrors": false } ] - }' + } '400': description: Validation Error - some data was incorrect returns response of type Error content: application/json: schema: $ref: '#/components/schemas/Error' - example: '{ + example: { "ErrorNumber": 10, "Type": "ValidationException", "Message": "A validation exception occurred", @@ -5291,7 +5291,7 @@ paths: ] } ] - }' + } requestBody: description: ContactGroups with an array of names in request body required: true @@ -5299,7 +5299,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ContactGroups' - example: '{ "ContactGroups": [{ "Name": "VIPs" }]}' + example: { "ContactGroups": [{ "Name": "VIPs" }]} '/ContactGroups/{ContactGroupID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -5319,7 +5319,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ContactGroups' - example: '{ + example: { "Id": "079c14f6-2c2d-464e-a2c7-0edf7e465723", "Status": "OK", "ProviderName": "Provider Name Example", @@ -5352,7 +5352,7 @@ paths: "HasValidationErrors": false } ] - }' + } post: security: - OAuth2: [accounting.contacts] @@ -5398,7 +5398,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ContactGroups' - example: '{ + example: { "Id": "b1ba6cdb-1637-4209-bb92-bd0c593f3243", "Status": "OK", "ProviderName": "Provider Name Example", @@ -5412,7 +5412,7 @@ paths: "HasValidationErrors": false } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -5422,13 +5422,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ContactGroups' - example: '{ + example: { "ContactGroups":[ { "Name":"Suppliers" } ] - }' + } '/ContactGroups/{ContactGroupID}/Contacts': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -5475,7 +5475,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Contacts' - example: '{ + example: { "Id": "99db8024-6895-45c8-a1b5-54805aa8689c", "Status": "OK", "ProviderName": "Provider Name Example", @@ -5500,7 +5500,7 @@ paths: "ValidationErrors": [] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -5510,7 +5510,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Contacts' - example: '{ + example: { "Contacts": [ { "ContactID": "a3675fc4-f8dd-4f03-ba5b-f1870566bcd7" @@ -5519,7 +5519,7 @@ paths: "ContactID": "4e1753b9-018a-4775-b6aa-1bc7871cfee3" } ] - }' + } delete: security: - OAuth2: [accounting.contacts] @@ -5595,7 +5595,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreditNotes' - example: '{ + example: { "Id": "306379b0-3d75-4c77-953a-be08fa0efae8", "Status": "OK", "ProviderName": "Provider Name Example", @@ -5680,7 +5680,7 @@ paths: "CurrencyCode": "NZD" } ] - }' + } put: security: - OAuth2: [accounting.transactions] @@ -5835,7 +5835,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreditNotes' - example: '{ + example: { "Id": "5e57a661-42da-4a19-96a0-00405a0e946d", "Status": "OK", "ProviderName": "Provider Name Example", @@ -5938,7 +5938,7 @@ paths: ] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -5948,7 +5948,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreditNotes' - example: '{ + example: { "CreditNotes":[ { "Type":"ACCPAYCREDIT", @@ -5966,7 +5966,7 @@ paths: ] } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -6121,7 +6121,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreditNotes' - example: '{ + example: { "Id": "5e57a661-42da-4a19-96a0-00405a0e946d", "Status": "OK", "ProviderName": "Provider Name Example", @@ -6225,7 +6225,7 @@ paths: ] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -6235,7 +6235,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreditNotes' - example: '{ + example: { "CreditNotes":[ { "Type":"ACCPAYCREDIT", @@ -6255,7 +6255,7 @@ paths: ] } ] - }' + } '/CreditNotes/{CreditNoteID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -6276,7 +6276,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreditNotes' - example: '{ + example: { "Id": "dd5c5da7-08ab-486a-ac34-aea295f1614b", "Status": "OK", "ProviderName": "Provider Name Example", @@ -6393,7 +6393,7 @@ paths: "CurrencyCode": "NZD" } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -6565,7 +6565,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreditNotes' - example: '{ + example: { "Id": "db2f7659-6044-418d-a4c6-d4b93eba4e1e", "Status": "OK", "ProviderName": "Provider Name Example", @@ -6662,7 +6662,7 @@ paths: "CurrencyCode": "NZD" } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -6672,7 +6672,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreditNotes' - example: '{ + example: { "CreditNotes": [ { "Type": "ACCPAYCREDIT", @@ -6693,7 +6693,7 @@ paths: ] } ] - }' + } '/CreditNotes/{CreditNoteID}/Attachments': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -6714,7 +6714,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "2bb15054-3868-4f85-a9c6-0402ec8c1201", "Status": "OK", "ProviderName": "Provider Name Example", @@ -6728,7 +6728,7 @@ paths: "ContentLength": 76091 } ] - }' + } '/CreditNotes/{CreditNoteID}/Attachments/{AttachmentID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -6793,7 +6793,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "27253066-8c4d-4e34-a251-7a749b72de40", "Status": "OK", "ProviderName": "Provider Name Example", @@ -6807,7 +6807,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -6839,7 +6839,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "22a8d402-5dea-40ed-9d01-26896429f649", "Status": "OK", "ProviderName": "Provider Name Example", @@ -6853,7 +6853,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -6973,7 +6973,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Allocations' - example: '{ + example: { "Id": "73452751-6eaa-4bcb-86f5-4c013316f4cf", "Status": "OK", "ProviderName": "Provider Name Example", @@ -7001,7 +7001,7 @@ paths: "ValidationErrors": [] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -7011,7 +7011,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Allocations' - example: '{ + example: { "Allocations": [ { "Invoice": { @@ -7022,7 +7022,7 @@ paths: "Date": "2019-03-05" } ] - }' + } '/CreditNotes/{CreditNoteID}/Allocations/{AllocationID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -7043,7 +7043,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Allocation' - example: '{ + example: { "AllocationId": "2bb15054-3868-4f85-a9c6-0402ec8c1201", "Date": "\/Date(1551822670731)\/", "Invoice": [ @@ -7052,7 +7052,7 @@ paths: } ], "IsDeleted": true, - }' + } '/CreditNotes/{CreditNoteID}/History': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -7146,7 +7146,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Currencies' - example: '{ + example: { "Id": "e6803fc8-8035-4251-b3e4-39d6b2de0f4a", "Status": "OK", "ProviderName": "Provider Name Example", @@ -7157,7 +7157,7 @@ paths: "Description": "New Zealand Dollar" } ] - }' + } put: security: - OAuth2: [accounting.settings] @@ -7198,6 +7198,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Currencies' + example: { + "Currencies": [ + { + "Code": "USD", + "Description": "United States Dollar" + } + ] + } requestBody: required: true description: Currency object in the body of request @@ -7205,10 +7213,10 @@ paths: application/json: schema: $ref: '#/components/schemas/Currency' - example: '{ + example: { "Code": "USD", "Description": "United States Dollar" - }' + } /Employees: parameters: - $ref: '#/components/parameters/requiredHeader' @@ -7244,7 +7252,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Employees' - example: ' { + example: { "Id": "593cbccc-5cd2-4cd2-be5e-150f0843709e", "Status": "OK", "ProviderName": "Provider Name Example", @@ -7284,7 +7292,7 @@ paths: "UpdatedDateUTC": "\/Date(1552324737990+0000)\/" } ] - }' + } put: security: - OAuth2: [accounting.settings] @@ -7333,7 +7341,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Employees' - example: '{ + example: { "Id": "0d6a08e7-6936-4828-a1bc-e4595e0ef778", "Status": "OK", "ProviderName": "Provider Name Example", @@ -7351,7 +7359,7 @@ paths: "UpdatedDateUTC": "\/Date(1552324736463+0000)\/" } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -7361,7 +7369,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Employees' - example: '{ + example: { "Employees": [ { "FirstName": "Nick", @@ -7371,7 +7379,7 @@ paths: } } ] - }' + } post: security: - OAuth2: [accounting.settings] @@ -7420,7 +7428,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Employees' - example: '{ + example: { "Id": "0d6a08e7-6936-4828-a1bc-e4595e0ef778", "Status": "OK", "ProviderName": "Provider Name Example", @@ -7438,7 +7446,7 @@ paths: "UpdatedDateUTC": "\/Date(1552324736463+0000)\/" } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -7448,7 +7456,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Employees' - example: '{ + example: { "Employees": [ { "FirstName": "Nick", @@ -7458,7 +7466,7 @@ paths: } } ] - }' + } '/Employees/{EmployeeID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -7478,7 +7486,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Employees' - example: '{ + example: { "Id": "417a529e-4f8d-4b1a-8816-7100245cf8b2", "Status": "OK", "ProviderName": "Provider Name Example", @@ -7496,7 +7504,7 @@ paths: "UpdatedDateUTC": "\/Date(1552324681593+0000)\/" } ] - }' + } /ExpenseClaims: parameters: - $ref: '#/components/parameters/requiredHeader' @@ -7532,7 +7540,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ExpenseClaims' - example: '{ + example: { "Id": "f6a8867e-af29-41ee-8f77-855f5ff214fe", "Status": "OK", "ProviderName": "Provider Name Example", @@ -7559,7 +7567,7 @@ paths: "ReportingDate": "\/Date(1552262400000+0000)\/" } ] - }' + } put: security: - OAuth2: [accounting.transactions] @@ -7681,7 +7689,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ExpenseClaims' - example: '{ + example: { "ExpenseClaims": [ { "Status": "SUBMITTED", @@ -7696,7 +7704,7 @@ paths: ] } ] - }' + } responses: '200': description: Success - return response of type ExpenseClaims array with newly created ExpenseClaim @@ -7704,7 +7712,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ExpenseClaims' - example: '{ + example: { "Id": "4a0879a6-3860-4b73-adc6-f6a0e0f68fc8", "Status": "OK", "ProviderName": "Provider Name Example", @@ -7775,7 +7783,7 @@ paths: "StatusAttributeString": "OK" } ] - }' + } '400': $ref: '#/components/responses/400Error' '/ExpenseClaims/{ExpenseClaimID}': @@ -7797,7 +7805,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ExpenseClaims' - example: '{ + example: { "Id": "b54bb45d-37da-4f53-9f1d-536302d6bad7", "Status": "OK", "ProviderName": "Provider Name Example", @@ -7869,7 +7877,7 @@ paths: "ReportingDate": "\/Date(1552262400000+0000)\/" } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -7992,7 +8000,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ExpenseClaims' - example: '{ + example: { "Id": "8ee87f9c-058b-4f1b-b5b2-29569bf055d7", "Status": "OK", "ProviderName": "Provider Name Example", @@ -8064,7 +8072,7 @@ paths: "ReportingDate": "\/Date(1552262400000+0000)\/" } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -8073,7 +8081,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ExpenseClaims' - example: '{ + example: { "ExpenseClaims": [ { "Status": "SUBMITTED", @@ -8088,7 +8096,7 @@ paths: ] } ] - }' + } '/ExpenseClaims/{ExpenseClaimID}/History': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -8265,7 +8273,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Invoices' - example: '{ + example: { "Id": "900c500b-e83c-4ce2-902a-b8ba04751748", "Status": "OK", "ProviderName": "Provider Name Example", @@ -8405,7 +8413,7 @@ paths: "CurrencyCode": "NZD" } ] - }' + } put: security: - OAuth2: [accounting.transactions] @@ -8637,7 +8645,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Invoices' - example: '{ + example: { "Id": "ccece84a-075c-4fcd-9073-149d4f7a91cf", "Status": "OK", "ProviderName": "Provider Name Example", @@ -8760,7 +8768,7 @@ paths: "StatusAttributeString": "OK" } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -8770,7 +8778,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Invoices' - example: '{ + example: { "Invoices": [ { "Type": "ACCREC", @@ -8793,7 +8801,7 @@ paths: "Status": "AUTHORISED" } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -8984,7 +8992,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Invoices' - example: '{ + example: { "Id": "ccece84a-075c-4fcd-9073-149d4f7a91cf", "Status": "OK", "ProviderName": "Provider Name Example", @@ -9107,7 +9115,7 @@ paths: "StatusAttributeString": "OK" } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -9116,7 +9124,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Invoices' - example: '{ + example: { "Invoices": [ { "Type": "ACCREC", @@ -9139,7 +9147,7 @@ paths: "Status": "AUTHORISED" } ] - }' + } '/Invoices/{InvoiceID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -9160,7 +9168,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Invoices' - example: '{ + example: { "Id": "516f400a-b764-4c88-831b-12d2b210fa24", "Status": "OK", "ProviderName": "Provider Name Example", @@ -9311,7 +9319,7 @@ paths: ] } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -9354,7 +9362,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Invoices' - example: '{ + example: { "Id": "bd83b60e-9d16-4a3b-9f59-0a2d0ccd35f2", "Status": "OK", "ProviderName": "Provider Name Example", @@ -9458,7 +9466,7 @@ paths: "CurrencyCode": "NZD" } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -9467,7 +9475,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Invoices' - example: '{ "Invoices": [{ Reference: "May the force be with you", "InvoiceID": "00000000-0000-0000-0000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" }]}' + example: { "Invoices": [{ Reference: "May the force be with you", "InvoiceID": "00000000-0000-0000-0000-000000000000", "LineItems": [], "Contact": {}, "Type": "ACCPAY" }]} '/Invoices/{InvoiceID}/pdf': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -9509,7 +9517,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: ' { + example: { "Id": "7e357a45-69f5-4e8f-8d7b-15da8ef50aab", "Status": "OK", "ProviderName": "Provider Name Example", @@ -9530,7 +9538,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '/Invoices/{InvoiceID}/Attachments/{AttachmentID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -9595,7 +9603,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "acd7d618-5fef-4d45-849c-a339ea31a973", "Status": "OK", "ProviderName": "Provider Name Example", @@ -9609,7 +9617,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -9641,7 +9649,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "971fbd18-c850-453a-825f-63f2fee096ee", "Status": "OK", "ProviderName": "Provider Name Example", @@ -9655,7 +9663,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -9685,7 +9693,7 @@ paths: application/json: schema: $ref: '#/components/schemas/OnlineInvoices' - example: '{ + example: { "Id": "d20705fb-fe1c-4366-835b-98de7474da3c", "Status": "OK", "ProviderName": "Provider Name Example", @@ -9695,7 +9703,7 @@ paths: "OnlineInvoiceUrl": "https://in.xero.com/bCWCCfytGdTXoJam9HENWlQt07G6zcDaj4gQojHu" } ] - }' + } '/Invoices/{InvoiceID}/Email': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -9728,7 +9736,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RequestEmpty' - example: '{}' + example: {} '/Invoices/{InvoiceID}/History': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -9806,7 +9814,7 @@ paths: application/json: schema: $ref: '#/components/schemas/InvoiceReminders' - example: '{ + example: { "Id": "c7cd0953-c012-4be8-b618-63ce4c2c3494", "Status": "OK", "ProviderName": "Provider Name Example", @@ -9816,7 +9824,7 @@ paths: "Enabled": false } ] - }' + } /Items: parameters: - $ref: '#/components/parameters/requiredHeader' @@ -9849,7 +9857,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Items' - example: '{ + example: { "Id": "8487e8d7-5fb3-4f02-b949-dec8f1e38182", "Status": "OK", "ProviderName": "Provider Name Example", @@ -9884,7 +9892,7 @@ paths: "IsPurchased": true } ] - }' + } put: security: - OAuth2: [accounting.settings] @@ -9966,7 +9974,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Items' - example: '{ + example: { "Id": "ae7ef7c8-9024-4d42-8d59-5f26ed3f508b", "Status": "OK", "ProviderName": "Provider Name Example", @@ -9990,7 +9998,7 @@ paths: ] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -10000,7 +10008,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Items' - example: '{ + example: { "Items": [ { "Code": "code123", @@ -10012,7 +10020,7 @@ paths: } } ] - }' + } post: security: - OAuth2: [accounting.settings] @@ -10065,7 +10073,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Items' - example: '{ + example: { "Id": "ae7ef7c8-9024-4d42-8d59-5f26ed3f508b", "Status": "OK", "ProviderName": "Provider Name Example", @@ -10089,7 +10097,7 @@ paths: ] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -10098,7 +10106,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Items' - example: '{ + example: { "Items": [ { "Code": "ItemCode123", @@ -10106,7 +10114,7 @@ paths: "Description": "Item Description ABC" } ] - }' + } '/Items/{ItemID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -10127,7 +10135,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Items' - example: '{ + example: { "Id": "0bbd8a92-9ba7-4711-8040-8d6a609ca7e8", "Status": "OK", "ProviderName": "Provider Name Example", @@ -10159,7 +10167,7 @@ paths: "ValidationErrors": [] } ] - }' + } post: security: - OAuth2: [accounting.settings] @@ -10207,7 +10215,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Items' - example: '{ + example: { "Id": "24feb629-6b14-499e-9aa1-fc2c596c0280", "Status": "OK", "ProviderName": "Provider Name Example", @@ -10227,7 +10235,7 @@ paths: "ValidationErrors": [] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -10236,14 +10244,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Items' - example: '{ + example: { "Items": [ { "Code": "ItemCode123", "Description": "Description 123" } ] - }' + } delete: security: - OAuth2: [accounting.settings] @@ -10350,7 +10358,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Journals' - example: '{ + example: { "Id": "49a09a97-df50-4679-8043-02c86e0dcf5f", "Status": "OK", "ProviderName": "Provider Name Example", @@ -10514,7 +10522,7 @@ paths: ] } ] - }' + } '/Journals/{JournalID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -10534,7 +10542,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Journals' - example: '{ + example: { "Id": "39ab8367-eb14-420d-83a9-e01ddddd21f8", "Status": "OK", "ProviderName": "Provider Name Example", @@ -10578,7 +10586,7 @@ paths: ] } ] - }' + } '/Journals/{JournalNumber}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -10598,7 +10606,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Journals' - example: '{ + example: { "Id": "39ab8367-eb14-420d-83a9-e01ddddd21f8", "Status": "OK", "ProviderName": "Provider Name Example", @@ -10642,7 +10650,7 @@ paths: ] } ] - }' + } /LinkedTransactions: parameters: - $ref: '#/components/parameters/requiredHeader' @@ -10706,7 +10714,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LinkedTransactions' - example: '{ + example: { "Id": "516aabd0-e670-48d5-b0eb-10dce4494dd8", "Status": "OK", "ProviderName": "Provider Name Example", @@ -10725,7 +10733,7 @@ paths: "SourceTransactionTypeCode": "ACCPAY" } ] - }' + } put: security: - OAuth2: [accounting.transactions] @@ -10764,7 +10772,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LinkedTransactions' - example: '{ + example: { "Id": "f32b30e5-32d1-42a8-bcc9-5b22828f725c", "Status": "OK", "ProviderName": "Provider Name Example", @@ -10785,7 +10793,7 @@ paths: ] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -10795,14 +10803,14 @@ paths: application/json: schema: $ref: '#/components/schemas/LinkedTransaction' - example: '{ + example: { "LinkedTransactions": [ { "SourceTransactionID": "a848644a-f20f-4630-98c3-386bd7505631", "SourceLineItemID": "b0df260d-3cc8-4ced-9bd6-41924f624ed3" } ] - }' + } '/LinkedTransactions/{LinkedTransactionID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -10822,7 +10830,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LinkedTransactions' - example: '{ + example: { "Id": "171ca542-874d-44e2-8930-db9bccd7d88b", "Status": "OK", "ProviderName": "Provider Name Example", @@ -10841,7 +10849,7 @@ paths: "SourceTransactionTypeCode": "ACCPAY" } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -10895,7 +10903,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LinkedTransactions' - example: '{ + example: { "Id": "bd364af7-08f0-432b-81db-c1e5ba05f3dd", "Status": "OK", "ProviderName": "Provider Name Example", @@ -10912,14 +10920,14 @@ paths: "SourceTransactionTypeCode": "ACCPAY" } ] - }' + } '400': description: Success - return response of type LinkedTransactions array with updated LinkedTransaction content: application/json: schema: $ref: '#/components/schemas/Error' - example: '{ + example: { "ErrorNumber": 10, "Type": "ValidationException", "Message": "A validation exception occurred", @@ -10942,21 +10950,21 @@ paths: ] } ] - }' + } requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LinkedTransactions' - example: '{ + example: { "LinkedTransactions": [ { "SourceTransactionID": "00000000-0000-0000-0000-000000000000", "SourceLineItemID": "00000000-0000-0000-0000-000000000000" } ] - }' + } delete: security: - OAuth2: [accounting.transactions] @@ -11014,7 +11022,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ManualJournals' - example: '{ + example: { "Id": "8a508ec1-b578-48bf-97df-020c918fbf7d", "Status": "OK", "ProviderName": "Provider Name Example", @@ -11060,7 +11068,7 @@ paths: "HasAttachments": false } ] - }' + } put: security: - OAuth2: [accounting.transactions] @@ -11206,7 +11214,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ManualJournals' - example: '{ + example: { "Id": "45dfa608-0fcb-4f30-a377-c82cd348569c", "Status": "OK", "ProviderName": "Provider Name Example", @@ -11259,7 +11267,7 @@ paths: ] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -11269,7 +11277,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ManualJournals' - example: '{ + example: { "ManualJournals": [ { "Narration": "Journal Desc", @@ -11294,7 +11302,7 @@ paths: "Date": "2019-03-14" } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -11440,7 +11448,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ManualJournals' - example: '{ + example: { "Id": "45dfa608-0fcb-4f30-a377-c82cd348569c", "Status": "OK", "ProviderName": "Provider Name Example", @@ -11493,7 +11501,7 @@ paths: ] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -11503,7 +11511,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ManualJournals' - example: '{ + example: { "ManualJournals": [ { "Narration": "Journal Desc", @@ -11528,7 +11536,7 @@ paths: "Date": "2019-03-14" } ] - }' + } '/ManualJournals/{ManualJournalID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -11548,7 +11556,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ManualJournals' - example: '{ + example: { "Id": "7321fc21-1a13-4f40-ae47-df59cff5676d", "Status": "OK", "ProviderName": "Provider Name Example", @@ -11603,7 +11611,7 @@ paths: ] } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -11749,7 +11757,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ManualJournals' - example: '{ + example: { "Id": "b694559c-686c-4047-b657-661ba6c0dd1f", "Status": "OK", "ProviderName": "Provider Name Example", @@ -11789,7 +11797,7 @@ paths: "Attachments": [] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -11798,7 +11806,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ManualJournals' - example: '{ + example: { "ManualJournals": [ { "Narration": "Hello Xero", @@ -11806,7 +11814,7 @@ paths: "JournalLines": [] } ] - }' + } '/ManualJournals/{ManualJournalID}/Attachments': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -11827,7 +11835,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "5fa4b3ef-7945-45a7-9bab-10e830673dfb", "Status": "OK", "ProviderName": "Provider Name Example", @@ -11848,7 +11856,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '/ManualJournals/{ManualJournalID}/Attachments/{AttachmentID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -11913,7 +11921,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "e1cb9deb-a8f0-477f-b4d1-cf0c6c39e080", "Status": "OK", "ProviderName": "Provider Name Example", @@ -11927,7 +11935,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -11958,7 +11966,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "a864994c-e7d7-4dee-b5ca-0a729fde2f39", "Status": "OK", "ProviderName": "Provider Name Example", @@ -11972,7 +11980,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -12060,7 +12068,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Organisations' - example: '{ + example: { "Id": "27b7a645-a3ee-43c8-b2c6-a2fa7b84c8c5", "Status": "OK", "ProviderName": "Provider Name Example", @@ -12099,7 +12107,7 @@ paths: "PaymentTerms": {} } ] - }' + } '/Organisation/Actions': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -12117,7 +12125,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Actions' - example: '{ + example: { "Id": "f02c0dd1-1917-4d57-9853-997f6bcaf2bc", "Status": "OK", "ProviderName": "Java OA2 dev 01", @@ -12176,7 +12184,7 @@ paths: "Status": "ALLOWED" } ] - }' + } '/Organisation/{OrganisationID}/CISSettings': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -12239,7 +12247,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Overpayments' - example: '{ + example: { "Id": "c0ce675e-e5bc-4b2a-a20e-76a9eaedf89d", "Status": "OK", "ProviderName": "Provider Name Example", @@ -12392,7 +12400,7 @@ paths: "CurrencyCode": "NZD" } ] - }' + } '/Overpayments/{OverpaymentID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -12412,7 +12420,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Overpayments' - example: ' { + example: { "Id": "46c9e8e2-9410-4e75-9297-f0ca8fa76c32", "Status": "OK", "ProviderName": "Provider Name Example", @@ -12534,7 +12542,7 @@ paths: "CurrencyCode": "NZD" } ] - }' + } '/Overpayments/{OverpaymentID}/Allocations': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -12623,7 +12631,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Allocations' - example: '{ + example: { "Id": "3b7f7be2-384a-4703-bcfb-c56e9116c914", "Status": "OK", "ProviderName": "Provider Name Example", @@ -12651,7 +12659,7 @@ paths: "ValidationErrors": [] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -12661,7 +12669,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Allocations' - example: '{ + example: { "Allocations": [ { "Invoice": { @@ -12674,7 +12682,7 @@ paths: "Date": "2019-03-12" } ] - }' + } '/Overpayments/{OverpaymentID}/Allocations/{AllocationID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -12695,7 +12703,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Allocation' - example: '{ + example: { "AllocationId": "2bb15054-3868-4f85-a9c6-0402ec8c1201", "Date": "\/Date(1551822670731)\/", "Invoice": [ @@ -12704,7 +12712,7 @@ paths: } ], "IsDeleted": true, - }' + } '/Overpayments/{OverpaymentID}/History': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -12767,7 +12775,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' - example: '{ + example: { "ErrorNumber": 10, "Type": "ValidationException", "Message": "A validation exception occurred", @@ -12783,7 +12791,7 @@ paths: ] } ] - }' + } requestBody: $ref: '#/components/requestBodies/historyRecords' /Payments: @@ -12828,7 +12836,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Payments' - example: '{ + example: { "Id": "9f310473-e1b5-4704-a25c-eec653deb596", "Status": "OK", "ProviderName": "Provider Name Example", @@ -12936,7 +12944,7 @@ paths: "HasValidationErrors": false } ] - }' + } put: security: - OAuth2: [accounting.transactions] @@ -13040,7 +13048,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Payments' - example: '{ + example: { "Id": "83b5715a-6a77-4c16-b5b8-2da08b5fde44", "Status": "OK", "ProviderName": "Provider Name Example", @@ -13115,7 +13123,7 @@ paths: ] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -13125,7 +13133,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Payments' - example: '{ + example: { "Payments": [ { "Invoice": { @@ -13139,7 +13147,7 @@ paths: "Amount": 1 } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -13242,7 +13250,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Payments' - example: '{ + example: { "Id": "83b5715a-6a77-4c16-b5b8-2da08b5fde44", "Status": "OK", "ProviderName": "Provider Name Example", @@ -13317,7 +13325,7 @@ paths: ] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -13327,7 +13335,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Payment' - example: '{ + example: { "Payments": [ { "Invoice": { @@ -13341,7 +13349,7 @@ paths: "Amount": 1 } ] - }' + } '/Payments/{PaymentID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -13361,7 +13369,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Payments' - example: '{ + example: { "Id": "4876f9ee-3a17-47d8-8c1b-84377c8f2998", "Status": "OK", "ProviderName": "Provider Name Example", @@ -13455,7 +13463,7 @@ paths: "HasValidationErrors": false } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -13485,7 +13493,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Payments' - example: '{ + example: { "Id": "ee23328c-4a8b-4ee7-8fb6-9796ffab9cb0", "Status": "OK", "ProviderName": "provider-name", @@ -13553,7 +13561,7 @@ paths: "HasValidationErrors": false } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -13562,13 +13570,13 @@ paths: application/json: schema: $ref: '#/components/schemas/PaymentDelete' - example: '{ + example: { "Payments":[ { "Status":"DELETED" } ] - }' + } '/Payments/{PaymentID}/History': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -13631,7 +13639,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' - example: '{ + example: { "ErrorNumber": 10, "Type": "ValidationException", "Message": "A validation exception occurred", @@ -13647,7 +13655,7 @@ paths: ] } ] - }' + } requestBody: $ref: '#/components/requestBodies/historyRecords' /PaymentServices: @@ -13668,7 +13676,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PaymentServices' - example: '{ + example: { "Id": "ab82a7dd-5070-4e82-b841-0af52909fe04", "Status": "OK", "ProviderName": "Provider Name Example", @@ -13682,7 +13690,7 @@ paths: "PayNowText": "Time To Pay" } ] - }' + } put: security: - OAuth2: [paymentservices] @@ -13738,7 +13746,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PaymentServices' - example: '{ + example: { "Id": "7ed8b3c0-2155-49ee-a583-f2dce6607dfb", "Status": "OK", "ProviderName": "Provider Name Example", @@ -13757,7 +13765,7 @@ paths: ] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -13767,7 +13775,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PaymentServices' - example: '{ + example: { "PaymentServices": [ { "PaymentServiceName": "PayUpNow", @@ -13775,7 +13783,7 @@ paths: "PayNowText": "Time To Pay" } ] - }' + } /Prepayments: parameters: - $ref: '#/components/parameters/requiredHeader' @@ -13819,7 +13827,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Prepayments' - example: '{ + example: { "Id": "d7a9ca0c-6159-4c26-ad2e-715440c50b7d", "Status": "OK", "ProviderName": "Provider Name Example", @@ -13861,7 +13869,7 @@ paths: "CurrencyCode": "NZD" } ] - }' + } '/Prepayments/{PrepaymentID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -13881,7 +13889,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Prepayments' - example: '{ + example: { "Id": "18e5f578-ef28-4096-a7aa-d06d65574b99", "Status": "OK", "ProviderName": "Provider Name Example", @@ -14001,7 +14009,7 @@ paths: "CurrencyCode": "NZD" } ] - }' + } '/Prepayments/{PrepaymentID}/Allocations': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -14090,7 +14098,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Allocations' - example: '{ + example: { "Id": "d4758808-d14d-45d5-851a-52787ae5739a", "Status": "OK", "ProviderName": "Provider Name Example", @@ -14118,7 +14126,7 @@ paths: "ValidationErrors": [] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -14128,7 +14136,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Allocations' - example: '{ + example: { "Allocations": [ { "Invoice": { @@ -14139,7 +14147,7 @@ paths: "Date": "2019-01-10" } ] - }' + } '/Prepayments/{PrepaymentID}/Allocations/{AllocationID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -14160,7 +14168,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Allocation' - example: '{ + example: { "AllocationId": "2bb15054-3868-4f85-a9c6-0402ec8c1201", "Date": "\/Date(1551822670731)\/", "Invoice": [ @@ -14169,7 +14177,7 @@ paths: } ], "IsDeleted": true, - }' + } '/Prepayments/{PrepaymentID}/History': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -14310,7 +14318,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PurchaseOrders' - example: '{ + example: { "Id": "66910bfc-15cc-4692-bd4c-cc8f671e653c", "Status": "OK", "ProviderName": "Provider Name Example", @@ -14465,7 +14473,7 @@ paths: "HasAttachments": false } ] - }' + } put: security: - OAuth2: [accounting.transactions] @@ -14607,7 +14615,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PurchaseOrders' - example: ' { + example: { "Id": "aa2f9d23-fd76-4bee-9600-30c0f0f34036", "Status": "OK", "ProviderName": "Provider Name Example", @@ -14714,7 +14722,7 @@ paths: ] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -14724,7 +14732,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PurchaseOrders' - example: '{ + example: { "PurchaseOrders": [ { "Contact": { @@ -14741,7 +14749,7 @@ paths: "Date": "2019-03-13" } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -14883,114 +14891,114 @@ paths: application/json: schema: $ref: '#/components/schemas/PurchaseOrders' - example: ' { - "Id": "aa2f9d23-fd76-4bee-9600-30c0f0f34036", - "Status": "OK", - "ProviderName": "Provider Name Example", - "DateTimeUTC": "\/Date(1552522946173)\/", - "PurchaseOrders": [ - { - "PurchaseOrderID": "56204648-8fbe-46f8-b09c-2125f7939533", - "PurchaseOrderNumber": "PO-0004", - "DateString": "2019-03-13T00:00:00", - "Date": "\/Date(1552435200000+0000)\/", - "HasErrors": false, - "IsDiscounted": false, - "TotalDiscount": 0.00, - "SentToContact": false, - "Type": "PURCHASEORDER", - "CurrencyRate": 1.000000, - "CurrencyCode": "NZD", - "Contact": { - "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8", - "ContactStatus": "ACTIVE", - "Name": "Liam Gallagher", - "FirstName": "Liam", - "LastName": "Gallagher", - "EmailAddress": "liam@rockstar.com", - "BankAccountDetails": "", - "Addresses": [ - null, - { - "AddressType": "POBOX", - "City": "Anytown", - "Region": "NY", - "PostalCode": "10101", - "Country": "USA", - "AttentionTo": "" - } - ], - "Phones": [ - { - "PhoneType": "DEFAULT", - "PhoneNumber": "222-2222", - "PhoneAreaCode": "212", - "PhoneCountryCode": "" - }, - null, - { - "PhoneType": "FAX", - "PhoneNumber": "333-2233", - "PhoneAreaCode": "212", - "PhoneCountryCode": "" - }, - { - "PhoneType": "MOBILE", - "PhoneNumber": "444-3433", - "PhoneAreaCode": "212", - "PhoneCountryCode": "" - } - ], - "UpdatedDateUTC": "\/Date(1551747281053+0000)\/", - "ContactGroups": [ - { - "ContactGroupID": "17b44ed7-4389-4162-91cb-3dd5766e4e22", - "Name": "Oasis", - "Status": "ACTIVE", - "Contacts": [], - "HasValidationErrors": false - } - ], - "IsSupplier": true, - "IsCustomer": true, - "SalesTrackingCategories": [], - "PurchasesTrackingCategories": [], - "ContactPersons": [], - "HasValidationErrors": false - }, - "Status": "DRAFT", - "LineAmountTypes": "Exclusive", - "LineItems": [ + example: { + "Id": "aa2f9d23-fd76-4bee-9600-30c0f0f34036", + "Status": "OK", + "ProviderName": "Provider Name Example", + "DateTimeUTC": "\/Date(1552522946173)\/", + "PurchaseOrders": [ + { + "PurchaseOrderID": "56204648-8fbe-46f8-b09c-2125f7939533", + "PurchaseOrderNumber": "PO-0004", + "DateString": "2019-03-13T00:00:00", + "Date": "\/Date(1552435200000+0000)\/", + "HasErrors": false, + "IsDiscounted": false, + "TotalDiscount": 0.00, + "SentToContact": false, + "Type": "PURCHASEORDER", + "CurrencyRate": 1.000000, + "CurrencyCode": "NZD", + "Contact": { + "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8", + "ContactStatus": "ACTIVE", + "Name": "Liam Gallagher", + "FirstName": "Liam", + "LastName": "Gallagher", + "EmailAddress": "liam@rockstar.com", + "BankAccountDetails": "", + "Addresses": [ + null, { - "Description": "Foobar", - "UnitAmount": 20.0000, - "TaxType": "INPUT2", - "TaxAmount": 3.00, - "LineAmount": 20.00, - "AccountCode": "710", - "Tracking": [], - "Quantity": 1.0000, - "LineItemID": "792b7e40-b9f2-47f0-8624-b09f4b0166dd" + "AddressType": "POBOX", + "City": "Anytown", + "Region": "NY", + "PostalCode": "10101", + "Country": "USA", + "AttentionTo": "" } ], - "SubTotal": 20.00, - "TotalTax": 3.00, - "Total": 23.00, - "UpdatedDateUTC": "\/Date(1552522946077+0000)\/", - "StatusAttributeString": "ERROR", - "Warnings": [ + "Phones": [ { - "Message": "Only AUTHORISED and BILLED purchase orders may have SentToContact updated." + "PhoneType": "DEFAULT", + "PhoneNumber": "222-2222", + "PhoneAreaCode": "212", + "PhoneCountryCode": "" + }, + null, + { + "PhoneType": "FAX", + "PhoneNumber": "333-2233", + "PhoneAreaCode": "212", + "PhoneCountryCode": "" + }, + { + "PhoneType": "MOBILE", + "PhoneNumber": "444-3433", + "PhoneAreaCode": "212", + "PhoneCountryCode": "" } ], - "ValidationErrors": [ + "UpdatedDateUTC": "\/Date(1551747281053+0000)\/", + "ContactGroups": [ { - "Message": "Order number must be unique" + "ContactGroupID": "17b44ed7-4389-4162-91cb-3dd5766e4e22", + "Name": "Oasis", + "Status": "ACTIVE", + "Contacts": [], + "HasValidationErrors": false } - ] - } - ] - }' + ], + "IsSupplier": true, + "IsCustomer": true, + "SalesTrackingCategories": [], + "PurchasesTrackingCategories": [], + "ContactPersons": [], + "HasValidationErrors": false + }, + "Status": "DRAFT", + "LineAmountTypes": "Exclusive", + "LineItems": [ + { + "Description": "Foobar", + "UnitAmount": 20.0000, + "TaxType": "INPUT2", + "TaxAmount": 3.00, + "LineAmount": 20.00, + "AccountCode": "710", + "Tracking": [], + "Quantity": 1.0000, + "LineItemID": "792b7e40-b9f2-47f0-8624-b09f4b0166dd" + } + ], + "SubTotal": 20.00, + "TotalTax": 3.00, + "Total": 23.00, + "UpdatedDateUTC": "\/Date(1552522946077+0000)\/", + "StatusAttributeString": "ERROR", + "Warnings": [ + { + "Message": "Only AUTHORISED and BILLED purchase orders may have SentToContact updated." + } + ], + "ValidationErrors": [ + { + "Message": "Order number must be unique" + } + ] + } + ] + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -14999,7 +15007,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PurchaseOrders' - example: '{ + example: { "PurchaseOrders": [ { "Contact": { @@ -15016,7 +15024,7 @@ paths: "Date": "2019-03-13" } ] - }' + } '/PurchaseOrders/{PurchaseOrderID}/pdf': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -15057,7 +15065,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PurchaseOrders' - example: '{ + example: { "Id": "53a8c7a5-92e8-475b-a037-acf7c55c3afd", "Status": "OK", "ProviderName": "Provider Name Example", @@ -15181,7 +15189,7 @@ paths: ] } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -15227,7 +15235,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PurchaseOrders' - example: '{ + example: { "Id": "0e9bb3f8-d68b-4bb2-a54d-7da240a4f51a", "Status": "OK", "ProviderName": "Provider Name Example", @@ -15324,7 +15332,7 @@ paths: "UpdatedDateUTC": "\/Date(1552523976853+0000)\/" } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -15333,7 +15341,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PurchaseOrders' - example: '{ + example: { "PurchaseOrders": [ { "AttentionTo": "Peter Parker", @@ -15341,7 +15349,7 @@ paths: "Contact": {} } ] - }' + } '/PurchaseOrders/{PurchaseOrderNumber}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -15368,7 +15376,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PurchaseOrders' - example: '{ + example: { "Id": "53a8c7a5-92e8-475b-a037-acf7c55c3afd", "Status": "OK", "ProviderName": "Provider Name Example", @@ -15492,7 +15500,7 @@ paths: ] } ] - }' + } '/PurchaseOrders/{PurchaseOrderID}/History': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -15573,7 +15581,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "dfc29f55-8ddd-4921-a82c-bcc0798d207f", "Status": "OK", "ProviderName": "Xero API Partner", @@ -15601,7 +15609,7 @@ paths: "ContentLength": 146384 } ] - }' + } '/PurchaseOrders/{PurchaseOrderID}/Attachments/{AttachmentID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -15666,7 +15674,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "aeff9be0-54c2-45dd-8e3d-aa4f8af0fbd7", "Status": "OK", "ProviderName": "Xero API Partner", @@ -15680,7 +15688,7 @@ paths: "ContentLength": 98715 } ] - }' + } '400': description: Validation Error - some data was incorrect returns response of type Error content: @@ -15715,7 +15723,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "c728a4a4-179e-4bbd-a2d5-63e7f9ceba92", "Status": "OK", "ProviderName": "Xero API Partner", @@ -15729,7 +15737,7 @@ paths: "ContentLength": 82529 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -15825,7 +15833,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Quotes' - example: '{ + example: { "Id": "bb583e7e-9b6b-471e-88da-4cbfcfad7a57", "Status": "OK", "ProviderName": "Adams OAuth2 App", @@ -15880,7 +15888,7 @@ paths: "LineAmountTypes": "EXCLUSIVE" } ] - }' + } put: security: - OAuth2: [accounting.transactions] @@ -16018,7 +16026,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Quotes' - example: '{ + example: { "SummarizeErrors":false, "Id":"29571f5a-bf73-4bb6-9de5-86be44e6bf2e", "Status":"OK", @@ -16062,7 +16070,7 @@ paths: "StatusAttributeString":"OK" } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -16072,7 +16080,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Quotes' - example: '{ + example: { "Quotes": [ { "Contact": { @@ -16089,7 +16097,7 @@ paths: "Date": "2020-02-01" } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -16227,7 +16235,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Quotes' - example: '{ + example: { "SummarizeErrors":false, "Id":"b425754f-0512-481d-827b-c8958db7667e", "Status":"OK", @@ -16271,7 +16279,7 @@ paths: "StatusAttributeString":"OK" } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -16280,7 +16288,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Quotes' - example: '{ + example: { "Quotes": [ { "Contact": { @@ -16297,7 +16305,7 @@ paths: "Date": "2020-02-01" } ] - }' + } '/Quotes/{QuoteID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -16317,7 +16325,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Quotes' - example: '{ + example: { "SummarizeErrors":true, "Id":"e3626c45-77f1-4ab0-ba9b-3593c7bcd25c", "Status":"OK", @@ -16375,7 +16383,7 @@ paths: "LineAmountTypes":"EXCLUSIVE" } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -16458,7 +16466,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Quotes' - example: '{ + example: { "SummarizeErrors":true, "Id":"be4f43a7-ef02-497a-96c2-fc0bc047a82a", "Status":"OK", @@ -16500,7 +16508,7 @@ paths: "LineAmountTypes":"EXCLUSIVE" } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -16509,7 +16517,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Quotes' - example: '{ + example: { "Quotes": [ { "Reference": "I am an update", @@ -16519,7 +16527,7 @@ paths: "Date": "2020-02-01" } ] - }' + } '/Quotes/{QuoteID}/History': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -16621,7 +16629,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "439c1573-3cd8-4697-a9f6-81fa651ee8f3", "Status": "OK", "ProviderName": "Xero API Partner", @@ -16635,7 +16643,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '/Quotes/{QuoteID}/Attachments/{AttachmentID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -16700,7 +16708,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "c8d6413a-1da2-4faa-9848-21f60443e906", "Status": "OK", "ProviderName": "Xero API Partner", @@ -16714,7 +16722,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': description: Validation Error - some data was incorrect returns response of type Error content: @@ -16749,7 +16757,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "724cdff5-bcd1-4c5c-977e-e864c24258e0", "Status": "OK", "ProviderName": "Xero API Partner", @@ -16763,7 +16771,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -16810,7 +16818,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Receipts' - example: '{ + example: { "Id": "078b2a2c-902f-4154-8739-357ece5982e5", "Status": "OK", "ProviderName": "Provider Name Example", @@ -16856,7 +16864,7 @@ paths: "Warnings": [] } ] - }' + } put: security: - OAuth2: [accounting.transactions] @@ -17016,7 +17024,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Receipts' - example: '{ + example: { "Id": "35898898-5361-4b42-b6ca-9d2c584fc53d", "Status": "OK", "ProviderName": "Provider Name Example", @@ -17120,7 +17128,7 @@ paths: ] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -17130,7 +17138,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Receipts' - example: '{ + example: { "Receipts": [ { "Contact": { @@ -17153,7 +17161,7 @@ paths: "Status": "DRAFT" } ] - }' + } '/Receipts/{ReceiptID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -17174,7 +17182,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Receipts' - example: '{ + example: { "Id": "2c99af06-d278-4580-8c8c-463c806af5b6", "Status": "OK", "ProviderName": "Provider Name Example", @@ -17291,7 +17299,7 @@ paths: ] } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -17372,7 +17380,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Receipts' - example: '{ + example: { "Id": "05b76bf7-4734-4633-a399-7d569a6a25c6", "Status": "OK", "ProviderName": "Provider Name Example", @@ -17472,7 +17480,7 @@ paths: "ValidationErrors": [] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -17481,7 +17489,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Receipts' - example: '{ + example: { "Receipts": [ { "Lineitems": [], @@ -17491,7 +17499,7 @@ paths: "Reference": "Foobar" } ] - }' + } '/Receipts/{ReceiptID}/Attachments': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -17512,7 +17520,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "d379c04d-d3aa-4034-95b8-af69a449bd78", "Status": "OK", "ProviderName": "Provider Name Example", @@ -17526,7 +17534,7 @@ paths: "ContentLength": 495727 } ] - }' + } '/Receipts/{ReceiptID}/Attachments/{AttachmentID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -17591,7 +17599,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "aeca1ea8-8fd9-4757-96a6-397dc4957a69", "Status": "OK", "ProviderName": "Provider Name Example", @@ -17605,7 +17613,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -17636,7 +17644,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "01c9a720-b1f1-4477-8de8-ff46d945fd1d", "Status": "OK", "ProviderName": "Provider Name Example", @@ -17650,7 +17658,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -17723,7 +17731,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' - example: '{ + example: { "ErrorNumber": 10, "Type": "ValidationException", "Message": "A validation exception occurred", @@ -17739,7 +17747,7 @@ paths: ] } ] - }' + } requestBody: $ref: '#/components/requestBodies/historyRecords' /RepeatingInvoices: @@ -17776,7 +17784,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RepeatingInvoices' - example: '{ + example: { "Id": "b336833d-a3a8-4a67-ab4c-6280b3ad87b0", "Status": "OK", "ProviderName": "Provider Name Example", @@ -17832,7 +17840,7 @@ paths: "CurrencyCode": "NZD" } ] - }' + } put: security: - OAuth2: [accounting.transactions] @@ -17851,7 +17859,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RepeatingInvoices' - example: '{ + example: { "Id": "b336833d-a3a8-4a67-ab4c-6280b3ad87b0", "Status": "OK", "ProviderName": "Provider Name Example", @@ -17907,7 +17915,7 @@ paths: "CurrencyCode": "NZD" } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -17917,7 +17925,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RepeatingInvoices' - example: '{ + example: { "RepeatingInvoices": [ { "Schedule": { @@ -17956,7 +17964,7 @@ paths: "CurrencyCode": "NZD" } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -17975,7 +17983,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RepeatingInvoices' - example: '{ + example: { "Id": "b336833d-a3a8-4a67-ab4c-6280b3ad87b0", "Status": "OK", "ProviderName": "Provider Name Example", @@ -18031,7 +18039,7 @@ paths: "CurrencyCode": "NZD" } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -18041,7 +18049,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RepeatingInvoices' - example: '{ + example: { "RepeatingInvoices": [ { "Schedule": { @@ -18080,7 +18088,7 @@ paths: "CurrencyCode": "NZD" } ] - }' + } '/RepeatingInvoices/{RepeatingInvoiceID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -18100,7 +18108,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RepeatingInvoices' - example: '{ + example: { "Id": "d9ac3755-7b81-4e3a-bef0-fa8a4f171442", "Status": "OK", "ProviderName": "Provider Name Example", @@ -18175,7 +18183,7 @@ paths: "CurrencyCode": "NZD" } ] - }' + } post: security: - OAuth2: [accounting.transactions] @@ -18194,7 +18202,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RepeatingInvoices' - example: '{ + example: { "Id": "b336833d-a3a8-4a67-ab4c-6280b3ad87b0", "Status": "OK", "ProviderName": "Provider Name Example", @@ -18250,7 +18258,7 @@ paths: "CurrencyCode": "NZD" } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -18259,7 +18267,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RepeatingInvoices' - example: '{ + example: { "Schedule": { "Period": 1, "Unit": "MONTHLY", @@ -18307,7 +18315,7 @@ paths: "TotalTax": 750.00, "Total": 5750.00, "CurrencyCode": "NZD" - }' + } '/RepeatingInvoices/{RepeatingInvoiceID}/Attachments': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -18328,7 +18336,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "b88b807b-3087-474b-a4f9-d8f1b4f5a899", "Status": "OK", "ProviderName": "Provider Name Example", @@ -18356,7 +18364,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '/RepeatingInvoices/{RepeatingInvoiceID}/Attachments/{AttachmentID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -18421,7 +18429,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "61b24d5c-4d6e-468f-9de1-abbc234b239a", "Status": "OK", "ProviderName": "Provider Name Example", @@ -18435,7 +18443,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -18466,7 +18474,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Attachments' - example: '{ + example: { "Id": "219de8c0-ee70-48af-a000-594eba14b417", "Status": "OK", "ProviderName": "Provider Name Example", @@ -18480,7 +18488,7 @@ paths: "ContentLength": 2878711 } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -18576,7 +18584,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Reports' - example: '{ + example: { "Id": "8b474ddb-9ef4-457c-8640-1c0e3670ea0e", "Status": "OK", "ProviderName": "Java Public Example", @@ -18692,7 +18700,7 @@ paths: ] } ] - }' + } '/Reports/AgedPayablesByContact': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -18729,7 +18737,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ReportWithRows' - example: '{ + example: { "Id": "5a33f9d4-44a6-4467-a812-4f025506ee35", "Status": "OK", "ProviderName": "Java Public Example", @@ -18962,7 +18970,7 @@ paths: ] } ] - }' + } '/Reports/AgedReceivablesByContact': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -18999,7 +19007,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ReportWithRows' - example: '{ + example: { "Id": "b977b607-955d-47cb-92fd-7c29b3dd755c", "Status": "OK", "ProviderName": "Java Public Example", @@ -19309,7 +19317,7 @@ paths: ] } ] - }' + } '/Reports/BalanceSheet': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -19381,7 +19389,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ReportWithRows' - example: '{ + example: { "Id": "2ddba304-6ed3-4da4-b185-3b6289699653", "Status": "OK", "ProviderName": "Provider Name Example", @@ -20112,7 +20120,7 @@ paths: ] } ] - }' + } '/Reports/BankSummary': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -20133,7 +20141,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ReportWithRows' - example: '{ + example: { "Id": "ae58d0ec-9c5c-455f-b96e-690107579257", "Status": "OK", "ProviderName": "Java Public Example", @@ -20238,7 +20246,7 @@ paths: ] } ] - }' + } '/Reports/{ReportID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -20302,7 +20310,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ReportWithRows' - example: '{ + example: { "Id": "9f1e2722-0d98-4669-890f-f8f4217c968b", "Status": "OK", "ProviderName": "provider-name", @@ -20518,7 +20526,7 @@ paths: ] } ] - }' + } '/Reports/ExecutiveSummary': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -20544,7 +20552,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ReportWithRows' - example: '{ + example: { "Id": "068d3505-ac37-43f3-8135-f912a5963d8a", "Status": "OK", "ProviderName": "provider-name", @@ -21009,7 +21017,7 @@ paths: ] } ] - }' + } '/Reports': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -21140,7 +21148,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ReportWithRows' - example: '{ + example: { "Id": "0b3ee35e-b97c-4b3c-b7e2-9a465233e329", "Status": "OK", "ProviderName": "Java Public Example", @@ -22219,7 +22227,7 @@ paths: ] } ] - }' + } /Setup: parameters: - $ref: '#/components/parameters/requiredHeader' @@ -22332,7 +22340,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ImportSummaryObject' - example: '{ + example: { "Id": "80dcb65b-4d14-4350-84e6-1438a809244a", "Status": "OK", "ProviderName": "Java Public Example", @@ -22353,7 +22361,7 @@ paths: "Present": false } } - }' + } requestBody: required: true description: Object including an accounts array, a conversion balances array and a conversion date object in body of request @@ -22361,7 +22369,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Setup' - example: '{ + example: { "ConversionDate": {}, "ConversionBalances": [], "Accounts": [ @@ -22392,7 +22400,7 @@ paths: "ReportingCode": "LIA.CUR.PAY" } ] - }' + } /TaxRates: parameters: - $ref: '#/components/parameters/requiredHeader' @@ -22427,7 +22435,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TaxRates' - example: '{ + example: { "Id": "455d494d-9706-465b-b584-7086ca406b27", "Status": "OK", "ProviderName": "Provider Name Example", @@ -22539,7 +22547,7 @@ paths: ] } ] - }' + } put: security: - OAuth2: [accounting.settings] @@ -22624,7 +22632,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TaxRates' - example: '{ + example: { "Id": "9d2c5e56-fab4-450b-a5ff-d47409508eab", "Status": "OK", "ProviderName": "Provider Name Example", @@ -22652,7 +22660,7 @@ paths: ] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -22662,7 +22670,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TaxRates' - example: '{ + example: { "TaxRates": [ { "Name": "CA State Tax", @@ -22674,7 +22682,7 @@ paths: ] } ] - }' + } post: security: - OAuth2: [accounting.settings] @@ -22759,7 +22767,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TaxRates' - example: '{ + example: { "Id": "12f4c453-2e25-41aa-a52f-6faaf6c05832", "Status": "OK", "ProviderName": "Provider Name Example", @@ -22787,7 +22795,7 @@ paths: ] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -22796,7 +22804,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TaxRates' - example: '{ + example: { "TaxRates": [ { "Name": "State Tax NY", @@ -22810,7 +22818,7 @@ paths: "ReportTaxType": "INPUT" } ] - }' + } "/TaxRates/{TaxType}": parameters: - $ref: "#/components/parameters/requiredHeader" @@ -22830,7 +22838,7 @@ paths: application/json: schema: $ref: "#/components/schemas/TaxRates" - example: '{ + example: { "Id": "455d494d-9706-465b-b584-7086ca406b27", "Status": "OK", "ProviderName": "Xero API Partner", @@ -22858,7 +22866,7 @@ paths: ] } ] - }' + } /TrackingCategories: parameters: - $ref: '#/components/parameters/requiredHeader' @@ -22901,7 +22909,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TrackingCategories' - example: '{ + example: { "Id": "cec55068-8061-48e5-ac83-c77e7c54cf3d", "Status": "OK", "ProviderName": "Provider Name Example", @@ -22920,7 +22928,7 @@ paths: "Options": [] } ] - }' + } put: security: - OAuth2: [accounting.settings] @@ -22949,7 +22957,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TrackingCategories' - example: '{ + example: { "Id": "1a9f8e03-9916-4a42-93a9-e8fa4902d49c", "Status": "OK", "ProviderName": "Provider Name Example", @@ -22962,7 +22970,7 @@ paths: "Options": [] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -22972,7 +22980,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TrackingCategory' - example: '{ name: "FooBar" }' + example: { name: "FooBar" } '/TrackingCategories/{TrackingCategoryID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -22992,7 +23000,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TrackingCategories' - example: '{ + example: { "Id": "b75b8862-39c0-45a8-82b8-30ab4831996b", "Status": "OK", "ProviderName": "Provider Name Example", @@ -23005,7 +23013,7 @@ paths: "Options": [] } ] - }' + } post: security: - OAuth2: [accounting.settings] @@ -23035,7 +23043,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TrackingCategories' - example: '{ + example: { "Id": "55438774-f87d-4731-b586-799cf0f914ed", "Status": "OK", "ProviderName": "Provider Name Example", @@ -23048,7 +23056,7 @@ paths: "Options": [] } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -23057,7 +23065,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TrackingCategory' - example: '{ "Name": "Avengers" }' + example: { "Name": "Avengers" } delete: security: - OAuth2: [accounting.settings] @@ -23074,7 +23082,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TrackingCategories' - example: '{ + example: { "Id": "ca7f8145-c8a5-4366-a2fb-784edc0cfbb7", "Status": "OK", "ProviderName": "Provider Name Example", @@ -23087,7 +23095,7 @@ paths: "Options": [] } ] - }' + } '400': $ref: '#/components/responses/400Error' '/TrackingCategories/{TrackingCategoryID}/Options': @@ -23122,7 +23130,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TrackingOptions' - example: '{ + example: { "Id": "923be702-d124-4f5c-a568-760906538d8e", "Status": "OK", "ProviderName": "Provider Name Example", @@ -23138,7 +23146,7 @@ paths: "IsActive": true } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -23148,7 +23156,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TrackingOption' - example: '{ name: " Bar" }' + example: { name: " Bar" } '/TrackingCategories/{TrackingCategoryID}/Options/{TrackingOptionID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -23182,7 +23190,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TrackingOptions' - example: '{ + example: { "Id": "923be702-d124-4f5c-a568-760906538d8e", "Status": "OK", "ProviderName": "Provider Name Example", @@ -23198,7 +23206,7 @@ paths: "IsActive": true } ] - }' + } '400': $ref: '#/components/responses/400Error' requestBody: @@ -23207,7 +23215,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TrackingOption' - example: '{ name: "Vision" }' + example: { name: "Vision" } delete: security: - OAuth2: [accounting.settings] @@ -23225,7 +23233,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TrackingOptions' - example: '{ + example: { "Id": "d985866e-0831-418f-a07c-4d843ff66d25", "Status": "OK", "ProviderName": "Provider Name Example", @@ -23241,7 +23249,7 @@ paths: "IsActive": false } ] - }' + } '400': $ref: '#/components/responses/400Error' /Users: @@ -23275,7 +23283,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Users' - example: '{ + example: { "Id": "17932a4e-4948-4d50-8672-4ef0e1dd90c5", "Status": "OK", "ProviderName": "Provider Name Example", @@ -23300,7 +23308,7 @@ paths: "OrganisationRole": "FINANCIALADVISER" } ] - }' + } '/Users/{UserID}': parameters: - $ref: '#/components/parameters/requiredHeader' @@ -23320,7 +23328,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Users' - example: '{ + example: { "Id": "51250ce8-1b35-4ba4-b404-dc94ff75bd87", "Status": "OK", "ProviderName": "Provider Name Example", @@ -23336,7 +23344,7 @@ paths: "OrganisationRole": "FINANCIALADVISER" } ] - }' + } components: securitySchemes: OAuth2: @@ -23370,13 +23378,13 @@ components: application/json: schema: $ref: '#/components/schemas/HistoryRecords' - example: '{ + example: { "HistoryRecords": [ { "Details": "Hello World" } ] - }' + } parameters: requiredHeader: in: header @@ -23813,7 +23821,7 @@ components: application/json: schema: $ref: '#/components/schemas/HistoryRecords' - example: '{ + example: { "Id": "d7525479-3392-44c0-bb37-ff4a0b5df5bd", "Status": "OK", "ProviderName": "Xero API Partner", @@ -23826,14 +23834,14 @@ components: "ValidationErrors": [] } ] - }' + } HistoryRetrieved: description: Success - return response of HistoryRecords array of 0 to N HistoryRecord content: application/json: schema: $ref: '#/components/schemas/HistoryRecords' - example: '{ + example: { "Id": "cd54cc7b-b721-4207-b11d-7d13c7902f91", "Status": "OK", "ProviderName": "Xero API Partner", @@ -23854,7 +23862,7 @@ components: "Details": "Bank transfer from Business Wells Fargo to My Savings on November 12, 2016 for 20.00." } ] - }' + } schemas: AddressForOrganisation: externalDocs: @@ -27897,7 +27905,7 @@ components: LineAmountTypes: $ref: '#/components/schemas/QuoteLineAmountTypes' type: string - description: See Quote Line Amount Types + description: See Quote Line Amount Types StatusAttributeString: description: A string to indicate if a invoice status type: string