{ "openapi": "3.1.1", "info": { "title": "SUMIT API - Full", "version": "v1" }, "servers": [ { "url": "https://api.sumit.co.il" } ], "paths": { "/books/transactions/createbatch/": { "post": { "tags": [ "הנהלת חשבונות (Transactions)" ], "summary": "Creates a batch with transactions", "operationId": "BooksTransactionsCreateBatch", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Books_Transactions_CreateBatch_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Books_Transactions_CreateBatch_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Books_Transactions_CreateBatch_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Books_Transactions_CreateBatch_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Books_Transactions_CreateBatch_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Books_Transactions_CreateBatch_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Books_Transactions_CreateBatch_Response" } } } } } } }, "/accounting/customers/create/": { "post": { "tags": [ "Accounting (Customers)" ], "summary": "Create customer or find existing customer according to SearchMode", "operationId": "AccountingCustomersCreate", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_Create_Request" } ] }, "example": { "Details": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": null, "Name": "Danny Dean", "Phone": "050-1234567", "EmailAddress": "danny@dean.com", "City": null, "Address": null, "ZipCode": null, "CompanyNumber": "514000123", "ID": null, "Folder": null, "Properties": null }, "Credentials": { "CompanyID": 12345678, "APIKey": "nkVJGs4017TLaxwjTBgdY8llbvtISGuj9YToQNvdwb68ImlSPr" }, "ResponseLanguage": null } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_Create_Request" } ] }, "example": { "Details": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": null, "Name": "Danny Dean", "Phone": "050-1234567", "EmailAddress": "danny@dean.com", "City": null, "Address": null, "ZipCode": null, "CompanyNumber": "514000123", "ID": null, "Folder": null, "Properties": null }, "Credentials": { "CompanyID": 12345678, "APIKey": "nkVJGs4017TLaxwjTBgdY8llbvtISGuj9YToQNvdwb68ImlSPr" }, "ResponseLanguage": null } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_Create_Request" } ] }, "example": { "Details": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": null, "Name": "Danny Dean", "Phone": "050-1234567", "EmailAddress": "danny@dean.com", "City": null, "Address": null, "ZipCode": null, "CompanyNumber": "514000123", "ID": null, "Folder": null, "Properties": null }, "Credentials": { "CompanyID": 12345678, "APIKey": "nkVJGs4017TLaxwjTBgdY8llbvtISGuj9YToQNvdwb68ImlSPr" }, "ResponseLanguage": null } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_Create_Request" } ] }, "example": { "Details": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": null, "Name": "Danny Dean", "Phone": "050-1234567", "EmailAddress": "danny@dean.com", "City": null, "Address": null, "ZipCode": null, "CompanyNumber": "514000123", "ID": null, "Folder": null, "Properties": null }, "Credentials": { "CompanyID": 12345678, "APIKey": "nkVJGs4017TLaxwjTBgdY8llbvtISGuj9YToQNvdwb68ImlSPr" }, "ResponseLanguage": null } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Customers_Create_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Customers_Create_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Customers_Create_Response" } } } } } } }, "/accounting/customers/update/": { "post": { "tags": [ "Accounting (Customers)" ], "summary": "Update customer or find existing customer according to SearchMode", "operationId": "AccountingCustomersUpdate", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_Create_Request" } ] }, "example": { "Details": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": null, "Name": "Danny Dean", "Phone": "050-1234567", "EmailAddress": "danny@dean.com", "City": null, "Address": null, "ZipCode": null, "CompanyNumber": "514000123", "ID": null, "Folder": null, "Properties": null }, "Credentials": { "CompanyID": 12345678, "APIKey": "a7a6QSkjV18OfUg0eoLcX8DA3rdbm6W0qwkrnNHmHa4Gimkwcs" }, "ResponseLanguage": null } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_Create_Request" } ] }, "example": { "Details": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": null, "Name": "Danny Dean", "Phone": "050-1234567", "EmailAddress": "danny@dean.com", "City": null, "Address": null, "ZipCode": null, "CompanyNumber": "514000123", "ID": null, "Folder": null, "Properties": null }, "Credentials": { "CompanyID": 12345678, "APIKey": "a7a6QSkjV18OfUg0eoLcX8DA3rdbm6W0qwkrnNHmHa4Gimkwcs" }, "ResponseLanguage": null } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_Create_Request" } ] }, "example": { "Details": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": null, "Name": "Danny Dean", "Phone": "050-1234567", "EmailAddress": "danny@dean.com", "City": null, "Address": null, "ZipCode": null, "CompanyNumber": "514000123", "ID": null, "Folder": null, "Properties": null }, "Credentials": { "CompanyID": 12345678, "APIKey": "a7a6QSkjV18OfUg0eoLcX8DA3rdbm6W0qwkrnNHmHa4Gimkwcs" }, "ResponseLanguage": null } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_Create_Request" } ] }, "example": { "Details": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": null, "Name": "Danny Dean", "Phone": "050-1234567", "EmailAddress": "danny@dean.com", "City": null, "Address": null, "ZipCode": null, "CompanyNumber": "514000123", "ID": null, "Folder": null, "Properties": null }, "Credentials": { "CompanyID": 12345678, "APIKey": "a7a6QSkjV18OfUg0eoLcX8DA3rdbm6W0qwkrnNHmHa4Gimkwcs" }, "ResponseLanguage": null } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Customers_Update_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Customers_Update_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Customers_Update_Response" } } } } } } }, "/accounting/customers/getdetailsurl/": { "post": { "tags": [ "Accounting (Customers)" ], "summary": "Gets customer details page", "operationId": "AccountingCustomersGetDetailsURL", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_GetDetailsURL_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_GetDetailsURL_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_GetDetailsURL_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_GetDetailsURL_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Customers_GetDetailsURL_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Customers_GetDetailsURL_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Customers_GetDetailsURL_Response" } } } } } } }, "/accounting/customers/createremark/": { "post": { "tags": [ "Accounting (Customers)" ], "summary": "Create remark to an existing customer", "operationId": "AccountingCustomersCreateRemark", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_CreateRemark_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_CreateRemark_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_CreateRemark_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_CreateRemark_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Customers_CreateRemark_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Customers_CreateRemark_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Customers_CreateRemark_Response" } } } } } } }, "/accounting/documents/send/": { "post": { "tags": [ "Accounting (Documents)" ], "summary": "Send document by email", "description": "Documents can be located either using DocumentID (EntityID), or a combination of DocumentType and DocumentNumber.", "operationId": "AccountingDocumentsSend", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_Send_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_Send_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_Send_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_Send_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Core_APIEmptyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Core_APIEmptyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Core_APIEmptyResponse" } } } } } } }, "/accounting/documents/getpdf/": { "post": { "tags": [ "Accounting (Documents)" ], "summary": "Get document PDF", "description": "Documents can be located either using DocumentID, or a combination of DocumentType and DocumentNumber.", "operationId": "AccountingDocumentsGetPDF", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetPDF_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetPDF_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetPDF_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetPDF_Request" } ] } } } }, "responses": { "200": { "description": "OK" } } } }, "/accounting/documents/getdetails/": { "post": { "tags": [ "Accounting (Documents)" ], "summary": "Get document details", "description": "Documents can be located either using DocumentID, or a combination of both DocumentType and DocumentNumber.", "operationId": "AccountingDocumentsGetDetails", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetDetails_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetDetails_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetDetails_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetDetails_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_GetDetails_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_GetDetails_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_GetDetails_Response" } } } } } } }, "/accounting/documents/create/": { "post": { "tags": [ "Accounting (Documents)" ], "summary": "Create document", "description": "Creates an invoice, receipt, donation receipt, price quotation or any other income accounting document.", "operationId": "AccountingDocumentsCreate", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_Create_Request" } ] }, "example": { "Details": { "IsDraft": null, "Date": null, "Customer": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": 0, "Name": "Danny Dean", "Phone": null, "EmailAddress": "danny@dean.com", "City": null, "Address": null, "ZipCode": null, "CompanyNumber": null, "ID": null, "Folder": null, "Properties": null }, "SendByEmail": { "EmailAddress": "danny@dean.com", "Original": true, "SendAsPaymentRequest": false }, "Language": null, "Currency": null, "Type": 1, "Description": null, "ExternalReference": null, "OpeningTextHTML": null, "OpeningText": null, "ClosingTextHTML": null, "ClosingText": null, "DueDate": null, "PaymentRequestText": null, "Properties": null }, "Items": [ { "Quantity": 2.0, "UnitPrice": 50.0, "TotalPrice": 100.0, "DocumentCurrency_UnitPrice": null, "DocumentCurrency_TotalPrice": null, "VAT": null, "DocumentCurrency_VAT": null, "Item": { "ID": null, "Name": "My Product", "Description": null, "Price": null, "Currency": null, "Cost": null, "ExternalIdentifier": null, "SKU": null, "SearchMode": 0, "Properties": null }, "Description": null } ], "Payments": [ { "Amount": 100.0, "DocumentCurrency_Amount": null, "Type": null, "PaymentElementID": null, "Details_General": null, "Details_Cash": null, "Details_BankTransfer": null, "Details_Cheque": null, "Details_CreditCard": { "CardBrand": null, "Last4Digits": "1234", "FirstPayment": null, "EachPayment": null, "Payments": null }, "Details_Other": null, "Details_Digital": null, "Details_TaxWithholding": null } ], "VATIncluded": true, "VATPerItem": null, "VATRate": null, "OriginalDocumentID": null, "Credentials": { "CompanyID": 12345678, "APIKey": "rcfFJ8RT8aa5v2IsuJaIIjIwy9pNAeRHlfS1JJN7Ay0gX8UU3k" }, "ResponseLanguage": null } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_Create_Request" } ] }, "example": { "Details": { "IsDraft": null, "Date": null, "Customer": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": 0, "Name": "Danny Dean", "Phone": null, "EmailAddress": "danny@dean.com", "City": null, "Address": null, "ZipCode": null, "CompanyNumber": null, "ID": null, "Folder": null, "Properties": null }, "SendByEmail": { "EmailAddress": "danny@dean.com", "Original": true, "SendAsPaymentRequest": false }, "Language": null, "Currency": null, "Type": 1, "Description": null, "ExternalReference": null, "OpeningTextHTML": null, "OpeningText": null, "ClosingTextHTML": null, "ClosingText": null, "DueDate": null, "PaymentRequestText": null, "Properties": null }, "Items": [ { "Quantity": 2.0, "UnitPrice": 50.0, "TotalPrice": 100.0, "DocumentCurrency_UnitPrice": null, "DocumentCurrency_TotalPrice": null, "VAT": null, "DocumentCurrency_VAT": null, "Item": { "ID": null, "Name": "My Product", "Description": null, "Price": null, "Currency": null, "Cost": null, "ExternalIdentifier": null, "SKU": null, "SearchMode": 0, "Properties": null }, "Description": null } ], "Payments": [ { "Amount": 100.0, "DocumentCurrency_Amount": null, "Type": null, "PaymentElementID": null, "Details_General": null, "Details_Cash": null, "Details_BankTransfer": null, "Details_Cheque": null, "Details_CreditCard": { "CardBrand": null, "Last4Digits": "1234", "FirstPayment": null, "EachPayment": null, "Payments": null }, "Details_Other": null, "Details_Digital": null, "Details_TaxWithholding": null } ], "VATIncluded": true, "VATPerItem": null, "VATRate": null, "OriginalDocumentID": null, "Credentials": { "CompanyID": 12345678, "APIKey": "rcfFJ8RT8aa5v2IsuJaIIjIwy9pNAeRHlfS1JJN7Ay0gX8UU3k" }, "ResponseLanguage": null } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_Create_Request" } ] }, "example": { "Details": { "IsDraft": null, "Date": null, "Customer": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": 0, "Name": "Danny Dean", "Phone": null, "EmailAddress": "danny@dean.com", "City": null, "Address": null, "ZipCode": null, "CompanyNumber": null, "ID": null, "Folder": null, "Properties": null }, "SendByEmail": { "EmailAddress": "danny@dean.com", "Original": true, "SendAsPaymentRequest": false }, "Language": null, "Currency": null, "Type": 1, "Description": null, "ExternalReference": null, "OpeningTextHTML": null, "OpeningText": null, "ClosingTextHTML": null, "ClosingText": null, "DueDate": null, "PaymentRequestText": null, "Properties": null }, "Items": [ { "Quantity": 2.0, "UnitPrice": 50.0, "TotalPrice": 100.0, "DocumentCurrency_UnitPrice": null, "DocumentCurrency_TotalPrice": null, "VAT": null, "DocumentCurrency_VAT": null, "Item": { "ID": null, "Name": "My Product", "Description": null, "Price": null, "Currency": null, "Cost": null, "ExternalIdentifier": null, "SKU": null, "SearchMode": 0, "Properties": null }, "Description": null } ], "Payments": [ { "Amount": 100.0, "DocumentCurrency_Amount": null, "Type": null, "PaymentElementID": null, "Details_General": null, "Details_Cash": null, "Details_BankTransfer": null, "Details_Cheque": null, "Details_CreditCard": { "CardBrand": null, "Last4Digits": "1234", "FirstPayment": null, "EachPayment": null, "Payments": null }, "Details_Other": null, "Details_Digital": null, "Details_TaxWithholding": null } ], "VATIncluded": true, "VATPerItem": null, "VATRate": null, "OriginalDocumentID": null, "Credentials": { "CompanyID": 12345678, "APIKey": "rcfFJ8RT8aa5v2IsuJaIIjIwy9pNAeRHlfS1JJN7Ay0gX8UU3k" }, "ResponseLanguage": null } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_Create_Request" } ] }, "example": { "Details": { "IsDraft": null, "Date": null, "Customer": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": 0, "Name": "Danny Dean", "Phone": null, "EmailAddress": "danny@dean.com", "City": null, "Address": null, "ZipCode": null, "CompanyNumber": null, "ID": null, "Folder": null, "Properties": null }, "SendByEmail": { "EmailAddress": "danny@dean.com", "Original": true, "SendAsPaymentRequest": false }, "Language": null, "Currency": null, "Type": 1, "Description": null, "ExternalReference": null, "OpeningTextHTML": null, "OpeningText": null, "ClosingTextHTML": null, "ClosingText": null, "DueDate": null, "PaymentRequestText": null, "Properties": null }, "Items": [ { "Quantity": 2.0, "UnitPrice": 50.0, "TotalPrice": 100.0, "DocumentCurrency_UnitPrice": null, "DocumentCurrency_TotalPrice": null, "VAT": null, "DocumentCurrency_VAT": null, "Item": { "ID": null, "Name": "My Product", "Description": null, "Price": null, "Currency": null, "Cost": null, "ExternalIdentifier": null, "SKU": null, "SearchMode": 0, "Properties": null }, "Description": null } ], "Payments": [ { "Amount": 100.0, "DocumentCurrency_Amount": null, "Type": null, "PaymentElementID": null, "Details_General": null, "Details_Cash": null, "Details_BankTransfer": null, "Details_Cheque": null, "Details_CreditCard": { "CardBrand": null, "Last4Digits": "1234", "FirstPayment": null, "EachPayment": null, "Payments": null }, "Details_Other": null, "Details_Digital": null, "Details_TaxWithholding": null } ], "VATIncluded": true, "VATPerItem": null, "VATRate": null, "OriginalDocumentID": null, "Credentials": { "CompanyID": 12345678, "APIKey": "rcfFJ8RT8aa5v2IsuJaIIjIwy9pNAeRHlfS1JJN7Ay0gX8UU3k" }, "ResponseLanguage": null } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_Create_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_Create_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_Create_Response" } } } } } } }, "/accounting/documents/addexpense/": { "post": { "tags": [ "Accounting (Documents)" ], "summary": "Add expense", "operationId": "AccountingDocumentsAddExpense", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_AddExpense_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_AddExpense_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_AddExpense_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_AddExpense_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_AddExpense_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_AddExpense_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_AddExpense_Response" } } } } } } }, "/accounting/documents/cancel/": { "post": { "tags": [ "Accounting (Documents)" ], "summary": "Cancel existing document", "operationId": "AccountingDocumentsCancel", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_Cancel_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_Cancel_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_Cancel_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_Cancel_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_Cancel_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_Cancel_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_Cancel_Response" } } } } } } }, "/accounting/documents/movetobooks/": { "post": { "tags": [ "Accounting (Documents)" ], "summary": "Move document to books (Finalize a draft document).", "operationId": "AccountingDocumentsMoveToBooks", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_MoveToBooks_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_MoveToBooks_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_MoveToBooks_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_MoveToBooks_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_MoveToBooks_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_MoveToBooks_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_MoveToBooks_Response" } } } } } } }, "/accounting/documents/getdebt/": { "post": { "tags": [ "Accounting (Documents)" ], "summary": "Get customer debt", "operationId": "AccountingDocumentsGetDebt", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetDebt_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetDebt_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetDebt_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetDebt_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_GetDebt_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_GetDebt_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_GetDebt_Response" } } } } } } }, "/accounting/documents/getdebtreport/": { "post": { "tags": [ "Accounting (Documents)" ], "summary": "Get customers debt report", "operationId": "AccountingDocumentsGetDebtReport", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetDebtReport_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetDebtReport_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetDebtReport_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetDebtReport_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_GetDebtReport_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_GetDebtReport_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_GetDebtReport_Response" } } } } } } }, "/accounting/documents/list/": { "post": { "tags": [ "Accounting (Documents)" ], "summary": "List documents", "operationId": "AccountingDocumentsList", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_List_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_List_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_List_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_List_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_List_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_List_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_Documents_List_Response" } } } } } } }, "/accounting/general/verifybankaccount/": { "post": { "tags": [ "Accounting (General)" ], "summary": "Verify bank account details", "operationId": "AccountingGeneralVerifyBankAccount", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_VerifyBankAccount_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_VerifyBankAccount_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_VerifyBankAccount_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_VerifyBankAccount_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_General_VerifyBankAccount_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_General_VerifyBankAccount_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_General_VerifyBankAccount_Response" } } } } } } }, "/accounting/general/getvatrate/": { "post": { "tags": [ "Accounting (General)" ], "summary": "Get VAT rate by date", "operationId": "AccountingGeneralGetVATRate", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_GetVATRate_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_GetVATRate_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_GetVATRate_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_GetVATRate_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_General_GetVATRate_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_General_GetVATRate_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_General_GetVATRate_Response" } } } } } } }, "/accounting/general/getexchangerate/": { "post": { "tags": [ "Accounting (General)" ], "summary": "Get foreign currency exchange rate", "operationId": "AccountingGeneralGetExchangeRate", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_GetExchangeRate_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_GetExchangeRate_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_GetExchangeRate_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_GetExchangeRate_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_General_GetExchangeRate_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_General_GetExchangeRate_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_General_GetExchangeRate_Response" } } } } } } }, "/accounting/general/updatesettings/": { "post": { "tags": [ "Accounting (General)" ], "summary": "Update accounting application settings", "operationId": "AccountingGeneralUpdateSettings", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_UpdateSettings_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_UpdateSettings_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_UpdateSettings_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_UpdateSettings_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_General_UpdateSettings_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_General_UpdateSettings_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_General_UpdateSettings_Response" } } } } } } }, "/accounting/general/getnextdocumentnumber/": { "post": { "tags": [ "Accounting (General)" ], "summary": "Gets the next document number of a document type.", "operationId": "AccountingGeneralGetNextDocumentNumber", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_GetNextDocumentNumber_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_GetNextDocumentNumber_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_GetNextDocumentNumber_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_GetNextDocumentNumber_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_General_GetNextDocumentNumber_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_General_GetNextDocumentNumber_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_General_GetNextDocumentNumber_Response" } } } } } } }, "/accounting/general/setnextdocumentnumber/": { "post": { "tags": [ "Accounting (General)" ], "summary": "Sets the next document number for a document type.", "operationId": "AccountingGeneralSetNextDocumentNumber", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_SetNextDocumentNumber_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_SetNextDocumentNumber_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_SetNextDocumentNumber_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_General_SetNextDocumentNumber_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_General_SetNextDocumentNumber_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_General_SetNextDocumentNumber_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_General_SetNextDocumentNumber_Response" } } } } } } }, "/accounting/incomeitems/create/": { "post": { "tags": [ "Accounting (IncomeItems)" ], "summary": "Create income item", "operationId": "AccountingIncomeItemsCreate", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_IncomeItems_Create_Request" } ] }, "example": { "IncomeItem": { "ID": null, "Name": "My Item", "Description": null, "Price": 500.0, "Currency": null, "Cost": 200.0, "ExternalIdentifier": null, "SKU": null, "SearchMode": null, "Properties": null }, "Credentials": { "CompanyID": 12345678, "APIKey": "vWACRsU4cmGaDen6VyyZEuXcYPJlNZdgTeBiZ8rdZopKNgLInE" }, "ResponseLanguage": null } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_IncomeItems_Create_Request" } ] }, "example": { "IncomeItem": { "ID": null, "Name": "My Item", "Description": null, "Price": 500.0, "Currency": null, "Cost": 200.0, "ExternalIdentifier": null, "SKU": null, "SearchMode": null, "Properties": null }, "Credentials": { "CompanyID": 12345678, "APIKey": "vWACRsU4cmGaDen6VyyZEuXcYPJlNZdgTeBiZ8rdZopKNgLInE" }, "ResponseLanguage": null } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_IncomeItems_Create_Request" } ] }, "example": { "IncomeItem": { "ID": null, "Name": "My Item", "Description": null, "Price": 500.0, "Currency": null, "Cost": 200.0, "ExternalIdentifier": null, "SKU": null, "SearchMode": null, "Properties": null }, "Credentials": { "CompanyID": 12345678, "APIKey": "vWACRsU4cmGaDen6VyyZEuXcYPJlNZdgTeBiZ8rdZopKNgLInE" }, "ResponseLanguage": null } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_IncomeItems_Create_Request" } ] }, "example": { "IncomeItem": { "ID": null, "Name": "My Item", "Description": null, "Price": 500.0, "Currency": null, "Cost": 200.0, "ExternalIdentifier": null, "SKU": null, "SearchMode": null, "Properties": null }, "Credentials": { "CompanyID": 12345678, "APIKey": "vWACRsU4cmGaDen6VyyZEuXcYPJlNZdgTeBiZ8rdZopKNgLInE" }, "ResponseLanguage": null } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_IncomeItems_Create_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_IncomeItems_Create_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_IncomeItems_Create_Response" } } } } } } }, "/accounting/incomeitems/list/": { "post": { "tags": [ "Accounting (IncomeItems)" ], "summary": "List income items", "description": "This API is currently marked as alpha, and may change in the future without notice.", "operationId": "AccountingIncomeItemsList", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_IncomeItems_List_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_IncomeItems_List_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_IncomeItems_List_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Accounting_IncomeItems_List_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Accounting_IncomeItems_List_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_IncomeItems_List_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Accounting_IncomeItems_List_Response" } } } } } } }, "/creditguy/billing/load/": { "post": { "tags": [ "Credit card terminal (Billing)" ], "summary": "Load billing transactions", "operationId": "CreditGuyBillingLoad", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Billing_Load_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Billing_Load_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Billing_Load_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Billing_Load_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Billing_Load_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Billing_Load_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Billing_Load_Response" } } } } } } }, "/creditguy/billing/process/": { "post": { "tags": [ "Credit card terminal (Billing)" ], "summary": "Process loaded billing transactions.", "description": "Please note, once process has started, it can't be stopped, and no additional transactions can be loaded.", "operationId": "CreditGuyBillingProcess", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Billing_Process_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Billing_Process_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Billing_Process_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Billing_Process_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Billing_Process_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Billing_Process_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Billing_Process_Response" } } } } } } }, "/creditguy/billing/getstatus/": { "post": { "tags": [ "Credit card terminal (Billing)" ], "summary": "Get billing process status", "operationId": "CreditGuyBillingGetStatus", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Billing_GetStatus_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Billing_GetStatus_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Billing_GetStatus_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Billing_GetStatus_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Billing_GetStatus_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Billing_GetStatus_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Billing_GetStatus_Response" } } } } } } }, "/creditguy/gateway/transaction/": { "post": { "tags": [ "Credit card terminal (Gateway)" ], "summary": "Credit card transaction", "description": "This method should be used in rare occasions.\nFor common use scenarios, refer to \"Payments -> Charge customer\" method.", "operationId": "CreditGuyGatewayTransaction", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_Transaction_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_Transaction_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_Transaction_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_Transaction_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Gateway_Transaction_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Gateway_Transaction_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Gateway_Transaction_Response" } } } } } } }, "/creditguy/gateway/gettransaction/": { "post": { "tags": [ "Credit card terminal (Gateway)" ], "summary": "Get existing transaction details", "operationId": "CreditGuyGatewayGetTransaction", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_GetTransaction_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_GetTransaction_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_GetTransaction_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_GetTransaction_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Gateway_GetTransaction_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Gateway_GetTransaction_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Gateway_GetTransaction_Response" } } } } } } }, "/creditguy/gateway/beginredirect/": { "post": { "tags": [ "Credit card terminal (Gateway)" ], "summary": "Begin redirect for transaction", "operationId": "CreditGuyGatewayBeginRedirect", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_BeginRedirect_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_BeginRedirect_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_BeginRedirect_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_BeginRedirect_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Gateway_BeginRedirect_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Gateway_BeginRedirect_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Gateway_BeginRedirect_Response" } } } } } } }, "/creditguy/gateway/getreferencenumbers/": { "post": { "tags": [ "Credit card terminal (Gateway)" ], "summary": "Get reference numbers for existing transactions", "operationId": "CreditGuyGatewayGetReferenceNumbers", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_GetReferenceNumbers_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_GetReferenceNumbers_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_GetReferenceNumbers_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_GetReferenceNumbers_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Gateway_GetReferenceNumbers_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Gateway_GetReferenceNumbers_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Gateway_GetReferenceNumbers_Response" } } } } } } }, "/creditguy/vault/tokenize/": { "post": { "tags": [ "Credit card terminal (Vault)" ], "summary": "Tokenize card (card number->token)", "operationId": "CreditGuyVaultTokenize", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Vault_Tokenize_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Vault_Tokenize_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Vault_Tokenize_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Vault_Tokenize_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Vault_Tokenize_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Vault_Tokenize_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Vault_Tokenize_Response" } } } } } } }, "/creditguy/vault/tokenizesingleuse/": { "post": { "tags": [ "Credit card terminal (Vault)" ], "summary": "Tokenize payment details (Card Number, Expiration, CVV, CitizenID) for single usage.", "description": "Used primarily by the Payments JavaScript API.", "operationId": "CreditGuyVaultTokenizeSingleUse", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "CardNumber", "ExpirationMonth", "ExpirationYear" ], "type": "object", "properties": { "CardNumber": { "type": "string", "description": "Full card number to tokenize" }, "ExpirationMonth": { "type": "integer", "description": "Card expiration month (1-12).", "format": "int32" }, "ExpirationYear": { "type": "integer", "description": "Card expiration year (4 digits).", "format": "int32" }, "CVV": { "type": "string", "description": "Card CVV/CVV2." }, "CitizenID": { "type": "string", "description": "Israel Citizen ID / Passport Number." }, "Credentials.CompanyID": { "type": "integer", "description": "Company identifier", "format": "int64" }, "Credentials.APIPublicKey": { "type": "string", "description": "API public key" }, "ResponseLanguage": { "type": "string", "description": "This property is obsolete. Please refer to the \"Content-Language\" header instead.", "deprecated": true } } }, "encoding": { "CardNumber": { "style": "form" }, "ExpirationMonth": { "style": "form" }, "ExpirationYear": { "style": "form" }, "CVV": { "style": "form" }, "CitizenID": { "style": "form" }, "Credentials.CompanyID": { "style": "form" }, "Credentials.APIPublicKey": { "style": "form" }, "ResponseLanguage": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Vault_TokenizeSingleUse_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Vault_TokenizeSingleUse_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Vault_TokenizeSingleUse_Response" } } } } } } }, "/creditguy/vault/tokenizesingleusejson/": { "post": { "tags": [ "Credit card terminal (Vault)" ], "summary": "Tokenize payment details (Card Number, Expiration, CVV, CitizenID) for single usage.", "description": "Used primarily by the Payments JavaScript API.", "operationId": "CreditGuyVaultTokenizeSingleUseJSON", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Vault_TokenizeSingleUse_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Vault_TokenizeSingleUse_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Vault_TokenizeSingleUse_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Vault_TokenizeSingleUse_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Vault_TokenizeSingleUse_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Vault_TokenizeSingleUse_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_CreditGuy_Vault_TokenizeSingleUse_Response" } } } } } } }, "/crm/data/createentity/": { "post": { "tags": [ "CRM (Data)" ], "summary": "Create entity", "operationId": "CrmDataCreateentity", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_CreateEntity_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_CreateEntity_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_CreateEntity_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_CreateEntity_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.DataController_Data_CreateEntity_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.DataController_Data_CreateEntity_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.DataController_Data_CreateEntity_Response" } } } } } } }, "/crm/data/updateentity/": { "post": { "tags": [ "CRM (Data)" ], "summary": "Update entity", "operationId": "CrmDataUpdateentity", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_UpdateEntity_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_UpdateEntity_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_UpdateEntity_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_UpdateEntity_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.DataController_Data_UpdateEntity_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.DataController_Data_UpdateEntity_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.DataController_Data_UpdateEntity_Response" } } } } } } }, "/crm/data/archiveentity/": { "post": { "tags": [ "CRM (Data)" ], "summary": "Archive entity", "operationId": "CrmDataArchiveentity", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_ArchiveEntity_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_ArchiveEntity_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_ArchiveEntity_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_ArchiveEntity_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Core_APIEmptyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Core_APIEmptyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Core_APIEmptyResponse" } } } } } } }, "/crm/data/deleteentity/": { "post": { "tags": [ "CRM (Data)" ], "summary": "Delete entity", "operationId": "CrmDataDeleteentity", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_DeleteEntity_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_DeleteEntity_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_DeleteEntity_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_DeleteEntity_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Core_APIEmptyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Core_APIEmptyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Core_APIEmptyResponse" } } } } } } }, "/crm/data/listentities/": { "post": { "tags": [ "CRM (Data)" ], "summary": "List entities", "operationId": "CrmDataListentities", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_ListEntities_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_ListEntities_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_ListEntities_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_ListEntities_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.DataController_Data_ListEntities_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.DataController_Data_ListEntities_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.DataController_Data_ListEntities_Response" } } } } } } }, "/crm/data/getentity/": { "post": { "tags": [ "CRM (Data)" ], "summary": "Get entity", "operationId": "CrmDataGetentity", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntity_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntity_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntity_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntity_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntity_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntity_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntity_Response" } } } } } } }, "/crm/data/countentityusage/": { "post": { "tags": [ "CRM (Data)" ], "summary": "Count entity usage", "operationId": "CrmDataCountentityusage", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_CountEntityUsage_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_CountEntityUsage_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_CountEntityUsage_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_CountEntityUsage_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_System.Int64" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_System.Int64" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_System.Int64" } } } } } } }, "/crm/data/getentityprinthtml/": { "post": { "tags": [ "CRM (Data)" ], "summary": "Get entity HTML contents for print", "operationId": "CrmDataGetentityprinthtml", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntityPrintHTML_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntityPrintHTML_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntityPrintHTML_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntityPrintHTML_Request" } ] } } } }, "responses": { "200": { "description": "OK" } } } }, "/crm/data/getentitieshtml/": { "post": { "tags": [ "CRM (Data)" ], "summary": "Get entities HTML contents for print", "operationId": "CrmDataGetentitieshtml", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntitiesHTML_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntitiesHTML_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntitiesHTML_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntitiesHTML_Request" } ] } } } }, "responses": { "200": { "description": "OK" } } } }, "/crm/schema/getfolder/": { "post": { "tags": [ "CRM (Schema)" ], "summary": "Get folder details", "operationId": "CrmSchemaGetfolder", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_GetFolder_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_GetFolder_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_GetFolder_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_GetFolder_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_GetFolder_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_GetFolder_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_GetFolder_Response" } } } } } } }, "/crm/schema/listfolders/": { "post": { "tags": [ "CRM (Schema)" ], "summary": "List folders", "operationId": "CrmSchemaListfolders", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_ListFolders_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_ListFolders_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_ListFolders_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_ListFolders_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_ListFolders_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_ListFolders_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_ListFolders_Response" } } } } } } }, "/crm/views/listviews/": { "post": { "tags": [ "CRM (Views)" ], "summary": "List views", "operationId": "CrmViewsListviews", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.ViewsController_Views_ListViews_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.ViewsController_Views_ListViews_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.ViewsController_Views_ListViews_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.ViewsController_Views_ListViews_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.ViewsController_Views_ListViews_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.ViewsController_Views_ListViews_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.CRM.MVC.API.ViewsController_Views_ListViews_Response" } } } } } } }, "/customerservice/tickets/create/": { "post": { "tags": [ "Customer service (Tickets)" ], "operationId": "CustomerServiceTicketsCreate", "parameters": [ { "name": "Subject", "in": "query", "schema": { "type": "string" } }, { "name": "ContentsHTML", "in": "query", "schema": { "type": "string" } }, { "name": "ContentsText", "in": "query", "schema": { "type": "string" } }, { "name": "TicketTypeID", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "CustomerID", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "CustomerEmailAddress", "in": "query", "schema": { "type": "string" } }, { "name": "CustomerName", "in": "query", "schema": { "type": "string" } }, { "name": "Credentials.CompanyID", "in": "query", "description": "Company identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Credentials.APIKey", "in": "query", "description": "API key secret", "required": true, "schema": { "type": "string" } }, { "name": "ResponseLanguage", "in": "query", "description": "This property is obsolete. Please refer to the \"Content-Language\" header instead.", "schema": { "type": "string", "deprecated": true } }, { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Attachments": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "encoding": { "Attachments": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_CustomerService_Tickets_Create_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_CustomerService_Tickets_Create_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_CustomerService_Tickets_Create_Response" } } } } } } }, "/deals/adddeal/": { "post": { "tags": [ "Deals (Deals)" ], "summary": "Creates a new deal, and potentially a new customer", "operationId": "DealsDealsAddDeal", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Deals_Deals_AddDeal_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Deals_Deals_AddDeal_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Deals_Deals_AddDeal_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Deals_Deals_AddDeal_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Deals_Deals_AddDeal_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Deals_Deals_AddDeal_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Deals_Deals_AddDeal_Response" } } } } } } }, "/deals/createremark/": { "post": { "tags": [ "Deals (Deals)" ], "summary": "Create remark to a deal", "operationId": "DealsDealsCreateRemark", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Deals_Deals_CreateRemark_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Deals_Deals_CreateRemark_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Deals_Deals_CreateRemark_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Deals_Deals_CreateRemark_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Deals_Deals_CreateRemark_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Deals_Deals_CreateRemark_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Deals_Deals_CreateRemark_Response" } } } } } } }, "/emailsubscriptions/mailinglists/list/": { "post": { "tags": [ "Email subscriptions (MailingLists)" ], "operationId": "EmailSubscriptionsMailingListsList", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EmailSubscriptions_MailingLists_List_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EmailSubscriptions_MailingLists_List_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EmailSubscriptions_MailingLists_List_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EmailSubscriptions_MailingLists_List_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_EmailSubscriptions_MailingLists_List_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_EmailSubscriptions_MailingLists_List_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_EmailSubscriptions_MailingLists_List_Response" } } } } } } }, "/emailsubscriptions/mailinglists/add/": { "post": { "tags": [ "Email subscriptions (MailingLists)" ], "operationId": "EmailSubscriptionsMailingListsAdd", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EmailSubscriptions_MailingLists_Add_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EmailSubscriptions_MailingLists_Add_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EmailSubscriptions_MailingLists_Add_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EmailSubscriptions_MailingLists_Add_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_EmailSubscriptions_MailingLists_Add_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_EmailSubscriptions_MailingLists_Add_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_EmailSubscriptions_MailingLists_Add_Response" } } } } } } }, "/fax/fax/send/": { "post": { "tags": [ "Outgoing faxes (Fax)" ], "operationId": "FaxFaxSend", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Fax_Fax_Send_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Fax_Fax_Send_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Fax_Fax_Send_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Fax_Fax_Send_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Fax_Fax_Send_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Fax_Fax_Send_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Fax_Fax_Send_Response" } } } } } } }, "/billing/generalbilling/openupayterminal/": { "post": { "tags": [ "Payments (GeneralBilling)" ], "summary": "Open an instant credit card terminal using Upay.", "description": "Please note all parameters set on the request, are automatically requested from Upay, yet should be manually approved by contacting Upay.", "operationId": "BillingGeneralbillingOpenupayterminal", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_OpenUpayTerminal_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_OpenUpayTerminal_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_OpenUpayTerminal_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_OpenUpayTerminal_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_OpenUpayTerminal_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_OpenUpayTerminal_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_OpenUpayTerminal_Response" } } } } } } }, "/billing/generalbilling/setupaycredentials/": { "post": { "tags": [ "Payments (GeneralBilling)" ], "summary": "Setup existing Upay account credentials", "description": "Please note when using existing Upay credentials, customer terms will remain as they were before using OfficeGuy", "operationId": "BillingGeneralbillingSetupaycredentials", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_SetUpayCredentials_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_SetUpayCredentials_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_SetUpayCredentials_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_SetUpayCredentials_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_SetUpayCredentials_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_SetUpayCredentials_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_SetUpayCredentials_Response" } } } } } } }, "/billing/paymentmethods/getforcustomer/": { "post": { "tags": [ "Payments (PaymentMethods)" ], "summary": "Get payment details", "operationId": "BillingPaymentmethodsGetforcustomer", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_GetForCustomer_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_GetForCustomer_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_GetForCustomer_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_GetForCustomer_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_GetForCustomer_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_GetForCustomer_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_GetForCustomer_Response" } } } } } } }, "/billing/paymentmethods/setforcustomer/": { "post": { "tags": [ "Payments (PaymentMethods)" ], "summary": "Set payment details", "description": "To generate a SingleUseToken use payments.js - https://help.sumit.co.il/he/articles/5893615", "operationId": "BillingPaymentmethodsSetforcustomer", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_SetForCustomer_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_SetForCustomer_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_SetForCustomer_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_SetForCustomer_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_SetForCustomer_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_SetForCustomer_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_SetForCustomer_Response" } } } } } } }, "/billing/paymentmethods/remove/": { "post": { "tags": [ "Payments (PaymentMethods)" ], "summary": "Remove payment details from existing customer", "operationId": "BillingPaymentmethodsRemove", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_Remove_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_Remove_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_Remove_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_Remove_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_Remove_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_Remove_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_Remove_Response" } } } } } } }, "/billing/payments/charge/": { "post": { "tags": [ "Payments (Payments)" ], "summary": "Charge customer", "operationId": "BillingPaymentsCharge", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Charge_Request" } ] }, "example": { "Customer": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": 0, "Name": "Danny Dean", "Phone": null, "EmailAddress": null, "City": null, "Address": null, "ZipCode": null, "CompanyNumber": null, "ID": null, "Folder": null, "Properties": null }, "PaymentMethod": { "ID": null, "CustomerID": null, "CreditCard_Number": "130002070", "CreditCard_LastDigits": null, "CreditCard_ExpirationMonth": 12, "CreditCard_ExpirationYear": 2020, "CreditCard_CVV": "123", "CreditCard_Track2": null, "CreditCard_CitizenID": "123456789", "CreditCard_CardMask": null, "CreditCard_Token": null, "DirectDebit_Bank": null, "DirectDebit_Branch": null, "DirectDebit_Account": null, "DirectDebit_ExpirationDate": null, "DirectDebit_MaximumAmount": null, "Type": 1 }, "SingleUseToken": null, "CreditCardAuthNumber": null, "Items": [ { "Item": { "ID": null, "Name": "My Product", "Description": null, "Price": null, "Currency": null, "Cost": null, "ExternalIdentifier": null, "SKU": null, "SearchMode": null, "Properties": null }, "Quantity": 2.0, "UnitPrice": 50.0, "Total": null, "Currency": null, "Description": null } ], "Payments_Credit": null, "Payments_Count": null, "Payments_FirstAmount": null, "Payments_NonFirstAmount": null, "UpdateCustomerByEmail": null, "UpdateCustomerByEmail_AttachDocument": null, "UpdateCustomerByEmail_Language": null, "SendDocumentByEmail": true, "SendDocumentByEmail_Language": null, "DocumentLanguage": null, "DocumentDescription": null, "VATIncluded": true, "VATRate": null, "AuthoriseOnly": null, "DraftDocument": null, "PreventDocumentCreation": null, "DocumentType": null, "SupportCredit": null, "MerchantNumber": null, "SendCopyToOrganization": null, "CardTokenNotNeeded": null, "AutoCapture": null, "AuthorizeAmount": null, "PreventStandingOrder": null, "Credentials": { "CompanyID": 12345678, "APIKey": "Yz6yRuiOlZ6JMvn4PIvbqRqoMxbRNwoPtwBfX5ymujZlB6tYhN" }, "ResponseLanguage": null } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Charge_Request" } ] }, "example": { "Customer": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": 0, "Name": "Danny Dean", "Phone": null, "EmailAddress": null, "City": null, "Address": null, "ZipCode": null, "CompanyNumber": null, "ID": null, "Folder": null, "Properties": null }, "PaymentMethod": { "ID": null, "CustomerID": null, "CreditCard_Number": "130002070", "CreditCard_LastDigits": null, "CreditCard_ExpirationMonth": 12, "CreditCard_ExpirationYear": 2020, "CreditCard_CVV": "123", "CreditCard_Track2": null, "CreditCard_CitizenID": "123456789", "CreditCard_CardMask": null, "CreditCard_Token": null, "DirectDebit_Bank": null, "DirectDebit_Branch": null, "DirectDebit_Account": null, "DirectDebit_ExpirationDate": null, "DirectDebit_MaximumAmount": null, "Type": 1 }, "SingleUseToken": null, "CreditCardAuthNumber": null, "Items": [ { "Item": { "ID": null, "Name": "My Product", "Description": null, "Price": null, "Currency": null, "Cost": null, "ExternalIdentifier": null, "SKU": null, "SearchMode": null, "Properties": null }, "Quantity": 2.0, "UnitPrice": 50.0, "Total": null, "Currency": null, "Description": null } ], "Payments_Credit": null, "Payments_Count": null, "Payments_FirstAmount": null, "Payments_NonFirstAmount": null, "UpdateCustomerByEmail": null, "UpdateCustomerByEmail_AttachDocument": null, "UpdateCustomerByEmail_Language": null, "SendDocumentByEmail": true, "SendDocumentByEmail_Language": null, "DocumentLanguage": null, "DocumentDescription": null, "VATIncluded": true, "VATRate": null, "AuthoriseOnly": null, "DraftDocument": null, "PreventDocumentCreation": null, "DocumentType": null, "SupportCredit": null, "MerchantNumber": null, "SendCopyToOrganization": null, "CardTokenNotNeeded": null, "AutoCapture": null, "AuthorizeAmount": null, "PreventStandingOrder": null, "Credentials": { "CompanyID": 12345678, "APIKey": "Yz6yRuiOlZ6JMvn4PIvbqRqoMxbRNwoPtwBfX5ymujZlB6tYhN" }, "ResponseLanguage": null } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Charge_Request" } ] }, "example": { "Customer": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": 0, "Name": "Danny Dean", "Phone": null, "EmailAddress": null, "City": null, "Address": null, "ZipCode": null, "CompanyNumber": null, "ID": null, "Folder": null, "Properties": null }, "PaymentMethod": { "ID": null, "CustomerID": null, "CreditCard_Number": "130002070", "CreditCard_LastDigits": null, "CreditCard_ExpirationMonth": 12, "CreditCard_ExpirationYear": 2020, "CreditCard_CVV": "123", "CreditCard_Track2": null, "CreditCard_CitizenID": "123456789", "CreditCard_CardMask": null, "CreditCard_Token": null, "DirectDebit_Bank": null, "DirectDebit_Branch": null, "DirectDebit_Account": null, "DirectDebit_ExpirationDate": null, "DirectDebit_MaximumAmount": null, "Type": 1 }, "SingleUseToken": null, "CreditCardAuthNumber": null, "Items": [ { "Item": { "ID": null, "Name": "My Product", "Description": null, "Price": null, "Currency": null, "Cost": null, "ExternalIdentifier": null, "SKU": null, "SearchMode": null, "Properties": null }, "Quantity": 2.0, "UnitPrice": 50.0, "Total": null, "Currency": null, "Description": null } ], "Payments_Credit": null, "Payments_Count": null, "Payments_FirstAmount": null, "Payments_NonFirstAmount": null, "UpdateCustomerByEmail": null, "UpdateCustomerByEmail_AttachDocument": null, "UpdateCustomerByEmail_Language": null, "SendDocumentByEmail": true, "SendDocumentByEmail_Language": null, "DocumentLanguage": null, "DocumentDescription": null, "VATIncluded": true, "VATRate": null, "AuthoriseOnly": null, "DraftDocument": null, "PreventDocumentCreation": null, "DocumentType": null, "SupportCredit": null, "MerchantNumber": null, "SendCopyToOrganization": null, "CardTokenNotNeeded": null, "AutoCapture": null, "AuthorizeAmount": null, "PreventStandingOrder": null, "Credentials": { "CompanyID": 12345678, "APIKey": "Yz6yRuiOlZ6JMvn4PIvbqRqoMxbRNwoPtwBfX5ymujZlB6tYhN" }, "ResponseLanguage": null } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Charge_Request" } ] }, "example": { "Customer": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": 0, "Name": "Danny Dean", "Phone": null, "EmailAddress": null, "City": null, "Address": null, "ZipCode": null, "CompanyNumber": null, "ID": null, "Folder": null, "Properties": null }, "PaymentMethod": { "ID": null, "CustomerID": null, "CreditCard_Number": "130002070", "CreditCard_LastDigits": null, "CreditCard_ExpirationMonth": 12, "CreditCard_ExpirationYear": 2020, "CreditCard_CVV": "123", "CreditCard_Track2": null, "CreditCard_CitizenID": "123456789", "CreditCard_CardMask": null, "CreditCard_Token": null, "DirectDebit_Bank": null, "DirectDebit_Branch": null, "DirectDebit_Account": null, "DirectDebit_ExpirationDate": null, "DirectDebit_MaximumAmount": null, "Type": 1 }, "SingleUseToken": null, "CreditCardAuthNumber": null, "Items": [ { "Item": { "ID": null, "Name": "My Product", "Description": null, "Price": null, "Currency": null, "Cost": null, "ExternalIdentifier": null, "SKU": null, "SearchMode": null, "Properties": null }, "Quantity": 2.0, "UnitPrice": 50.0, "Total": null, "Currency": null, "Description": null } ], "Payments_Credit": null, "Payments_Count": null, "Payments_FirstAmount": null, "Payments_NonFirstAmount": null, "UpdateCustomerByEmail": null, "UpdateCustomerByEmail_AttachDocument": null, "UpdateCustomerByEmail_Language": null, "SendDocumentByEmail": true, "SendDocumentByEmail_Language": null, "DocumentLanguage": null, "DocumentDescription": null, "VATIncluded": true, "VATRate": null, "AuthoriseOnly": null, "DraftDocument": null, "PreventDocumentCreation": null, "DocumentType": null, "SupportCredit": null, "MerchantNumber": null, "SendCopyToOrganization": null, "CardTokenNotNeeded": null, "AutoCapture": null, "AuthorizeAmount": null, "PreventStandingOrder": null, "Credentials": { "CompanyID": 12345678, "APIKey": "Yz6yRuiOlZ6JMvn4PIvbqRqoMxbRNwoPtwBfX5ymujZlB6tYhN" }, "ResponseLanguage": null } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Charge_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Charge_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Charge_Response" } } } } } } }, "/billing/payments/multivendorcharge/": { "post": { "tags": [ "Payments (Payments)" ], "summary": "Charge customer", "operationId": "BillingPaymentsMultivendorcharge", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_MultiVendorCharge_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_MultiVendorCharge_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_MultiVendorCharge_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_MultiVendorCharge_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_MultiVendorCharge_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_MultiVendorCharge_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_MultiVendorCharge_Response" } } } } } } }, "/billing/payments/get/": { "post": { "tags": [ "Payments (Payments)" ], "summary": "Get payment details", "operationId": "BillingPaymentsGet", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Get_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Get_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Get_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Get_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Get_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Get_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Get_Response" } } } } } } }, "/billing/payments/list/": { "post": { "tags": [ "Payments (Payments)" ], "summary": "List payments", "operationId": "BillingPaymentsList", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_List_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_List_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_List_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_List_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_List_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_List_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_List_Response" } } } } } } }, "/billing/payments/beginredirect/": { "post": { "tags": [ "Payments (Payments)" ], "summary": "Begin redirect for transaction", "operationId": "BillingPaymentsBeginredirect", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_BeginRedirect_Request" } ] }, "example": { "Customer": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": 0, "Name": "Danny Dean", "Phone": null, "EmailAddress": null, "City": null, "Address": null, "ZipCode": null, "CompanyNumber": null, "ID": null, "Folder": null, "Properties": null }, "Items": [ { "Item": { "ID": null, "Name": "My Product", "Description": null, "Price": null, "Currency": null, "Cost": null, "ExternalIdentifier": null, "SKU": null, "SearchMode": null, "Properties": null }, "Quantity": 2.0, "UnitPrice": 50.0, "Total": null, "Currency": null, "Description": null } ], "VATIncluded": true, "VATRate": null, "DocumentType": null, "RedirectURL": "https://www.google.com", "CancelRedirectURL": null, "ExternalIdentifier": null, "MaximumPayments": null, "MinimumPaymentsCredit": null, "SendUpdateByEmailAddress": null, "ExpirationHours": null, "Theme": null, "Language": null, "Header": null, "UpdateOrganizationOnSuccess": null, "UpdateOrganizationOnFailure": null, "UpdateCustomerOnSuccess": null, "DocumentDescription": null, "DraftDocument": null, "AutomaticallyRedirectToProviderPaymentPage": null, "IPNURL": null, "PreventSavingPaymentMethod": null, "MerchantNumber": null, "Credentials": { "CompanyID": 12345678, "APIKey": "r7UYRRm2kIPl9aNTYemC1IQzbbIeVanXQun8954pXTPXQhavzl" }, "ResponseLanguage": null } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_BeginRedirect_Request" } ] }, "example": { "Customer": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": 0, "Name": "Danny Dean", "Phone": null, "EmailAddress": null, "City": null, "Address": null, "ZipCode": null, "CompanyNumber": null, "ID": null, "Folder": null, "Properties": null }, "Items": [ { "Item": { "ID": null, "Name": "My Product", "Description": null, "Price": null, "Currency": null, "Cost": null, "ExternalIdentifier": null, "SKU": null, "SearchMode": null, "Properties": null }, "Quantity": 2.0, "UnitPrice": 50.0, "Total": null, "Currency": null, "Description": null } ], "VATIncluded": true, "VATRate": null, "DocumentType": null, "RedirectURL": "https://www.google.com", "CancelRedirectURL": null, "ExternalIdentifier": null, "MaximumPayments": null, "MinimumPaymentsCredit": null, "SendUpdateByEmailAddress": null, "ExpirationHours": null, "Theme": null, "Language": null, "Header": null, "UpdateOrganizationOnSuccess": null, "UpdateOrganizationOnFailure": null, "UpdateCustomerOnSuccess": null, "DocumentDescription": null, "DraftDocument": null, "AutomaticallyRedirectToProviderPaymentPage": null, "IPNURL": null, "PreventSavingPaymentMethod": null, "MerchantNumber": null, "Credentials": { "CompanyID": 12345678, "APIKey": "r7UYRRm2kIPl9aNTYemC1IQzbbIeVanXQun8954pXTPXQhavzl" }, "ResponseLanguage": null } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_BeginRedirect_Request" } ] }, "example": { "Customer": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": 0, "Name": "Danny Dean", "Phone": null, "EmailAddress": null, "City": null, "Address": null, "ZipCode": null, "CompanyNumber": null, "ID": null, "Folder": null, "Properties": null }, "Items": [ { "Item": { "ID": null, "Name": "My Product", "Description": null, "Price": null, "Currency": null, "Cost": null, "ExternalIdentifier": null, "SKU": null, "SearchMode": null, "Properties": null }, "Quantity": 2.0, "UnitPrice": 50.0, "Total": null, "Currency": null, "Description": null } ], "VATIncluded": true, "VATRate": null, "DocumentType": null, "RedirectURL": "https://www.google.com", "CancelRedirectURL": null, "ExternalIdentifier": null, "MaximumPayments": null, "MinimumPaymentsCredit": null, "SendUpdateByEmailAddress": null, "ExpirationHours": null, "Theme": null, "Language": null, "Header": null, "UpdateOrganizationOnSuccess": null, "UpdateOrganizationOnFailure": null, "UpdateCustomerOnSuccess": null, "DocumentDescription": null, "DraftDocument": null, "AutomaticallyRedirectToProviderPaymentPage": null, "IPNURL": null, "PreventSavingPaymentMethod": null, "MerchantNumber": null, "Credentials": { "CompanyID": 12345678, "APIKey": "r7UYRRm2kIPl9aNTYemC1IQzbbIeVanXQun8954pXTPXQhavzl" }, "ResponseLanguage": null } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_BeginRedirect_Request" } ] }, "example": { "Customer": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": 0, "Name": "Danny Dean", "Phone": null, "EmailAddress": null, "City": null, "Address": null, "ZipCode": null, "CompanyNumber": null, "ID": null, "Folder": null, "Properties": null }, "Items": [ { "Item": { "ID": null, "Name": "My Product", "Description": null, "Price": null, "Currency": null, "Cost": null, "ExternalIdentifier": null, "SKU": null, "SearchMode": null, "Properties": null }, "Quantity": 2.0, "UnitPrice": 50.0, "Total": null, "Currency": null, "Description": null } ], "VATIncluded": true, "VATRate": null, "DocumentType": null, "RedirectURL": "https://www.google.com", "CancelRedirectURL": null, "ExternalIdentifier": null, "MaximumPayments": null, "MinimumPaymentsCredit": null, "SendUpdateByEmailAddress": null, "ExpirationHours": null, "Theme": null, "Language": null, "Header": null, "UpdateOrganizationOnSuccess": null, "UpdateOrganizationOnFailure": null, "UpdateCustomerOnSuccess": null, "DocumentDescription": null, "DraftDocument": null, "AutomaticallyRedirectToProviderPaymentPage": null, "IPNURL": null, "PreventSavingPaymentMethod": null, "MerchantNumber": null, "Credentials": { "CompanyID": 12345678, "APIKey": "r7UYRRm2kIPl9aNTYemC1IQzbbIeVanXQun8954pXTPXQhavzl" }, "ResponseLanguage": null } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_BeginRedirect_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_BeginRedirect_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_BeginRedirect_Response" } } } } } } }, "/billing/recurring/listforcustomer/": { "post": { "tags": [ "Payments (Recurring)" ], "summary": "List customer recurring items", "operationId": "BillingRecurringListforcustomer", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_ListForCustomer_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_ListForCustomer_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_ListForCustomer_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_ListForCustomer_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_ListForCustomer_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_ListForCustomer_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_ListForCustomer_Response" } } } } } } }, "/billing/recurring/cancel/": { "post": { "tags": [ "Payments (Recurring)" ], "summary": "Cancel customer item", "operationId": "BillingRecurringCancel", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Cancel_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Cancel_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Cancel_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Cancel_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Cancel_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Cancel_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Cancel_Response" } } } } } } }, "/billing/recurring/charge/": { "post": { "tags": [ "Payments (Recurring)" ], "summary": "Charge customer and create recurring payment", "operationId": "BillingRecurringCharge", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Charge_Request" } ] }, "example": { "Customer": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": 0, "Name": "Danny Dean", "Phone": null, "EmailAddress": null, "City": null, "Address": null, "ZipCode": null, "CompanyNumber": null, "ID": null, "Folder": null, "Properties": null }, "PaymentMethod": { "ID": null, "CustomerID": null, "CreditCard_Number": "130002070", "CreditCard_LastDigits": null, "CreditCard_ExpirationMonth": 12, "CreditCard_ExpirationYear": 2020, "CreditCard_CVV": "123", "CreditCard_Track2": null, "CreditCard_CitizenID": "123456789", "CreditCard_CardMask": null, "CreditCard_Token": null, "DirectDebit_Bank": null, "DirectDebit_Branch": null, "DirectDebit_Account": null, "DirectDebit_ExpirationDate": null, "DirectDebit_MaximumAmount": null, "Type": 1 }, "SingleUseToken": null, "Items": [ { "Item": { "Duration_Days": null, "Duration_Months": 1, "ID": null, "Name": "Monthly Product", "Description": null, "Price": null, "Currency": null, "Cost": null, "ExternalIdentifier": null, "SKU": null, "SearchMode": null, "Properties": null }, "Quantity": 1.0, "UnitPrice": 50.0, "Currency": null, "Date_Start": null, "Description": null, "Duration_Days": null, "Duration_Months": null, "Recurrence": 12 } ], "UpdateCustomerByEmail": null, "UpdateCustomerByEmail_AttachDocument": null, "AuthoriseOnly": null, "DocumentType": null, "SendCopyToOrganization": null, "VATIncluded": true, "AttributionOffset": null, "CreditCardPayments_Count": null, "MerchantNumber": null, "OnlyDocument": false, "DocumentLanguage": null, "FirstDocumentDescription": null, "PreventStandingOrder": null, "Credentials": { "CompanyID": 12345678, "APIKey": "4thsjRrvf17hTq95CNRsGy06ke95xUnAlW4V3d80ogxYmqUm2X" }, "ResponseLanguage": null } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Charge_Request" } ] }, "example": { "Customer": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": 0, "Name": "Danny Dean", "Phone": null, "EmailAddress": null, "City": null, "Address": null, "ZipCode": null, "CompanyNumber": null, "ID": null, "Folder": null, "Properties": null }, "PaymentMethod": { "ID": null, "CustomerID": null, "CreditCard_Number": "130002070", "CreditCard_LastDigits": null, "CreditCard_ExpirationMonth": 12, "CreditCard_ExpirationYear": 2020, "CreditCard_CVV": "123", "CreditCard_Track2": null, "CreditCard_CitizenID": "123456789", "CreditCard_CardMask": null, "CreditCard_Token": null, "DirectDebit_Bank": null, "DirectDebit_Branch": null, "DirectDebit_Account": null, "DirectDebit_ExpirationDate": null, "DirectDebit_MaximumAmount": null, "Type": 1 }, "SingleUseToken": null, "Items": [ { "Item": { "Duration_Days": null, "Duration_Months": 1, "ID": null, "Name": "Monthly Product", "Description": null, "Price": null, "Currency": null, "Cost": null, "ExternalIdentifier": null, "SKU": null, "SearchMode": null, "Properties": null }, "Quantity": 1.0, "UnitPrice": 50.0, "Currency": null, "Date_Start": null, "Description": null, "Duration_Days": null, "Duration_Months": null, "Recurrence": 12 } ], "UpdateCustomerByEmail": null, "UpdateCustomerByEmail_AttachDocument": null, "AuthoriseOnly": null, "DocumentType": null, "SendCopyToOrganization": null, "VATIncluded": true, "AttributionOffset": null, "CreditCardPayments_Count": null, "MerchantNumber": null, "OnlyDocument": false, "DocumentLanguage": null, "FirstDocumentDescription": null, "PreventStandingOrder": null, "Credentials": { "CompanyID": 12345678, "APIKey": "4thsjRrvf17hTq95CNRsGy06ke95xUnAlW4V3d80ogxYmqUm2X" }, "ResponseLanguage": null } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Charge_Request" } ] }, "example": { "Customer": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": 0, "Name": "Danny Dean", "Phone": null, "EmailAddress": null, "City": null, "Address": null, "ZipCode": null, "CompanyNumber": null, "ID": null, "Folder": null, "Properties": null }, "PaymentMethod": { "ID": null, "CustomerID": null, "CreditCard_Number": "130002070", "CreditCard_LastDigits": null, "CreditCard_ExpirationMonth": 12, "CreditCard_ExpirationYear": 2020, "CreditCard_CVV": "123", "CreditCard_Track2": null, "CreditCard_CitizenID": "123456789", "CreditCard_CardMask": null, "CreditCard_Token": null, "DirectDebit_Bank": null, "DirectDebit_Branch": null, "DirectDebit_Account": null, "DirectDebit_ExpirationDate": null, "DirectDebit_MaximumAmount": null, "Type": 1 }, "SingleUseToken": null, "Items": [ { "Item": { "Duration_Days": null, "Duration_Months": 1, "ID": null, "Name": "Monthly Product", "Description": null, "Price": null, "Currency": null, "Cost": null, "ExternalIdentifier": null, "SKU": null, "SearchMode": null, "Properties": null }, "Quantity": 1.0, "UnitPrice": 50.0, "Currency": null, "Date_Start": null, "Description": null, "Duration_Days": null, "Duration_Months": null, "Recurrence": 12 } ], "UpdateCustomerByEmail": null, "UpdateCustomerByEmail_AttachDocument": null, "AuthoriseOnly": null, "DocumentType": null, "SendCopyToOrganization": null, "VATIncluded": true, "AttributionOffset": null, "CreditCardPayments_Count": null, "MerchantNumber": null, "OnlyDocument": false, "DocumentLanguage": null, "FirstDocumentDescription": null, "PreventStandingOrder": null, "Credentials": { "CompanyID": 12345678, "APIKey": "4thsjRrvf17hTq95CNRsGy06ke95xUnAlW4V3d80ogxYmqUm2X" }, "ResponseLanguage": null } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Charge_Request" } ] }, "example": { "Customer": { "ExternalIdentifier": null, "NoVAT": null, "SearchMode": 0, "Name": "Danny Dean", "Phone": null, "EmailAddress": null, "City": null, "Address": null, "ZipCode": null, "CompanyNumber": null, "ID": null, "Folder": null, "Properties": null }, "PaymentMethod": { "ID": null, "CustomerID": null, "CreditCard_Number": "130002070", "CreditCard_LastDigits": null, "CreditCard_ExpirationMonth": 12, "CreditCard_ExpirationYear": 2020, "CreditCard_CVV": "123", "CreditCard_Track2": null, "CreditCard_CitizenID": "123456789", "CreditCard_CardMask": null, "CreditCard_Token": null, "DirectDebit_Bank": null, "DirectDebit_Branch": null, "DirectDebit_Account": null, "DirectDebit_ExpirationDate": null, "DirectDebit_MaximumAmount": null, "Type": 1 }, "SingleUseToken": null, "Items": [ { "Item": { "Duration_Days": null, "Duration_Months": 1, "ID": null, "Name": "Monthly Product", "Description": null, "Price": null, "Currency": null, "Cost": null, "ExternalIdentifier": null, "SKU": null, "SearchMode": null, "Properties": null }, "Quantity": 1.0, "UnitPrice": 50.0, "Currency": null, "Date_Start": null, "Description": null, "Duration_Days": null, "Duration_Months": null, "Recurrence": 12 } ], "UpdateCustomerByEmail": null, "UpdateCustomerByEmail_AttachDocument": null, "AuthoriseOnly": null, "DocumentType": null, "SendCopyToOrganization": null, "VATIncluded": true, "AttributionOffset": null, "CreditCardPayments_Count": null, "MerchantNumber": null, "OnlyDocument": false, "DocumentLanguage": null, "FirstDocumentDescription": null, "PreventStandingOrder": null, "Credentials": { "CompanyID": 12345678, "APIKey": "4thsjRrvf17hTq95CNRsGy06ke95xUnAlW4V3d80ogxYmqUm2X" }, "ResponseLanguage": null } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Charge_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Charge_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Charge_Response" } } } } } } }, "/billing/recurring/update/": { "post": { "tags": [ "Payments (Recurring)" ], "summary": "Update customer recurring item", "operationId": "BillingRecurringUpdate", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Update_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Update_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Update_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Update_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Update_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Update_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Update_Response" } } } } } } }, "/billing/recurring/updatesettings/": { "post": { "tags": [ "Payments (Recurring)" ], "summary": "Update recurring billing application settings", "operationId": "BillingRecurringUpdatesettings", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_UpdateSettings_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_UpdateSettings_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_UpdateSettings_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_UpdateSettings_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_UpdateSettings_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_UpdateSettings_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_UpdateSettings_Response" } } } } } } }, "/scheduleddocuments/documents/createfromdocument/": { "post": { "tags": [ "Scheduled documents (Documents)" ], "operationId": "ScheduledDocumentsDocumentsCreateFromDocument", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ScheduledDocuments_Documents_CreateFromDocument_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ScheduledDocuments_Documents_CreateFromDocument_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ScheduledDocuments_Documents_CreateFromDocument_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ScheduledDocuments_Documents_CreateFromDocument_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_ScheduledDocuments_Documents_CreateFromDocument_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_ScheduledDocuments_Documents_CreateFromDocument_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_ScheduledDocuments_Documents_CreateFromDocument_Response" } } } } } } }, "/sms/mailinglists/list/": { "post": { "tags": [ "SMS subscriptions (MailingLists)" ], "operationId": "SMSMailingListsList", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_MailingLists_List_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_MailingLists_List_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_MailingLists_List_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_MailingLists_List_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_SMS_MailingList_List_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_SMS_MailingList_List_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_SMS_MailingList_List_Response" } } } } } } }, "/sms/mailinglists/add/": { "post": { "tags": [ "SMS subscriptions (MailingLists)" ], "operationId": "SMSMailingListsAdd", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_MailingLists_Add_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_MailingLists_Add_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_MailingLists_Add_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_MailingLists_Add_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_SMS_MailingLists_Add_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_SMS_MailingLists_Add_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_SMS_MailingLists_Add_Response" } } } } } } }, "/sms/sms/send/": { "post": { "tags": [ "SMS subscriptions (SMS)" ], "operationId": "SMSSMSSend", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_SMS_Send_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_SMS_Send_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_SMS_Send_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_SMS_Send_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_SMS_SMS_Send_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_SMS_SMS_Send_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_SMS_SMS_Send_Response" } } } } } } }, "/sms/sms/sendmultiple/": { "post": { "tags": [ "SMS subscriptions (SMS)" ], "operationId": "SMSSMSSendMultiple", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_SMS_SendMultiple_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_SMS_SendMultiple_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_SMS_SendMultiple_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_SMS_SendMultiple_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_SMS_SMS_SendMultiple_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_SMS_SMS_SendMultiple_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_SMS_SMS_SendMultiple_Response" } } } } } } }, "/sms/sms/listsenders/": { "post": { "tags": [ "SMS subscriptions (SMS)" ], "operationId": "SMSSMSListSenders", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_SMS_ListSenders_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_SMS_ListSenders_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_SMS_ListSenders_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SMS_SMS_ListSenders_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_SMS_SMS_ListSenders_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_SMS_SMS_ListSenders_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_SMS_SMS_ListSenders_Response" } } } } } } }, "/stock/stock/list/": { "post": { "tags": [ "Stock management (Stock)" ], "operationId": "StockStockList", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Stock_Stock_List_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Stock_Stock_List_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Stock_Stock_List_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Stock_Stock_List_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Stock_Stock_List_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Stock_Stock_List_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Stock_Stock_List_Response" } } } } } } }, "/triggers/triggers/subscribe/": { "post": { "tags": [ "Triggers (Triggers)" ], "summary": "Creates a trigger. This is usually done by make.com/zapier, but can also be used directly.", "operationId": "TriggersTriggersSubscribe", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Triggers_Triggers_Subscribe_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Triggers_Triggers_Subscribe_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Triggers_Triggers_Subscribe_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Triggers_Triggers_Subscribe_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Triggers_Triggers_Subscribe_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Triggers_Triggers_Subscribe_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Triggers_Triggers_Subscribe_Response" } } } } } } }, "/triggers/triggers/unsubscribe/": { "post": { "tags": [ "Triggers (Triggers)" ], "summary": "Removes trigger. This is usually done by make.com/zapier, but can also be used directly.", "operationId": "TriggersTriggersUnsubscribe", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Triggers_Triggers_Unsubscribe_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Triggers_Triggers_Unsubscribe_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Triggers_Triggers_Unsubscribe_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Triggers_Triggers_Unsubscribe_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Triggers_Triggers_Unsubscribe_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Triggers_Triggers_Unsubscribe_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Triggers_Triggers_Unsubscribe_Response" } } } } } } }, "/website/companies/create/": { "post": { "tags": [ "Website (Companies)" ], "summary": "Create new organization", "description": "Created organization payment method, will be set to the calling organization payment method.\nThis method requires an active payment method.", "operationId": "WebsiteCompaniesCreate", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_Create_Request" } ] }, "example": { "Company": { "Name": "My Brand Ltd.", "EmailAddress": "contact@mybrand.com", "DocumentsEmailAddress": null, "Country": "Israel", "Address": "City Center, Jerusalem", "Phone": "02-1234567", "Fax": "02-1234568", "Title": "We provide branding solution", "CorporateNumber": "514123456", "English_Name": null, "English_Address": null, "English_Country": null, "English_Phone": null, "English_Fax": null, "English_Title": null, "CompanyType": 0, "Logo": null, "Website": "https://www.mybrand.com" }, "User": null, "Applications": null, "HideFromCompaniesList": null, "Package": null, "Credentials": { "CompanyID": 12345678, "APIKey": "x80znVlxVW6iF6ok6bJCIFStEoxxiM7wTRuzQaeiNx4JIDl2Gi" }, "ResponseLanguage": null } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_Create_Request" } ] }, "example": { "Company": { "Name": "My Brand Ltd.", "EmailAddress": "contact@mybrand.com", "DocumentsEmailAddress": null, "Country": "Israel", "Address": "City Center, Jerusalem", "Phone": "02-1234567", "Fax": "02-1234568", "Title": "We provide branding solution", "CorporateNumber": "514123456", "English_Name": null, "English_Address": null, "English_Country": null, "English_Phone": null, "English_Fax": null, "English_Title": null, "CompanyType": 0, "Logo": null, "Website": "https://www.mybrand.com" }, "User": null, "Applications": null, "HideFromCompaniesList": null, "Package": null, "Credentials": { "CompanyID": 12345678, "APIKey": "x80znVlxVW6iF6ok6bJCIFStEoxxiM7wTRuzQaeiNx4JIDl2Gi" }, "ResponseLanguage": null } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_Create_Request" } ] }, "example": { "Company": { "Name": "My Brand Ltd.", "EmailAddress": "contact@mybrand.com", "DocumentsEmailAddress": null, "Country": "Israel", "Address": "City Center, Jerusalem", "Phone": "02-1234567", "Fax": "02-1234568", "Title": "We provide branding solution", "CorporateNumber": "514123456", "English_Name": null, "English_Address": null, "English_Country": null, "English_Phone": null, "English_Fax": null, "English_Title": null, "CompanyType": 0, "Logo": null, "Website": "https://www.mybrand.com" }, "User": null, "Applications": null, "HideFromCompaniesList": null, "Package": null, "Credentials": { "CompanyID": 12345678, "APIKey": "x80znVlxVW6iF6ok6bJCIFStEoxxiM7wTRuzQaeiNx4JIDl2Gi" }, "ResponseLanguage": null } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_Create_Request" } ] }, "example": { "Company": { "Name": "My Brand Ltd.", "EmailAddress": "contact@mybrand.com", "DocumentsEmailAddress": null, "Country": "Israel", "Address": "City Center, Jerusalem", "Phone": "02-1234567", "Fax": "02-1234568", "Title": "We provide branding solution", "CorporateNumber": "514123456", "English_Name": null, "English_Address": null, "English_Country": null, "English_Phone": null, "English_Fax": null, "English_Title": null, "CompanyType": 0, "Logo": null, "Website": "https://www.mybrand.com" }, "User": null, "Applications": null, "HideFromCompaniesList": null, "Package": null, "Credentials": { "CompanyID": 12345678, "APIKey": "x80znVlxVW6iF6ok6bJCIFStEoxxiM7wTRuzQaeiNx4JIDl2Gi" }, "ResponseLanguage": null } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Website_Companies_Create_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Website_Companies_Create_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Website_Companies_Create_Response" } } } } } } }, "/website/companies/update/": { "post": { "tags": [ "Website (Companies)" ], "summary": "Update organization details", "operationId": "WebsiteCompaniesUpdate", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_Update_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_Update_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_Update_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_Update_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Website_Companies_Update_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Website_Companies_Update_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Website_Companies_Update_Response" } } } } } } }, "/website/companies/getdetails/": { "post": { "tags": [ "Website (Companies)" ], "operationId": "WebsiteCompaniesGetDetails", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_GetDetails_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_GetDetails_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_GetDetails_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_GetDetails_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Website_Companies_GetDetails_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Website_Companies_GetDetails_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Website_Companies_GetDetails_Response" } } } } } } }, "/website/companies/listquotas/": { "post": { "tags": [ "Website (Companies)" ], "operationId": "WebsiteCompaniesListQuotas", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_ListQuotas_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_ListQuotas_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_ListQuotas_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_ListQuotas_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Website_Companies_ListQuotas_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Website_Companies_ListQuotas_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Website_Companies_ListQuotas_Response" } } } } } } }, "/website/companies/installapplications/": { "post": { "tags": [ "Website (Companies)" ], "summary": "Install applications\nPlease note this method requires an active payment method.", "operationId": "WebsiteCompaniesInstallApplications", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_InstallApplications_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_InstallApplications_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_InstallApplications_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Companies_InstallApplications_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Website_Companies_InstallApplications_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Website_Companies_InstallApplications_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Website_Companies_InstallApplications_Response" } } } } } } }, "/website/permissions/set/": { "post": { "tags": [ "Website (Permissions)" ], "summary": "Grant user permission", "operationId": "WebsitePermissionsSet", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Permissions_Set_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Permissions_Set_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Permissions_Set_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Permissions_Set_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Core_APIEmptyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Core_APIEmptyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Core_APIEmptyResponse" } } } } } } }, "/website/permissions/remove/": { "post": { "tags": [ "Website (Permissions)" ], "summary": "Remove user permission", "operationId": "WebsitePermissionsRemove", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Permissions_Remove_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Permissions_Remove_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Permissions_Remove_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Permissions_Remove_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Core_APIEmptyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Core_APIEmptyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Core_APIEmptyResponse" } } } } } } }, "/website/users/create/": { "post": { "tags": [ "Website (Users)" ], "summary": "Create user and grant permissions to the current organization", "operationId": "WebsiteUsersCreate", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Users_Create_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Users_Create_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Users_Create_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Users_Create_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Website_Users_Create_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Website_Users_Create_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Website_Users_Create_Response" } } } } } } }, "/website/users/loginredirect/": { "post": { "tags": [ "Website (Users)" ], "summary": "Login using redirect, without exposing the user credentials.\nPlease note, this doesn't validate the user credentials, and will allow creating tokens for incorrect credentials", "operationId": "WebsiteUsersLoginRedirect", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Sets the content response language. Defaults to Hebrew (he).", "schema": { } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Users_LoginRedirect_Request" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Users_LoginRedirect_Request" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Users_LoginRedirect_Request" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Website_Users_LoginRedirect_Request" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Response_Website_Users_LoginRedirect_Response" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Response_Website_Users_LoginRedirect_Response" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Response_Website_Users_LoginRedirect_Response" } } } } } } } }, "components": { "schemas": { "Accounting_Customers_CreateRemark_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "CustomerID": { "type": "integer", "format": "int64" }, "Content": { "type": [ "null", "string" ] }, "Username": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "Accounting_Customers_CreateRemark_Response": { "type": "object", "properties": { "RemarkID": { "type": "integer", "description": "RemarkID", "format": "int64" } }, "additionalProperties": false }, "Accounting_Customers_Create_Request": { "required": [ "Credentials", "Details" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Details": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Customer" } ], "description": "Customer details" } }, "additionalProperties": false }, "Accounting_Customers_Create_Response": { "type": "object", "properties": { "CustomerID": { "type": "integer", "description": "Customer number", "format": "int64" }, "CustomerHistoryURL": { "type": [ "null", "string" ], "description": "Link to the customer details page (דף מידע ללקוח/ה)" } }, "additionalProperties": false }, "Accounting_Customers_GetDetailsURL_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "CustomerID": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Accounting_Customers_GetDetailsURL_Response": { "type": "object", "properties": { "CustomerHistoryURL": { "type": [ "null", "string" ], "description": "Link to the customer details page (דף מידע ללקוח/ה)" } }, "additionalProperties": false }, "Accounting_Customers_Update_Response": { "type": "object", "properties": { "CustomerID": { "type": "integer", "description": "Customer number", "format": "int64" } }, "additionalProperties": false }, "Accounting_Documents_AddExpense_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "ExpenseNumber": { "type": [ "null", "string" ], "description": "Expense invoice number" }, "ExpenseFile": { "type": [ "null", "string" ], "description": "Expense file contents (Base64)" }, "ExpenseFilename": { "type": [ "null", "string" ], "description": "Expense filename" }, "Supplier": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Supplier" } ], "description": "Expense supplier" }, "Date": { "type": [ "null", "string" ], "description": "Expense date. Format should be JSON based (such as 2023-11-30).", "format": "date-time" }, "Lines": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Accounting_Typed_DocumentExpenseItem" }, "description": "Expense items and amounts" }, "Payments": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Accounting_Typed_DocumentPayment" }, "description": "Document payments\nPlease note each payment should contain a single details object (Cash/BankTransfer/Cheque/CreditCard/Other), multiple payments are handled through the payments array." }, "Description": { "type": [ "null", "string" ], "description": "Expense description/remarks" }, "IsDraft": { "type": [ "null", "boolean" ], "description": "Save document as draft" }, "Properties": { "type": [ "null", "object" ], "additionalProperties": { "type": "null" }, "description": "Custom entity fields" } }, "additionalProperties": false }, "Accounting_Documents_AddExpense_Response": { "type": "object", "properties": { "DocumentID": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Accounting_Documents_Cancel_Request": { "required": [ "Credentials", "Description", "DocumentID" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "DocumentID": { "type": "integer", "description": "Cancelled document identifier", "format": "int64" }, "Description": { "minLength": 1, "type": "string", "description": "Cancel description (reason)" } }, "additionalProperties": false }, "Accounting_Documents_Cancel_Response": { "type": "object", "properties": { "DocumentID": { "type": "integer", "description": "Cancel document identifier", "format": "int64" }, "DocumentNumber": { "type": [ "null", "integer" ], "description": "Document number", "format": "int64" }, "DocumentDownloadURL": { "type": [ "null", "string" ], "description": "Document download URL\nProduced document will be original (on first fetching), or certified copy." } }, "additionalProperties": false }, "Accounting_Documents_Create_Request": { "required": [ "Credentials", "Details" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Details": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentDetails" } ], "description": "General document details" }, "Items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Accounting_Typed_DocumentItem" }, "description": "Document items\nCan be used in Invoice, Invoice/Receipt, Proforma invoice etc." }, "Payments": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Accounting_Typed_DocumentPayment" }, "description": "Document payments (Can be used in invoice+receipt/receipt)\nPlease note each payment should contain a single details object (Cash/BankTransfer/Cheque/CreditCard/Other), multiple payments are handled through the payments array." }, "VATIncluded": { "type": [ "null", "boolean" ], "description": "Is VAT included in the prices?\nLeave empty for false.\nRelevant for items only." }, "VATPerItem": { "type": [ "null", "boolean" ], "description": "Is VAT specified in each item\nLeave empty for false.\nShould only be used when creating document with multiple items, each with different VAT rate.\nWhen set to true, VATRate needs to be null, VATIncluded needs to be null or false." }, "VATRate": { "type": [ "null", "number" ], "description": "Document VAT Rate\nLeave empty for company default.\nRelevant for items only.", "format": "double" }, "OriginalDocumentID": { "type": [ "null", "integer" ], "description": "Original document identifier.\nThis allows keeping a relationship between an original and a created document (such as credits for debit invoices)", "format": "int64" } }, "additionalProperties": false }, "Accounting_Documents_Create_Response": { "type": "object", "properties": { "DocumentID": { "type": "integer", "description": "Document ID", "format": "int64" }, "DocumentNumber": { "type": [ "null", "integer" ], "description": "Document number", "format": "int64" }, "CustomerID": { "type": "integer", "description": "Customer number", "format": "int64" }, "DocumentDownloadURL": { "type": [ "null", "string" ], "description": "Document download URL\nProduced document will be original (on first fetching), or certified copy." }, "DocumentPaymentURL": { "type": [ "null", "string" ], "description": "Document payment URL" } }, "additionalProperties": false }, "Accounting_Documents_GetDebtReport_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "DebitSource": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Accounting.Typed.DebtSettlementSource" } ] }, "CreditSource": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Accounting.Typed.DebtSettlementSource" } ] }, "IncludeDraftDocuments": { "type": "boolean" } }, "additionalProperties": false }, "Accounting_Documents_GetDebtReport_Response": { "type": "object", "properties": { "Debts": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Accounting_Documents_GetDebtReport_Response_CustomerDebt" } } }, "additionalProperties": false }, "Accounting_Documents_GetDebtReport_Response_CustomerDebt": { "type": "object", "properties": { "CustomerID": { "type": "integer", "format": "int64" }, "Debt": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Accounting_Documents_GetDebt_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "CustomerID": { "type": "integer", "format": "int64" }, "DebitSource": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Accounting.Typed.DebtSettlementSource" } ] }, "CreditSource": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Accounting.Typed.DebtSettlementSource" } ] }, "IncludeDraftDocuments": { "type": "boolean" } }, "additionalProperties": false }, "Accounting_Documents_GetDebt_Response": { "type": "object", "properties": { "Debt": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Accounting_Documents_GetDetails_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "DocumentID": { "type": [ "null", "integer" ], "description": "Document identifier\nThe system ID number. Seen in the url as the \"c\" number when doecument is viewed, or EntityID when document is received through a trigger. If used, DocumentID + DocumentType are not needed.", "format": "int64" }, "DocumentType": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentType" } ], "description": "Document type\nMust have a value when DocumentNumber is used, and not needed if DocumentID is used." }, "DocumentNumber": { "type": [ "null", "integer" ], "description": "Document number\nThis number appears in the document title. It must have a value when DocumentType is used, and not needed if DocumentID is used.", "format": "int64" } }, "additionalProperties": false }, "Accounting_Documents_GetDetails_Response": { "type": "object", "properties": { "Document": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_GetDetailsDocument" } ] }, "Items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Accounting_Typed_DocumentItem" } }, "Payments": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Accounting_Typed_DocumentPayment" } }, "DocumentDownloadURL": { "type": [ "null", "string" ], "description": "Document download URL\nProduced document will be original on first visit, or certified copy on additional visits." }, "DocumentPaymentURL": { "type": [ "null", "string" ], "description": "Document payment URL" }, "DocumentID": { "type": "integer", "description": "SUMIT Document identifier\nDocumentID is an internal identifier (also known as Card Number on SUMIT. Keep this for further API calls.", "format": "int64" }, "DocumentNumber": { "type": [ "null", "integer" ], "description": "Document number\nFor instance, for Invoice #1000, the DocumentNumber will be 1000.", "format": "int64" } }, "additionalProperties": false }, "Accounting_Documents_GetPDF_Request": { "required": [ "Credentials", "Original" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "DocumentID": { "type": [ "null", "integer" ], "description": "Document identifier\nThe system ID number. Can be found in the url as the \"c\" number when document is viewed, or EntityID when document is received through a trigger. If used, DocumentID and DocumentType are not used.", "format": "int64" }, "DocumentType": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentType" } ], "description": "Document type\nRequired when DocumentNumber is used, ignored when DocumentID is used." }, "DocumentNumber": { "type": [ "null", "integer" ], "description": "Document number\nThis number appears in the document title. It must have a value when DocumentType is used, and not needed if DocumentID is used.", "format": "int64" }, "Original": { "type": "boolean", "description": "Send original document if possible" } }, "additionalProperties": false }, "Accounting_Documents_List_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "DocumentTypes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Accounting_Typed_DocumentType" }, "description": "Document type\nMust have a value when DocumentNumber is used, and not needed if DocumentID is used." }, "DocumentNumberFrom": { "type": [ "null", "integer" ], "description": "Document number range (from)", "format": "int64" }, "DocumentNumberTo": { "type": [ "null", "integer" ], "description": "Document number range (to)", "format": "int64" }, "DateFrom": { "type": [ "null", "string" ], "description": "Document date range (from)", "format": "date-time" }, "DateTo": { "type": [ "null", "string" ], "description": "Document date range (to)", "format": "date-time" }, "IncludeDrafts": { "type": "boolean", "description": "Include draft documents (defaults to False)" }, "Paging": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Core_Typed.Paging" } ], "description": "List paging" } }, "additionalProperties": false }, "Accounting_Documents_List_Response": { "type": "object", "properties": { "Documents": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Accounting_Typed_ListDocumentsDocument" } }, "HasNextPage": { "type": "boolean" } }, "additionalProperties": false }, "Accounting_Documents_MoveToBooks_Request": { "required": [ "Credentials", "DocumentID" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "DocumentID": { "type": "integer", "description": "Document identifier", "format": "int64" } }, "additionalProperties": false }, "Accounting_Documents_MoveToBooks_Response": { "type": "object", "additionalProperties": false }, "Accounting_Documents_Send_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "EntityID": { "type": [ "null", "integer" ], "description": "Document identifier", "format": "int64" }, "DocumentType": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentType" } ], "description": "Document type" }, "DocumentNumber": { "type": [ "null", "integer" ], "description": "Document number", "format": "int64" }, "EmailAddress": { "type": [ "null", "string" ], "description": "Email address\nDefaults to the customer email address" }, "SenderUserID": { "type": [ "null", "integer" ], "description": "Sender user ID\nDefaults to the company owner", "format": "int64" }, "Original": { "type": [ "null", "boolean" ], "description": "Send original document if possible\nDefaults to False" }, "Language": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Language" } ], "description": "Email language\nDefaults to the company language" }, "PersonalMessage": { "type": [ "null", "string" ], "description": "Personal message" } }, "additionalProperties": false }, "Accounting_General_GetExchangeRate_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Date": { "type": [ "null", "string" ], "description": "Defaults to the current date. Format should be JSON based (such as 2023-11-30).", "format": "date-time" }, "Currency_From": { "type": [ "null", "string" ], "description": "Original currency\nDefaults to USD" }, "Currency_To": { "type": [ "null", "string" ], "description": "Target currency\nDefaults to ILS" } }, "additionalProperties": false }, "Accounting_General_GetExchangeRate_Response": { "type": "object", "properties": { "Rate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Accounting_General_GetNextDocumentNumber_Request": { "required": [ "Credentials", "Type" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Type": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentType" } ], "description": "Document type" } }, "additionalProperties": false }, "Accounting_General_GetNextDocumentNumber_Response": { "type": "object", "properties": { "NextDocumentNumber": { "type": "integer", "description": "Currently set next document number.", "format": "int64" } }, "additionalProperties": false }, "Accounting_General_GetVATRate_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Date": { "type": [ "null", "string" ], "description": "Defaults to the current date. Format should be JSON based (such as 2023-11-30).", "format": "date-time" } }, "additionalProperties": false }, "Accounting_General_GetVATRate_Response": { "type": "object", "properties": { "Rate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Accounting_General_SetNextDocumentNumber_Request": { "required": [ "Credentials", "NextDocumentNumber", "Type" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Type": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentType" } ], "description": "Document type" }, "NextDocumentNumber": { "type": "integer", "description": "Next document number to set.\nNote that the document number has to be higher than the last issued document number.\nBy default, all documents numbers are set to 1000.", "format": "int64" } }, "additionalProperties": false }, "Accounting_General_SetNextDocumentNumber_Response": { "type": "object", "additionalProperties": false }, "Accounting_General_UpdateSettings_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "DocumentsEmailAddressSpecified": { "type": "boolean", "description": "Indicates if the DocumentsEmailAddress should be updated" }, "DocumentsEmailAddress": { "type": [ "null", "string" ], "description": "Email address display on all documents\nBy default, the company email address will be displayed" }, "AccountantEmailSpecified": { "type": "boolean", "description": "Indicates if the AccountantEmail should be updated" }, "AccountantEmail": { "type": [ "null", "string" ], "description": "Email address for sending all monthly documents each month" }, "IncomeTaxCreditForDonation": { "type": [ "null", "boolean" ], "description": "Indicates whether the NPO is 46a donations approved, and should be presented on donation receipts" }, "EnableCustomDocumentDates": { "type": [ "null", "boolean" ], "description": "Indicates documents can be created in any custom date.\nBy default, documents can only be created in a sequence order." }, "DocumentsTheme": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Accounting.Typed.DocumentsTheme" } ], "description": "Choose documents printing theme.\nBy default, documents are created using the Material theme." } }, "additionalProperties": false }, "Accounting_General_UpdateSettings_Response": { "type": "object", "additionalProperties": false }, "Accounting_General_VerifyBankAccount_Request": { "required": [ "AccountNumber", "BankCode", "BranchCode", "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "BankCode": { "type": "integer", "description": "Bank code", "format": "int32" }, "BranchCode": { "type": "integer", "description": "Branch code", "format": "int32" }, "AccountNumber": { "type": "integer", "description": "Account number", "format": "int32" }, "VerifyBranchNumber": { "type": [ "null", "boolean" ], "description": "Verifies if the branch exists" }, "VerifyLimitedAccount": { "type": [ "null", "boolean" ], "description": "Verifies if the account is limited in addition" } }, "additionalProperties": false }, "Accounting_General_VerifyBankAccount_Response": { "type": "object", "properties": { "Result": { "type": [ "null", "boolean" ], "description": "Result status:\nTrue = Valid bank account\nFalse = Invalid bank account\nNull = Unsupported bank" }, "ValidBranch": { "type": [ "null", "boolean" ], "description": "Result status:\nTrue = Valid branch\nFalse = Invalid branch\nNull = Branch not validated" }, "IsLimitedAccount": { "type": [ "null", "boolean" ], "description": "Limited bank account status:\nTrue = Bank account is limited\nFalse = Bank account is not limited\nNull = Bank account wasn't verified" } }, "additionalProperties": false }, "Accounting_IncomeItems_Create_Request": { "required": [ "Credentials", "IncomeItem" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "IncomeItem": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_IncomeItem" } ] } }, "additionalProperties": false }, "Accounting_IncomeItems_Create_Response": { "type": "object", "properties": { "EntityID": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Accounting_IncomeItems_List_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Paging": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Core_Typed.Paging" } ], "description": "List paging" } }, "additionalProperties": false }, "Accounting_IncomeItems_List_Response": { "type": "object", "properties": { "IncomeItems": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Accounting_Typed_ListIncomeItem" } }, "HasNextPage": { "type": "boolean" } }, "additionalProperties": false }, "Accounting_Typed_Customer": { "type": "object", "properties": { "ID": { "type": [ "null", "integer" ], "description": "SUMIT identifier\nLeave empty to create a new entity or search by other fields when applicable", "format": "int64" }, "Folder": { "type": [ "null", "string" ], "description": "Folder identifier.\nCan be either application folder name, or FolderID." }, "Properties": { "type": [ "null", "object" ], "additionalProperties": { "type": "null" }, "description": "Entity fields" }, "Name": { "type": [ "null", "string" ], "description": "Customer full name (or company name)\nRequired for creating new customer\n(Leave empty to search by other fields)" }, "Phone": { "type": [ "null", "string" ], "description": "Customer phone number (Optional field)" }, "EmailAddress": { "type": [ "null", "string" ], "description": "Customer email address (Optional field)" }, "City": { "type": [ "null", "string" ], "description": "Customer city (Optional field)" }, "Address": { "type": [ "null", "string" ], "description": "Customer address (Optional field)" }, "ZipCode": { "type": [ "null", "string" ], "description": "Customer ZipCode (Optional field)" }, "CompanyNumber": { "type": [ "null", "string" ], "description": "Customer registered company number (VAT number) (Optional field)" }, "ExternalIdentifier": { "type": [ "null", "string" ], "description": "Customer external identifier.\nExternal identifier from calling application.\nOptional field" }, "NoVAT": { "type": [ "null", "boolean" ], "description": "NoVAT indication\nSet to true for VAT exempt customers\nDefaults to False" }, "SearchMode": { "type": "null", "allOf": [ { "description": "Customer searching mode", "$ref": "#/components/schemas/Accounting_Typed_CustomerSearchMode" } ], "description": "Customer searching mode\nDefaults to None" } }, "additionalProperties": { } }, "Accounting_Typed_CustomerSearchMode": { "enum": [ "Automatic (0)", "None (1)", "ExternalIdentifier (2)", "Name (3)", "CompanyNumber (4)", "Phone (5)", "EmailAddress (6)" ], "type": "string", "description": "Customer searching mode" }, "Accounting_Typed_DocumentCurrency": { "enum": [ "ILS (0)", "USD (1)", "EUR (2)", "CAD (3)", "CHF (4)", "GBP (5)", "AUD (6)", "JPY (8)", "SEK (9)", "NOK (10)", "DKK (11)", "ZAR (12)", "JOD (13)", "LBP (14)", "EGP (15)", "ARS (32)", "BSD (44)", "BHD (48)", "BDT (50)", "AMD (51)", "BBD (52)", "BMD (60)", "BTN (64)", "BOB (68)", "BWP (72)", "BZD (84)", "SBD (90)", "BND (96)", "MMK (104)", "BIF (108)", "KHR (116)", "CVE (132)", "KYD (136)", "LKR (144)", "CLP (152)", "CNY (156)", "COP (170)", "KMF (174)", "CRC (188)", "HRK (191)", "CUP (192)", "CZK (203)", "DOP (214)", "SVC (222)", "ETB (230)", "ERN (232)", "FKP (238)", "FJD (242)", "DJF (262)", "GMD (270)", "GIP (292)", "GTQ (320)", "GNF (324)", "GYD (328)", "HTG (332)", "HNL (340)", "HKD (344)", "HUF (348)", "ISK (352)", "INR (356)", "IDR (360)", "IRR (364)", "IQD (368)", "JMD (388)", "KZT (398)", "KES (404)", "KPW (408)", "KRW (410)", "KWD (414)", "KGS (417)", "LAK (418)", "LSL (426)", "LRD (430)", "LYD (434)", "MOP (446)", "MWK (454)", "MYR (458)", "MVR (462)", "MUR (480)", "MXN (484)", "MNT (496)", "MDL (498)", "MAD (504)", "OMR (512)", "NAD (516)", "NPR (524)", "ANG (532)", "AWG (533)", "VUV (548)", "NZD (554)", "NIO (558)", "NGN (566)", "PKR (586)", "PAB (590)", "PGK (598)", "PYG (600)", "PEN (604)", "PHP (608)", "QAR (634)", "RUB (643)", "RWF (646)", "SHP (654)", "SAR (682)", "SCR (690)", "SLL (694)", "SGD (702)", "VND (704)", "SOS (706)", "SZL (748)", "SYP (760)", "THB (764)", "TOP (776)", "TTD (780)", "AED (784)", "TND (788)", "UGX (800)", "MKD (807)", "TZS (834)", "UYU (858)", "UZS (860)", "WST (882)", "YER (886)", "TWD (901)", "CUC (931)", "ZWL (932)", "BYN (933)", "TMT (934)", "GHS (936)", "SDG (938)", "RSD (941)", "MZN (943)", "AZN (944)", "RON (946)", "TRY (949)", "XAF (950)", "XCD (951)", "XOF (952)", "XPF (953)", "XAU (959)", "XDR (960)", "XAG (961)", "ZMW (967)", "SRD (968)", "MGA (969)", "AFN (971)", "TJS (972)", "AOA (973)", "BGN (975)", "CDF (976)", "BAM (977)", "UAH (980)", "GEL (981)", "PLN (985)", "BRL (986)", "CLF (990)" ], "type": "string" }, "Accounting_Typed_DocumentDetails": { "required": [ "Customer", "Type" ], "type": "object", "properties": { "IsDraft": { "type": [ "null", "boolean" ], "description": "Save document as draft\nLeave empty for final document" }, "Date": { "type": [ "null", "string" ], "description": "Document date\nDefaults to the current date. Format should be JSON based (such as 2023-11-30).", "format": "date-time" }, "Customer": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Customer" } ], "description": "Customer" }, "SendByEmail": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentSendByEmail" } ], "description": "Send document by email after creation" }, "Language": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Language" } ], "description": "Document language\nDefaults to the company language" }, "Currency": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentCurrency" } ], "description": "Document currency\nDefaults to the company currency" }, "Type": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentType" } ], "description": "Document type" }, "Description": { "type": [ "null", "string" ], "description": "Document description. The description is shown in the printed document." }, "ExternalReference": { "type": [ "null", "string" ], "description": "Document external reference (expense invoice number)." }, "OpeningTextHTML": { "type": [ "null", "string" ], "description": "Document opening text as HTML.\nSpecify Either OpeningText or OpeningTextHTML" }, "OpeningText": { "type": [ "null", "string" ], "description": "Document opening text as plain text.\nSpecify Either OpeningText or OpeningTextHTML" }, "ClosingTextHTML": { "type": [ "null", "string" ], "description": "Document closing text as HTML.\nSpecify Either ClosingText or ClosingTextHTML" }, "ClosingText": { "type": [ "null", "string" ], "description": "Document closing text as plain text.\nSpecify Either ClosingText or ClosingTextHTML" }, "DueDate": { "type": [ "null", "string" ], "description": "Document due date", "format": "date-time" }, "PaymentRequestText": { "type": [ "null", "string" ], "description": "Payment request text. Defaults to the company payment request text." }, "Properties": { "type": [ "null", "object" ], "additionalProperties": { "type": "null" }, "description": "Custom entity fields" } }, "additionalProperties": false }, "Accounting_Typed_DocumentExpenseItem": { "type": "object", "properties": { "Item": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_ExpenseItem" } ], "description": "Expense item" }, "Amount": { "type": [ "null", "number" ], "description": "Amount in ILS", "format": "double" } }, "additionalProperties": false }, "Accounting_Typed_DocumentItem": { "type": "object", "properties": { "Quantity": { "type": [ "null", "number" ], "description": "Quantity\nDefaults to 1", "format": "double" }, "UnitPrice": { "type": [ "null", "number" ], "description": "Single Unit price in ILS\nLeave this empty for non-ILS documents and automatic exchange rate.", "format": "double" }, "TotalPrice": { "type": [ "null", "number" ], "description": "Total price in ILS\nLeave this empty to auto calculate on ILS documents: Total price - Unit price * Quantity.\nLeave this empty for non-ILS documents and automatic exchange rate.", "format": "double" }, "DocumentCurrency_UnitPrice": { "type": [ "null", "number" ], "description": "Unit price in document currency\nSingle unit price in the document currency.\nLeave this empty for ILS documents / automatic exchange rate.", "format": "double" }, "DocumentCurrency_TotalPrice": { "type": [ "null", "number" ], "description": "Total price in document currency\nLeave this empty to auto calculate: Total price - Unit price * Quantity.\nLeave this empty for ILS documents / automatic exchange rate.", "format": "double" }, "VAT": { "type": [ "null", "number" ], "description": "VAT in ILS.\nCan only be specified when using VATPerItem.", "format": "double" }, "DocumentCurrency_VAT": { "type": [ "null", "number" ], "description": "VAT in document currency\nCan only be specified when using VATPerItem.", "format": "double" }, "Item": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_IncomeItem" } ], "description": "Item details" }, "Description": { "type": [ "null", "string" ], "description": "Document description. The description is shown in the printed document." } }, "additionalProperties": false }, "Accounting_Typed_DocumentPayment": { "type": "object", "properties": { "Amount": { "type": [ "null", "number" ], "description": "Received payment amount\nLeave this empty for non-ILS documents and automatic exchange rate", "format": "double" }, "DocumentCurrency_Amount": { "type": [ "null", "number" ], "description": "Received payment amount\nLeave this empty for ILS documents / automatic exchange rate", "format": "double" }, "Type": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentPaymentType" } ], "description": "Payment Type\nLeave Empty for Automatic (Detect by the supplied Details fields)." }, "PaymentElementID": { "type": [ "null", "integer" ], "description": "Payment Element ID\nLeave Empty for Automatic (Detect by the supplied Details fields).", "format": "int64" }, "Details_General": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Payment_General" } ], "description": "General details\nProvide when payment method isn't detailed" }, "Details_Cash": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Payment_Cash" } ], "description": "Cash details\nProvide when payment was made using cash" }, "Details_BankTransfer": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Payment_BankTransfer" } ], "description": "Bank transfer details\nProvide when payment was made using bank transfer" }, "Details_Cheque": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Payment_Cheque" } ], "description": "Cheque details\nProvide when payment was made using cheque" }, "Details_CreditCard": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Payment_CreditCard" } ], "description": "Credit card details\nProvide when payment was made using external credit card" }, "Details_Other": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Payment_Other" } ], "description": "Other details\nProvide when payment was made using custom payment method" }, "Details_Digital": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Payment_Digital" } ], "description": "Digital details\nProvide when payment was made using digital payment method" }, "Details_TaxWithholding": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Payment_TaxWithholding" } ], "description": "Tax Withholding details\nProvide when taxwithholding" } }, "additionalProperties": false }, "Accounting_Typed_DocumentPaymentType": { "enum": [ "Automatic (0)", "General (1)", "Cash (2)", "BankTransfer (3)", "Cheque (4)", "CreditCard (5)", "Digital (6)", "TaxWithholding (7)", "Other (8)" ], "type": "string" }, "Accounting_Typed_DocumentSendByEmail": { "type": "object", "properties": { "EmailAddress": { "type": [ "null", "string" ], "description": "Recipient email address\nDefaults to the customer email address" }, "Original": { "type": "boolean", "description": "Send original document / copy?" }, "SendAsPaymentRequest": { "type": "boolean", "description": "Send document as a payment request" } }, "additionalProperties": false }, "Accounting_Typed_DocumentType": { "enum": [ "Invoice (0)", "InvoiceAndReceipt (1)", "Receipt (2)", "ProformaInvoice (3)", "DonationReceipt (4)", "CreditInvoice (5)", "CreditInvoiceAndReceipt (6)", "CreditReceipt (7)", "Order (8)", "DeliveryNote (9)", "GoodsReturnNote (10)", "PurchasingOrder (11)", "PriceQuotation (12)", "PaymentRequest (13)", "CreditDonationReceipt (14)", "ExpenseInvoiceReceipt (15)", "ExpenseInvoice (16)", "ExpenseReceipt (17)", "ExpenseRequest (18)", "CreditExpenseInvoiceReceipt (19)", "CreditExpenseInvoice (20)", "CreditExpenseReceipt (21)", "SupplierPayment (22)" ], "type": "string" }, "Accounting_Typed_ExpenseItem": { "type": "object", "properties": { "ID": { "type": [ "null", "integer" ], "description": "SUMIT identifier", "format": "int64" }, "Name": { "type": [ "null", "string" ], "description": "Expense item name" }, "ExternalIdentifier": { "type": [ "null", "string" ], "description": "Expense item external identifier" }, "SearchMode": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_ExpenseItemSearchMode" } ] }, "Properties": { "type": [ "null", "object" ], "additionalProperties": { "type": "null" }, "description": "Entity fields" } }, "additionalProperties": { } }, "Accounting_Typed_ExpenseItemSearchMode": { "enum": [ "Automatic (0)", "None (1)", "ExternalIdentifier (2)", "Name (3)" ], "type": "string" }, "Accounting_Typed_GetDetailsDocument": { "type": "object", "properties": { "IsDraft": { "type": [ "null", "boolean" ], "description": "Document is Draft" }, "Date": { "type": [ "null", "string" ], "description": "Document date", "format": "date-time" }, "Customer": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Customer" } ], "description": "Customer" }, "Language": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Language" } ], "description": "Document language" }, "Currency": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentCurrency" } ], "description": "Document currency" }, "Type": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentType" } ], "description": "Document type" }, "Description": { "type": [ "null", "string" ], "description": "Document description. The description is shown in the printed document." }, "ExternalReference": { "type": [ "null", "string" ], "description": "Document external reference (expense invoice number)." }, "DueDate": { "type": [ "null", "string" ], "description": "Document due date", "format": "date-time" }, "DocumentValue": { "type": [ "null", "number" ], "description": "Document value in document currency ILS", "format": "double" }, "CompanyValue": { "type": [ "null", "number" ], "description": "Document value in ILS", "format": "double" }, "IsClosed": { "type": [ "null", "boolean" ], "description": "Document closed indicator (mostly used for Proforma invoices and Payment requests)" }, "AssignmentNumber": { "type": [ "null", "string" ], "description": "Document assignment number (מספר הקצאה)" } }, "additionalProperties": false }, "Accounting_Typed_IncomeItem": { "type": "object", "properties": { "ID": { "type": [ "null", "integer" ], "description": "SUMIT identifier", "format": "int64" }, "Name": { "type": [ "null", "string" ], "description": "Item name" }, "Description": { "type": [ "null", "string" ], "description": "Item description" }, "Price": { "type": [ "null", "number" ], "description": "Item price (for single unit)", "format": "double" }, "Currency": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentCurrency" } ], "description": "Price currency\nLeave empty for company default" }, "Cost": { "type": [ "null", "number" ], "description": "Item cost (for single unit)", "format": "double" }, "ExternalIdentifier": { "type": [ "null", "string" ], "description": "Income item external identifier" }, "SKU": { "type": [ "null", "string" ] }, "SearchMode": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_IncomeItemSearchMode" } ] }, "Properties": { "type": [ "null", "object" ], "additionalProperties": { "type": "null" }, "description": "Entity fields" } }, "additionalProperties": { } }, "Accounting_Typed_IncomeItemSearchMode": { "enum": [ "Automatic (0)", "None (1)", "ExternalIdentifier (2)", "Name (3)", "SKU (4)", "Description (5)" ], "type": "string" }, "Accounting_Typed_Language": { "enum": [ "Hebrew (0)", "English (1)", "Arabic (2)", "Spanish (3)" ], "type": "string" }, "Accounting_Typed_ListDocumentsDocument": { "type": "object", "properties": { "IsDraft": { "type": [ "null", "boolean" ], "description": "Save document as draft\nLeave empty for final document" }, "Date": { "type": [ "null", "string" ], "description": "Document date\nDefaults to the current date. Format should be JSON based (such as 2023-11-30).", "format": "date-time" }, "CustomerID": { "type": "integer", "description": "Customer ID", "format": "int64" }, "CustomerName": { "type": [ "null", "string" ], "description": "Customer name" }, "Language": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Language" } ], "description": "Document language" }, "Currency": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentCurrency" } ], "description": "Document currency" }, "Type": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentType" } ], "description": "Document type" }, "Description": { "type": [ "null", "string" ], "description": "Document description. The description is shown in the printed document." }, "ExternalReference": { "type": [ "null", "string" ], "description": "Document external reference (expense invoice number)." }, "DueDate": { "type": [ "null", "string" ], "description": "Document due date", "format": "date-time" }, "DocumentDownloadURL": { "type": [ "null", "string" ], "description": "Document download URL\nProduced document will be original on first visit, or certified copy on additional visits." }, "DocumentPaymentURL": { "type": [ "null", "string" ], "description": "Document payment URL" }, "DocumentID": { "type": "integer", "description": "SUMIT Document identifier", "format": "int64" }, "DocumentNumber": { "type": [ "null", "integer" ], "description": "Document number\nFor instance, for Invoice #1000, the DocumentNumber will be 1000.", "format": "int64" }, "DocumentValue": { "type": [ "null", "number" ], "description": "Document value in document currency ILS", "format": "double" }, "CompanyValue": { "type": [ "null", "number" ], "description": "Document value in ILS", "format": "double" }, "IsClosed": { "type": [ "null", "boolean" ], "description": "Document closed indicator (mostly used for Proforma invoices and Payment requests)" }, "AssignmentNumber": { "type": [ "null", "string" ], "description": "Document assignment number (מספר הקצאה)" } }, "additionalProperties": false }, "Accounting_Typed_ListIncomeItem": { "type": "object", "properties": { "ID": { "type": [ "null", "integer" ], "description": "SUMIT identifier", "format": "int64" }, "Name": { "type": [ "null", "string" ], "description": "Item name" }, "Description": { "type": [ "null", "string" ], "description": "Item description" }, "Price": { "type": [ "null", "number" ], "description": "Item price", "format": "double" }, "Cost": { "type": [ "null", "number" ], "description": "Item cost", "format": "double" }, "ExternalIdentifier": { "type": [ "null", "string" ], "description": "Income item external identifier" }, "SKU": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "Accounting_Typed_Payment_BankTransfer": { "type": "object", "properties": { "BankNumber": { "type": [ "null", "integer" ], "description": "Israeli bank number\nFor instance, 12 indicates Bank Hapoalim.", "format": "int64" }, "BranchNumber": { "type": [ "null", "integer" ], "description": "Israeli bank branch number", "format": "int64" }, "AccountNumber": { "type": [ "null", "string" ], "description": "Bank account number" }, "Reference": { "type": [ "null", "string" ], "description": "Bank reference number" }, "DueDate": { "type": [ "null", "string" ], "description": "Payment date", "format": "date-time" } }, "additionalProperties": false }, "Accounting_Typed_Payment_Cash": { "type": "object", "additionalProperties": false }, "Accounting_Typed_Payment_Cheque": { "type": "object", "properties": { "BankNumber": { "type": [ "null", "integer" ], "description": "Israeli bank number\nFor instance, 12 indicates Bank Hapoalim.", "format": "int64" }, "BranchNumber": { "type": [ "null", "integer" ], "description": "Israeli bank branch number", "format": "int64" }, "AccountNumber": { "type": [ "null", "string" ], "description": "Bank account number" }, "ChequeNumber": { "type": [ "null", "string" ], "description": "Cheque number" }, "DueDate": { "type": [ "null", "string" ], "description": "Due date", "format": "date-time" } }, "additionalProperties": false }, "Accounting_Typed_Payment_CreditCard": { "type": "object", "properties": { "CardBrand": { "type": [ "null", "string" ], "description": "Credit card brand" }, "Last4Digits": { "type": [ "null", "string" ], "description": "Last 4 credit card digits" }, "FirstPayment": { "type": [ "null", "number" ], "description": "First payment amount\nOptional", "format": "double" }, "EachPayment": { "type": [ "null", "number" ], "description": "Each payment amount (excluding first payment)\nOptional", "format": "double" }, "Payments": { "type": [ "null", "integer" ], "description": "Credit card payments count (defaults to 1)", "format": "int64" } }, "additionalProperties": false }, "Accounting_Typed_Payment_Digital": { "type": "object", "properties": { "Type": { "type": [ "null", "string" ], "description": "Digital payment type" }, "Description": { "type": [ "null", "string" ], "description": "Digital payment description" } }, "additionalProperties": false }, "Accounting_Typed_Payment_General": { "type": "object", "additionalProperties": false }, "Accounting_Typed_Payment_Other": { "type": "object", "properties": { "Type": { "type": [ "null", "string" ], "description": "Payment type" }, "Description": { "type": [ "null", "string" ], "description": "Payment description" }, "DueDate": { "type": [ "null", "string" ], "description": "Due date", "format": "date-time" } }, "additionalProperties": false }, "Accounting_Typed_Payment_TaxWithholding": { "type": "object", "additionalProperties": false }, "Accounting_Typed_Supplier": { "type": "object", "properties": { "ID": { "type": [ "null", "integer" ], "description": "SUMIT identifier\nLeave empty to create a new entity or search by other fields when applicable", "format": "int64" }, "Folder": { "type": [ "null", "string" ], "description": "Folder identifier.\nCan be either application folder name, or FolderID." }, "Properties": { "type": [ "null", "object" ], "additionalProperties": { "type": "null" }, "description": "Entity fields" }, "Name": { "type": [ "null", "string" ], "description": "Customer full name (or company name)\nRequired for creating new customer\n(Leave empty to search by other fields)" }, "Phone": { "type": [ "null", "string" ], "description": "Customer phone number (Optional field)" }, "EmailAddress": { "type": [ "null", "string" ], "description": "Customer email address (Optional field)" }, "City": { "type": [ "null", "string" ], "description": "Customer city (Optional field)" }, "Address": { "type": [ "null", "string" ], "description": "Customer address (Optional field)" }, "ZipCode": { "type": [ "null", "string" ], "description": "Customer ZipCode (Optional field)" }, "CompanyNumber": { "type": [ "null", "string" ], "description": "Customer registered company number (VAT number) (Optional field)" }, "ExternalIdentifier": { "type": [ "null", "string" ], "description": "Customer external identifier.\nExternal identifier from calling application.\nOptional field" }, "NoVAT": { "type": [ "null", "boolean" ], "description": "NoVAT indication\nSet to true for VAT exempt customers\nDefaults to False" }, "SearchMode": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_CustomerSearchMode" } ], "description": "Customer searching mode\nDefaults to None" } }, "additionalProperties": { } }, "Books_Transactions_CreateBatch_Request": { "required": [ "BatchDescription", "Credentials", "Transactions" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "DatabaseID": { "type": "integer", "description": "Database identifier", "format": "int64" }, "BatchDescription": { "minLength": 1, "type": "string", "description": "Batch description" }, "Transactions": { "type": "array", "items": { "$ref": "#/components/schemas/Books_Typed_CreateBatchTransaction" } } }, "additionalProperties": false }, "Books_Transactions_CreateBatch_Response": { "type": "object", "properties": { "BatchURL": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "Books_Typed_CreateBatchTransaction": { "type": "object", "properties": { "Reference1": { "type": [ "null", "string" ], "description": "אסמכתא 1" }, "Reference2": { "type": [ "null", "string" ], "description": "אסמכתא 2" }, "ReferenceDate": { "type": [ "null", "string" ], "description": "תאריך אסמכתא", "format": "date-time" }, "ValueDate": { "type": [ "null", "string" ], "description": "תאריך ערך", "format": "date-time" }, "DebitAccountCode": { "type": [ "null", "string" ], "description": "מפתח חשבון חובה" }, "CreditAccountCode": { "type": [ "null", "string" ], "description": "מפתח חשבון זכות" }, "AmountILS": { "type": [ "null", "number" ], "description": "סכום התנועה בש\"ח", "format": "double" }, "Details": { "type": [ "null", "string" ], "description": "פרטים" } }, "additionalProperties": false }, "ContentLanguage": { "enum": [ "he", "en", "es", "ar", "ru" ], "type": "string" }, "Core_APICredentials": { "required": [ "APIKey", "CompanyID" ], "type": "object", "properties": { "CompanyID": { "type": "integer", "description": "Company identifier", "format": "int64" }, "APIKey": { "minLength": 1, "type": "string", "description": "API key secret" } }, "additionalProperties": false }, "Core_APIEmptyResponse": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." } }, "additionalProperties": false }, "Core_APIPublicCredentials": { "type": "object", "properties": { "CompanyID": { "type": "integer", "description": "Company identifier", "format": "int64" }, "APIPublicKey": { "type": [ "null", "string" ], "description": "API public key" } }, "additionalProperties": false }, "Core_Typed.Entity": { "type": "object", "properties": { "ID": { "type": [ "null", "integer" ], "description": "SUMIT identifier\nLeave empty to create a new entity or search by other fields when applicable", "format": "int64" }, "Folder": { "type": [ "null", "string" ], "description": "Folder identifier.\nCan be either application folder name, or FolderID." }, "Properties": { "type": [ "null", "object" ], "additionalProperties": { "type": "null" }, "description": "Entity fields" } }, "additionalProperties": { } }, "Core_Typed.Filter": { "type": "object", "properties": { "Property": { "type": [ "null", "string" ], "description": "Property to filter\nSupports either property identifier (numeric) or property name" }, "Value": { "type": "null", "description": "Filter value\nSupports array with multiple values as well" }, "DateRange_From": { "type": [ "null", "string" ], "format": "date-time" }, "DateRange_To": { "type": [ "null", "string" ], "format": "date-time" }, "Negative": { "type": [ "null", "boolean" ], "description": "Negative filter (excludes values)\nDefaults to false." } }, "additionalProperties": false }, "Core_Typed.Order": { "type": "object", "properties": { "Property": { "type": [ "null", "string" ], "description": "Property to order by (sort)" }, "Descending": { "type": [ "null", "boolean" ], "description": "Sort ascending/descending\nDefaults to ascending" } }, "additionalProperties": false }, "Core_Typed.Paging": { "type": "object", "properties": { "StartIndex": { "type": [ "null", "integer" ], "description": "Paging start index", "format": "int32" }, "PageSize": { "type": [ "null", "integer" ], "description": "Returned entities count.\nDefaults to 10, minimum of 10, maximum of 1000.", "format": "int32" } }, "additionalProperties": false }, "CreditGuy_Billing_GetStatus_Request": { "required": [ "BillingIdentifier", "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "BillingIdentifier": { "minLength": 1, "type": "string", "description": "Unique billing process identifier" }, "ListTransactions": { "type": [ "null", "boolean" ], "description": "Include detailed list per transaction\nDefaults to false" } }, "additionalProperties": false }, "CreditGuy_Billing_GetStatus_Response": { "type": "object", "properties": { "Transmit_Pending": { "type": "integer", "description": "Transactions pending transmit", "format": "int64" }, "Transmit_Failed": { "type": "integer", "description": "Transactions failed on Shva", "format": "int64" }, "Deposit_Pending": { "type": "integer", "description": "Transactions successfully deposited on Shva", "format": "int64" }, "Deposit_Failed": { "type": "integer", "description": "Transactions failed while depositing on Shva", "format": "int64" }, "Deposit_Finished": { "type": "integer", "description": "Transactions deposited successfully on Shva", "format": "int64" }, "Finished": { "type": "boolean", "description": "Indication whether the billing process has finished" }, "Transactions": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CreditGuy_Billing_GetStatus_Response_GetStatus_Response_Transaction" }, "description": "Detailed list of transactions (Returned when ListTransactions = true)" } }, "additionalProperties": false }, "CreditGuy_Billing_GetStatus_Response_GetStatus_Response_Transaction": { "type": "object", "properties": { "ID": { "type": "integer", "description": "SUMIT transaction identifier", "format": "int64" }, "CheckoutIndex": { "type": [ "null", "string" ], "description": "Checkout index (Voucher number part 1)" }, "CheckoutRecordIndex": { "type": [ "null", "string" ], "description": "Checkout record index (Voucher number part 2)" }, "ReferenceNumber": { "type": [ "null", "integer" ], "description": "Reference number (Deposit identifier)", "format": "int64" }, "AuthNumber": { "type": [ "null", "string" ], "description": "Authorization number" }, "UniqueIdentifier": { "type": [ "null", "string" ], "description": "Unique transaction identifier, as input during Load" }, "Status": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CreditGuy.Typed.TransactionStatus" } ], "description": "Transaction status" }, "ResultCode": { "type": [ "null", "string" ], "description": "Transaction Shva result code" } }, "additionalProperties": false }, "CreditGuy_Billing_Load_Request": { "required": [ "BillingIdentifier", "Credentials", "Transactions" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "BillingIdentifier": { "minLength": 1, "type": "string", "description": "Unique billing process identifier" }, "Transactions": { "type": "array", "items": { "$ref": "#/components/schemas/CreditGuy_Billing_Load_Request_Load_Request_Transaction" }, "description": "Billing transactions to be loaded." } }, "additionalProperties": false }, "CreditGuy_Billing_Load_Request_Load_Request_Transaction": { "required": [ "Amount", "ExpirationMonth", "ExpirationYear" ], "type": "object", "properties": { "FormatPreservingToken": { "type": [ "null", "string" ], "description": "Format preserving card number\nLeave this empty when using CardToken" }, "CardToken": { "type": [ "null", "string" ], "description": "Card token\nLeave this empty when using FormatPreservingToken", "format": "uuid" }, "ExpirationMonth": { "type": "integer", "description": "Card expiration month (1-12)", "format": "int32" }, "ExpirationYear": { "type": "integer", "description": "Card expiration year (4 digits)", "format": "int32" }, "Amount": { "type": "number", "description": "Transaction amount", "format": "double" }, "PaymentsNonFirstCount": { "type": [ "null", "integer" ], "description": "Non-first payments count\nLeave this empty for non-payments transaction", "format": "int32" }, "PaymentsFirstAmount": { "type": [ "null", "number" ], "description": "First payment amount\nLeave this empty for non-payments transaction", "format": "double" }, "PaymentsNonFirstAmount": { "type": [ "null", "number" ], "description": "Non-first payment amount\nLeave this empty for non-payments transaction", "format": "double" }, "AuthNumber": { "type": [ "null", "string" ], "description": "Transaction authorization number\nLeave this empty for J4+J5" }, "CitizenID": { "type": [ "null", "string" ], "description": "Israel Citizen ID / Passport Number" }, "Currency": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Typed_Currency" } ], "description": "Transaction currency\nDefaults to ILS" }, "UniqueIdentifier": { "type": [ "null", "string" ], "description": "Unique transaction identifier.\nThis parameter can be used for preventing duplicate transactions" }, "MerchantNumber": { "type": [ "null", "string" ], "description": "Shva merchant number (Terminal number).\nThis parameter should only be used when multiple merchants are defined in the company." }, "CustomData_1": { "type": [ "null", "string" ], "description": "Custom data #1" }, "CustomData_2": { "type": [ "null", "string" ], "description": "Custom data #2" }, "CustomData_3": { "type": [ "null", "string" ], "description": "Custom data #3" }, "CustomData_4": { "type": [ "null", "string" ], "description": "Custom data #4" }, "CustomData_5": { "type": [ "null", "string" ], "description": "Custom data #5" } }, "additionalProperties": false }, "CreditGuy_Billing_Load_Response": { "type": "object", "properties": { "TransactionIDs": { "type": [ "null", "array" ], "items": { "type": "integer", "format": "int64" }, "description": "Loaded transactions identifiers" } }, "additionalProperties": false }, "CreditGuy_Billing_Process_Request": { "required": [ "BillingIdentifier", "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "BillingIdentifier": { "minLength": 1, "type": "string", "description": "Unique billing process identifier" } }, "additionalProperties": false }, "CreditGuy_Billing_Process_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Billing_Process_Response_Process_Response_Status" } ], "description": "Process status" } }, "additionalProperties": false }, "CreditGuy_Billing_Process_Response_Process_Response_Status": { "enum": [ "Started", "Processing", "Processed" ], "type": "string" }, "CreditGuy_Gateway_BeginRedirect_Request": { "required": [ "Credentials", "Mode" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Mode": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CreditGuy.Typed.ExternalTokenizeMode" } ], "description": "Transaction type" }, "Amount": { "type": [ "null", "number" ], "description": "Transaction amount", "format": "double" }, "PaymentsNonFirstCount": { "type": [ "null", "integer" ], "description": "Non-first payments count\nLeave this empty for non-payments transaction", "format": "int32" }, "PaymentsFirstAmount": { "type": [ "null", "number" ], "description": "First payment amount\nLeave this empty for non-payments transaction", "format": "double" }, "PaymentsNonFirstAmount": { "type": [ "null", "number" ], "description": "Non-first payment amount\nLeave this empty for non-payments transaction", "format": "double" }, "Currency": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Typed_Currency" } ], "description": "Transaction currency\nDefaults to ILS" }, "Identifier": { "type": [ "null", "string" ], "description": "Transaction identifier.\nThis parameter will be returned during redirect." }, "MerchantNumber": { "type": [ "null", "string" ], "description": "Shva merchant number (Terminal number).\nThis parameter should only be used when multiple merchants are defined in the company." }, "RedirectURL": { "type": [ "null", "string" ], "description": "Redirect URL\nLeave this empty to use the default RedirectURL" } }, "additionalProperties": false }, "CreditGuy_Gateway_BeginRedirect_Response": { "type": "object", "properties": { "RedirectURL": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "CreditGuy_Gateway_GetReferenceNumbers_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APIPublicCredentials" } ], "description": "Company API public credentials" }, "IDs": { "type": [ "null", "array" ], "items": { "type": "integer", "format": "int64" }, "description": "Transaction IDs (Maximum of 1000 identifiers)" }, "UniqueIdentifiers": { "type": [ "null", "array" ], "items": { "type": "string" }, "description": "Unique transaction identifer (Maximum of 1000 identifiers)" } }, "additionalProperties": false }, "CreditGuy_Gateway_GetReferenceNumbers_Response": { "type": "object", "properties": { "ReferenceNumbers_ByID": { "type": [ "null", "array" ], "items": { "type": "integer", "format": "int64" }, "description": "Sequential list of all reference numbers for the given transaction ids" }, "ReferenceNumbers_ByUniqueIdentifier": { "type": [ "null", "array" ], "items": { "type": "integer", "format": "int64" }, "description": "Sequential list of all reference numbers for the given unique transaction identifiers" } }, "additionalProperties": false }, "CreditGuy_Gateway_GetTransaction_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APIPublicCredentials" } ], "description": "Company API public credentials" }, "ID": { "type": [ "null", "integer" ], "description": "Transaction ID", "format": "int64" }, "UniqueIdentifier": { "type": [ "null", "string" ], "description": "Unique transaction identifer" }, "IncludeFirstDigits": { "type": [ "null", "boolean" ], "description": "Indicates whether to fetch the first 2/6 digits of the card number as well.\nDefaults to False" } }, "additionalProperties": false }, "CreditGuy_Gateway_GetTransaction_Response": { "type": "object", "properties": { "Code": { "type": [ "null", "string" ], "description": "Shva result code" }, "Description": { "type": [ "null", "string" ], "description": "Shva result description" }, "MerchantNumber": { "type": [ "null", "string" ], "description": "Shva merchant number (Terminal number)" }, "AuthNumber": { "type": [ "null", "string" ], "description": "Charge authorization number" }, "Acquirer": { "type": [ "null", "integer" ], "description": "Card acquirer", "format": "int64" }, "Brand": { "type": [ "null", "integer" ], "description": "Card brand", "format": "int64" }, "Issuer": { "type": [ "null", "integer" ], "description": "Card issuer", "format": "int64" }, "FileNumber": { "type": [ "null", "string" ], "description": "Shva file number" }, "CheckoutIndex": { "type": [ "null", "string" ], "description": "Shva checkout index" }, "CheckoutRecordIndex": { "type": [ "null", "string" ], "description": "Shva checkout record index" }, "ReferenceNumber": { "type": [ "null", "integer" ], "description": "Shva reference number", "format": "int64" }, "CardToken": { "type": [ "null", "string" ], "description": "Card token", "format": "uuid" }, "CardFPToken": { "type": [ "null", "string" ], "description": "Format preserved token" }, "CardPattern": { "type": [ "null", "string" ], "description": "Card number pattern (including the last 4 digits)" }, "CardExpiration": { "type": "string", "description": "Credit card expiration", "format": "date-time" }, "CitizenID": { "type": [ "null", "string" ], "description": "Israeli Citizen ID / Passport Number" }, "ResultRecord": { "type": [ "null", "string" ], "description": "Full result record received from Shva" }, "Amount": { "type": "number", "description": "Transaction amount\nLeave this empty when using ParamJ = CheckDetails", "format": "double" }, "PaymentsNonFirstCount": { "type": [ "null", "integer" ], "description": "Non-first payments count\nLeave this empty for non-payments transaction", "format": "int32" }, "PaymentsFirstAmount": { "type": [ "null", "number" ], "description": "First payment amount\nLeave this empty for non-payments transaction", "format": "double" }, "PaymentsNonFirstAmount": { "type": [ "null", "number" ], "description": "Non-first payment amount\nLeave this empty for non-payments transaction", "format": "double" }, "ResultForeignCard": { "type": "boolean" }, "EMV": { "type": "boolean" }, "MultiSupplierNumber": { "type": [ "null", "string" ], "description": "Supplier number when using a multi supplier terminal" } }, "additionalProperties": false }, "CreditGuy_Gateway_Transaction_Request": { "required": [ "Credentials", "ParamJ" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "ParamJ": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CreditGuy.Typed.ParamJ" } ], "description": "Transaction type" }, "CardNumber": { "type": [ "null", "string" ], "description": "Full card number\nLeave this empty when using FormatPreservingToken/CardToken/SingleUseToken" }, "FormatPreservingToken": { "type": [ "null", "string" ], "description": "Format preserving card number\nLeave this empty when using CardNumber/CardToken/SingleUseToken" }, "CardToken": { "type": [ "null", "string" ], "description": "Card token\nLeave this empty when using CardNumber/FormatPreservingToken/SingleUseToken", "format": "uuid" }, "SingleUseToken": { "type": [ "null", "string" ], "description": "Single use token, for all payment details (CardNumber, Expiration, CVV, CitizenID).\nUsed primarily by the Payments JavaScript API.\n(Leave this empty when using CardNumber/FormatPreservingToken/CardToken)" }, "ExpirationMonth": { "type": [ "null", "integer" ], "description": "Card expiration month (1-12)\nLeave this empty when using SingleUseToken", "format": "int32" }, "ExpirationYear": { "type": [ "null", "integer" ], "description": "Card expiration year (4 digits)\nLeave this empty when using SingleUseToken", "format": "int32" }, "Amount": { "type": "number", "description": "Transaction amount\nLeave this empty when using ParamJ = CheckDetails", "format": "double" }, "PaymentsNonFirstCount": { "type": [ "null", "integer" ], "description": "Non-first payments count\nLeave this empty for non-payments transaction", "format": "int32" }, "PaymentsFirstAmount": { "type": [ "null", "number" ], "description": "First payment amount\nLeave this empty for non-payments transaction", "format": "double" }, "PaymentsNonFirstAmount": { "type": [ "null", "number" ], "description": "Non-first payment amount\nLeave this empty for non-payments transaction", "format": "double" }, "AuthNumber": { "type": [ "null", "string" ], "description": "Transaction authorization number" }, "CVV": { "type": [ "null", "string" ], "description": "Card CVV/CVV2" }, "Track2": { "type": [ "null", "string" ], "description": "Card Track2" }, "CitizenID": { "type": [ "null", "string" ], "description": "Israel Citizen ID / Passport Number" }, "Currency": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Typed_Currency" } ], "description": "Transaction currency\nDefaults to ILS" }, "Language": { "type": [ "null", "string" ], "description": "Transaction language\nLeave this empty to use the company default language" }, "UniqueIdentifier": { "type": [ "null", "string" ], "description": "Unique transaction identifier.\nThis parameter can be used for preventing duplicate transactions" }, "MerchantNumber": { "type": [ "null", "string" ], "description": "Shva merchant number (Terminal number).\nThis parameter should only be used when multiple merchants are defined in the company." }, "TransactionType": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CreditGuy.Typed.TransactionType" } ], "description": "Transaction type. This allows crediting or cancelling existing transaction.\nDefaults to Debit" }, "CustomData_1": { "type": [ "null", "string" ], "description": "Custom user supplied data\nSupports up to 100 chars in each field" }, "CustomData_2": { "type": [ "null", "string" ], "description": "Custom user supplied data\nSupports up to 100 chars in each field" }, "CustomData_3": { "type": [ "null", "string" ], "description": "Custom user supplied data\nSupports up to 100 chars in each field" }, "CustomData_4": { "type": [ "null", "string" ], "description": "Custom user supplied data\nSupports up to 100 chars in each field" }, "CustomData_5": { "type": [ "null", "string" ], "description": "Custom user supplied data\nSupports up to 100 chars in each field" }, "MultiSupplierNumber": { "type": [ "null", "string" ], "description": "Supplier number when using a multi supplier terminal" } }, "additionalProperties": false }, "CreditGuy_Gateway_Transaction_Response": { "type": "object", "properties": { "Success": { "type": "boolean", "description": "Is valid transaction" }, "ResultCode": { "type": [ "null", "string" ], "description": "Shva result code (000 is valid)" }, "ResultDescription": { "type": [ "null", "string" ], "description": "Shva result description" }, "TransactionID": { "type": "integer", "description": "CreditGuy transaction identifier", "format": "int64" }, "FileNumber": { "type": [ "null", "string" ], "description": "Shva file number" }, "CheckoutIndex": { "type": [ "null", "string" ], "description": "Shva checkout index" }, "CheckoutRecordIndex": { "type": [ "null", "string" ], "description": "Shva checkout record index" }, "Acquirer": { "type": [ "null", "integer" ], "description": "Card acquirer", "format": "int64" }, "Brand": { "type": [ "null", "integer" ], "description": "Card brand", "format": "int64" }, "Issuer": { "type": [ "null", "integer" ], "description": "Card issuer", "format": "int64" }, "AuthNumber": { "type": [ "null", "string" ], "description": "Charge authorization number" }, "CardToken": { "type": [ "null", "string" ], "description": "Card token, this field may be stored on non-pci compliant systems", "format": "uuid" }, "ExpirationMonth": { "type": [ "null", "integer" ], "description": "Card expiration month (1-12), this field may be stored on non-pci compliant systems", "format": "int32" }, "ExpirationYear": { "type": [ "null", "integer" ], "description": "Card expiration year (4 digits), this field may be stored on non-pci compliant systems", "format": "int32" }, "CitizenID": { "type": [ "null", "string" ], "description": "Israel Citizen ID / Passport Number, this field may be stored on non pci-compliant systems" }, "CardPattern": { "type": [ "null", "string" ], "description": "Card number pattern (including the last 4 digits)" } }, "additionalProperties": false }, "CreditGuy_Typed_Currency": { "enum": [ "ILS (0)", "USD (1)", "EURO (2)" ], "type": "string" }, "CreditGuy_Vault_TokenizeSingleUse_Request": { "required": [ "CardNumber", "Credentials", "ExpirationMonth", "ExpirationYear" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APIPublicCredentials" } ], "description": "Company API public credentials" }, "CardNumber": { "minLength": 1, "type": "string", "description": "Full card number to tokenize" }, "ExpirationMonth": { "type": "integer", "description": "Card expiration month (1-12).", "format": "int32" }, "ExpirationYear": { "type": "integer", "description": "Card expiration year (4 digits).", "format": "int32" }, "CVV": { "type": [ "null", "string" ], "description": "Card CVV/CVV2." }, "CitizenID": { "type": [ "null", "string" ], "description": "Israel Citizen ID / Passport Number." } }, "additionalProperties": false }, "CreditGuy_Vault_TokenizeSingleUse_Response": { "type": "object", "properties": { "SingleUseToken": { "type": [ "null", "string" ], "description": "Token for single use. \nThis token can be used on the Transaction action, without specifying Expiration, CVV and CitizenID." } }, "additionalProperties": false }, "CreditGuy_Vault_Tokenize_Request": { "required": [ "CardNumber", "Credentials", "ForceFormatPreservingToken" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "GetFormatPreserving": { "type": [ "null", "boolean" ], "description": "Should tokenize method also return format preserved token, or only Guid token\nDefaults to False" }, "CardNumber": { "minLength": 1, "type": "string", "description": "Full card number to tokenize" }, "ForceFormatPreservingToken": { "minLength": 1, "type": "string", "description": "Forced format preserving token\nThis can be useful when migrating from another credit card gateway to OfficeGuy.\nPlease note the format preserving token should be a RANDOM identifier, which can't be reverse engineered into the card number (encoding/encrypting etc. isn't supported)." } }, "additionalProperties": false }, "CreditGuy_Vault_Tokenize_Response": { "type": "object", "properties": { "Token": { "type": [ "null", "string" ], "description": "Card token", "format": "uuid" }, "FormatPreservingToken": { "type": [ "null", "string" ], "description": "Format preserved token\nReturned when GetFormatPreserving is used" } }, "additionalProperties": false }, "CustomerService_Tickets_Create_Response": { "type": "object", "properties": { "TicketID": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Deals_Deals_AddDeal_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Title": { "type": [ "null", "string" ] }, "Customer": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Customer" } ] }, "ExpectedCloseDate": { "type": [ "null", "string" ], "format": "date-time" }, "StageID": { "type": "integer", "format": "int64" }, "LeadSource": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "Deals_Deals_AddDeal_Response": { "type": "object", "properties": { "DealID": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Deals_Deals_CreateRemark_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "DealID": { "type": "integer", "format": "int64" }, "Content": { "type": [ "null", "string" ] }, "Username": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "Deals_Deals_CreateRemark_Response": { "type": "object", "properties": { "RemarkID": { "type": "integer", "description": "RemarkID", "format": "int64" } }, "additionalProperties": false }, "EmailSubscriptions_MailingLists_Add_Request": { "required": [ "Credentials", "EmailAddress", "MailingListID" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "MailingListID": { "type": "integer", "format": "int64" }, "EmailAddress": { "minLength": 1, "type": "string" }, "Name": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "EmailSubscriptions_MailingLists_Add_Response": { "type": "object", "additionalProperties": false }, "EmailSubscriptions_MailingLists_List_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" } }, "additionalProperties": false }, "EmailSubscriptions_MailingLists_List_Response": { "type": "object", "properties": { "MailingLists": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/EmailSubscriptions_Typed_MailingList" } } }, "additionalProperties": false }, "EmailSubscriptions_Typed_MailingList": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int64" }, "Name": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "Fax_Fax_Send_Request": { "required": [ "Credentials", "FaxNumber", "FileBytes", "Filename" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "FaxNumber": { "minLength": 1, "type": "string" }, "FileBytes": { "minLength": 1, "type": "string" }, "Filename": { "minLength": 1, "type": "string" }, "SaveDraft": { "type": [ "null", "boolean" ] } }, "additionalProperties": false }, "Fax_Fax_Send_Response": { "type": "object", "properties": { "EntityID": { "type": "integer", "format": "int64" }, "EstimatedQuota": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "OfficeGuy.Apps.Accounting.Typed.DebtSettlementSource": { "enum": [ "TaxInvoice (1)", "ProformaInvoice (2)", "PaymentRequest (3)", "Receipt (4)", "ProformaInvoicePaymentRequest (5)", "ProformaInvoicePaymentRequestTaxInvoice (6)" ], "type": "string" }, "OfficeGuy.Apps.Accounting.Typed.DocumentsTheme": { "enum": [ "White (1)", "Orange (2)", "Green (3)", "Purple (4)", "Material (5)", "SumitClean (15)", "SumitStandard (16)", "Sharon (20)" ], "type": "string" }, "OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_OpenUpayTerminal_Request": { "required": [ "AccountNumber", "BankCode", "BranchCode", "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "BankCode": { "type": "integer", "description": "Bank code", "format": "int32" }, "BranchCode": { "type": "integer", "description": "Bank branch code", "format": "int32" }, "AccountNumber": { "minLength": 1, "type": "string", "description": "Bank account number" }, "Program": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.UpayProgram" } ], "description": "Upay program\nDefaults to the OFFICEGUYNEW10 program (1.5% without payments clearing)" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_OpenUpayTerminal_Response": { "type": "object", "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_SetUpayCredentials_Request": { "required": [ "Credentials", "EmailAddress", "Password" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "EmailAddress": { "minLength": 1, "type": "string", "description": "Upay Email Address (Username)" }, "Password": { "minLength": 1, "type": "string", "description": "Upay Password" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_SetUpayCredentials_Response": { "type": "object", "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_GetForCustomer_Request": { "required": [ "Credentials", "Customer" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Customer": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Customer" } ], "description": "Customer details" }, "IncludeInactive": { "type": "boolean", "description": "Indicates whether to also list inactive payment methods\nDefaults to false" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_GetForCustomer_Response": { "type": "object", "properties": { "PaymentMethod": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.PaymentMethod" } ], "description": "Payment method" }, "InactivePaymentMethods": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.PaymentMethod" }, "description": "Inactive payment methods\nPlease note this list will only be returned when specifying IncludeInactive = true" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_Remove_Request": { "required": [ "Credentials", "Customer" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Customer": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Customer" } ], "description": "Customer details" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_Remove_Response": { "type": "object", "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_SetForCustomer_Request": { "required": [ "Credentials", "Customer" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Customer": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Customer" } ], "description": "Customer details" }, "PaymentMethod": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.PaymentMethod" } ], "description": "Payment method" }, "SingleUseToken": { "type": [ "null", "string" ], "description": "Single use token, for all payment details (CardNumber, Expiration, CVV, CitizenID).\nUsed primarily by the Payments JavaScript API." } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_SetForCustomer_Response": { "type": "object", "properties": { "CustomerID": { "type": "integer", "description": "Customer ID", "format": "int64" }, "PaymentMethod": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.PaymentMethod" } ], "description": "Payment method" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_BeginRedirect_Request": { "required": [ "Credentials", "Customer", "Items" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Customer": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Customer" } ], "description": "Customer" }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.ChargeItem" }, "description": "Items" }, "VATIncluded": { "type": [ "null", "boolean" ], "description": "Is VAT included in the prices?\nLeave empty for false.\nRelevant for items only." }, "VATRate": { "type": [ "null", "number" ], "description": "Document VAT Rate\nLeave empty for company default.", "format": "double" }, "DocumentType": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentType" } ], "description": "Created document type\nLeave empty for default" }, "RedirectURL": { "type": [ "null", "string" ], "description": "URL to redirect the user on successful payment.\nThe following parameters will be added to the URL:\nOG-CustomerID: Customer identifier\nOG-PaymentID: Payment identifier\nOG-ExternalIdentifier: The original ExternalIdentifier\nWhen empty, the user will be redirected to the customer payments history page" }, "CancelRedirectURL": { "type": [ "null", "string" ], "description": "URL to redirect the user on cancelled payment.\nThe following parameters will be added to the URL:\nOG-ExternalIdentifier: The original ExternalIdentifier\nWhen empty, the user will be redirected to the payment page" }, "ExternalIdentifier": { "type": [ "null", "string" ], "description": "External identifier.\nThis identifier will be appended to the RedirectURL on successful payment." }, "MaximumPayments": { "type": [ "null", "integer" ], "description": "Maximum payments (installments) allowed on the payment page.\nBy default, the maximum payments count is set according to the purchase pages application settings.\nSet to 0 to disable payments.", "format": "int32" }, "MinimumPaymentsCredit": { "type": [ "null", "integer" ], "description": "When allowing installments, this sets the minimum number of payments, from which payments would be offered as credit transaction.", "format": "int32" }, "SendUpdateByEmailAddress": { "type": [ "null", "string" ], "description": "Email address to which the result document will be created following payments." }, "ExpirationHours": { "type": [ "null", "integer" ], "description": "Number of hours, in which the direct URL will expire.\nDefaults to 1 hours. Maximum of 240 hours (10 days).", "format": "int32" }, "Language": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Language" } ], "description": "Payment page language\nDefaults to Hebrew" }, "Header": { "type": [ "null", "string" ], "description": " Payment page header\nDefaults to the company name" }, "UpdateOrganizationOnSuccess": { "type": [ "null", "boolean" ], "description": "Send payment notification to organization on successful payment" }, "UpdateOrganizationOnFailure": { "type": [ "null", "boolean" ], "description": "Send payment notification to organization on failed payment" }, "UpdateCustomerOnSuccess": { "type": [ "null", "boolean" ], "description": "Send payment notification to customer on successful payment." }, "DocumentDescription": { "type": [ "null", "string" ], "description": "Document description (the description is printed on the document)" }, "DraftDocument": { "type": [ "null", "boolean" ], "description": "Create draft document?\nLeave empty to use the application setting.\nPlease note, when using AuthoriseOnly, documents will always be issued as \"Draft\"." }, "PreventSavingPaymentMethod": { "type": [ "null", "boolean" ], "description": "Prevents saving the payment method as the default payment method for the customer, following successful payment.\nDefaults to False" }, "MerchantNumber": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_BeginRedirect_Response": { "type": "object", "properties": { "RedirectURL": { "type": [ "null", "string" ], "description": "Payment page URL.\nRedirect your user to this page, in order to continue the payment process." } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Charge_Request": { "required": [ "Credentials", "Customer", "Items" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Customer": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Customer" } ], "description": "Customer" }, "PaymentMethod": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.PaymentMethod" } ], "description": "Payment method details\nLeave this empty to use the customer payment method, or when using the SingleUseToken" }, "SingleUseToken": { "type": [ "null", "string" ], "description": "Single use token, for all payment details (CardNumber, Expiration, CVV, CitizenID).\nUsed primarily by the Payments JavaScript API." }, "CreditCardAuthNumber": { "type": [ "null", "string" ], "description": "Transaction authorization number, as received from a previous Gateway Transaction" }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.ChargeItem" }, "description": "Items" }, "Payments_Credit": { "type": [ "null", "boolean" ], "description": "Credit payments (עסקת קרדיט באשראי)\nDefaults to False" }, "Payments_Count": { "type": [ "null", "integer" ], "description": "Payments count\nLeave this empty to disable payments", "format": "int64" }, "Payments_FirstAmount": { "type": [ "null", "number" ], "description": "First payment amount\nLeave this empty to disable payments / automatic payments calculating", "format": "double" }, "Payments_NonFirstAmount": { "type": [ "null", "number" ], "description": "Non-first payment amount\nLeave this empty to disable payments / automatic payments calculating", "format": "double" }, "UpdateCustomerByEmail": { "type": [ "null", "boolean" ], "description": "Update customer by email (notification email, with invoice/receipt download link)\nLeave this empty to disable email sending feature" }, "UpdateCustomerByEmail_AttachDocument": { "type": [ "null", "boolean" ], "description": "Attach invoice/receipt to email\nDefaults to False" }, "UpdateCustomerByEmail_Language": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Language" } ], "description": "Update email language\nDefaults to the company language" }, "SendDocumentByEmail": { "type": [ "null", "boolean" ], "description": "Send invoice/receipt by email" }, "DocumentLanguage": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Language" } ], "description": "Document language\nDefaults to the company language" }, "DocumentDescription": { "type": [ "null", "string" ], "description": "Document description (the description is printed on the document)" }, "VATIncluded": { "type": [ "null", "boolean" ], "description": "Is VAT included in the prices?\nDefaults to false" }, "VATRate": { "type": [ "null", "number" ], "description": "Document VAT Rate\nLeave empty for company default.\nRelevant for items only.", "format": "double" }, "AuthoriseOnly": { "type": [ "null", "boolean" ], "description": "Should the transaction be processed, or only validated.\nLeave empty for \"False\" (Auto-Commit).\nThis field could be used for testing the Charge action easily.\nPlease note, when using AuthoriseOnly, documents will be issued as \"Draft\"." }, "DraftDocument": { "type": [ "null", "boolean" ], "description": "Create draft document?\nLeave empty to use the application setting.\nPlease note, when using AuthoriseOnly, documents will always be issued as \"Draft\"." }, "PreventDocumentCreation": { "type": [ "null", "boolean" ], "description": "Prevents document creation following valid payment\nBy default, all valid payments issue documents (final, or draft according to the DraftDocument parameter).\nSetting PreventDocumentCreation will prevent the automatic document creation." }, "DocumentType": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentType" } ], "description": "Create document type\nLeave empty for default" }, "SupportCredit": { "type": [ "null", "boolean" ], "description": "Allow credit instead of charge (debit), in case the total is less than 0?\nDefaults to false" }, "MerchantNumber": { "type": [ "null", "string" ], "description": "Shva merchant number (Terminal number).\nThis parameter should only be used when multiple merchants are defined in the company." }, "SendCopyToOrganization": { "type": [ "null", "boolean" ], "description": "Send email to the organization as well.\nDefaults to the accounting application settings.\nRelevant when using either UpdateCustomerByEmail or SendDocumentByEmail." }, "CardTokenNotNeeded": { "type": [ "null", "boolean" ], "description": "Avoids generating credit card token and saving it on the customer payment method.\nDefaults to False" }, "AutoCapture": { "type": [ "null", "boolean" ], "description": "Should the credit card transaction be captured automatically (J4), or only authorized (J5).\nLeave empty for \"True\" (Auto capture).\nPlease note, when setting AutoCapture to false, \"Order\" documents will be issued instead of invoices/receipts." }, "AuthorizeAmount": { "type": [ "null", "number" ], "description": "Allows custom authorization amount, other than the specified items.", "format": "double" }, "PreventStandingOrder": { "type": [ "null", "boolean" ], "description": "Prevents the usage of Standing order recurring chargers, force using debit card merchant number, when multiple merchants are supported.\nDefaults to false." } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Charge_Response": { "type": "object", "properties": { "Payment": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.Payment" } ] }, "DocumentID": { "type": [ "null", "integer" ], "description": "Document ID (OfficeGuy identifier)", "format": "int64" }, "DocumentNumber": { "type": [ "null", "integer" ], "description": "Document number", "format": "int64" }, "CustomerID": { "type": [ "null", "integer" ], "description": "Customer number", "format": "int64" }, "DocumentDownloadURL": { "type": [ "null", "string" ], "description": "Document download URL\nProduced document will be original (on first fetching), or certified copy." } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Get_Request": { "required": [ "Credentials", "PaymentID" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "PaymentID": { "type": "integer", "description": "PaymentID\nReturned from the BeginRedirect or the Charge API methods", "format": "int64" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Get_Response": { "type": "object", "properties": { "Payment": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.Payment" } ] } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_List_Request": { "required": [ "Credentials", "Date_From", "Date_To" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Date_From": { "type": "string", "description": "Payments date range (from)", "format": "date-time" }, "Date_To": { "type": "string", "description": "Payments date range (to)", "format": "date-time" }, "Valid": { "type": [ "null", "boolean" ], "description": "List only valid/invalid payments" }, "StartIndex": { "type": "integer", "description": "Start index for paging", "format": "int32" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_List_Response": { "type": "object", "properties": { "Payments": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.Payment" } }, "HasNextPage": { "type": "boolean" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_MultiVendorCharge_Request": { "required": [ "Credentials", "Customer", "Items" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Customer": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Customer" } ], "description": "Customer" }, "PaymentMethod": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.PaymentMethod" } ], "description": "Payment method details\nLeave this empty to use the customer payment method, or when using the SingleUseToken" }, "SingleUseToken": { "type": [ "null", "string" ], "description": "Single use token, for all payment details (CardNumber, Expiration, CVV, CitizenID).\nUsed primarily by the Payments JavaScript API." }, "CreditCardAuthNumber": { "type": [ "null", "string" ], "description": "Transaction authorization number, as received from a previous Gateway Transaction" }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.MultiVendorChargeItem" }, "description": "Items" }, "Payments_Count": { "type": [ "null", "integer" ], "description": "Payments count\nLeave this empty to disable payments", "format": "int64" }, "Payments_FirstAmount": { "type": [ "null", "number" ], "description": "First payment amount\nLeave this empty to disable payments / automatic payments calculating", "format": "double" }, "Payments_NonFirstAmount": { "type": [ "null", "number" ], "description": "Non-first payment amount\nLeave this empty to disable payments / automatic payments calculating", "format": "double" }, "UpdateCustomerByEmail": { "type": [ "null", "boolean" ], "description": "Update customer by email (notification email, with invoice/receipt download link)\nLeave this empty to disable email sending feature" }, "UpdateCustomerByEmail_AttachDocument": { "type": [ "null", "boolean" ], "description": "Attach invoice/receipt to email\nDefaults to False" }, "UpdateCustomerByEmail_Language": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Language" } ], "description": "Update email language\nDefaults to the company language" }, "SendDocumentByEmail": { "type": [ "null", "boolean" ], "description": "Send invoice/receipt by email" }, "DocumentLanguage": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Language" } ], "description": "Document language\nDefaults to the company language" }, "DocumentDescription": { "type": [ "null", "string" ], "description": "Document description (the description is printed on the document)" }, "VATIncluded": { "type": [ "null", "boolean" ], "description": "Is VAT included in the prices?\nDefaults to false" }, "VATRate": { "type": [ "null", "number" ], "description": "Document VAT Rate\nLeave empty for company default.\nRelevant for items only.", "format": "double" }, "AuthoriseOnly": { "type": [ "null", "boolean" ], "description": "Should the transaction be processed, or only validated.\nLeave empty for \"False\" (Auto-Commit).\nThis field could be used for testing the Charge action easily.\nPlease note, when using AuthoriseOnly, documents will be issued as \"Draft\"." }, "DraftDocument": { "type": [ "null", "boolean" ], "description": "Create draft document?\nLeave empty to use the application setting.\nPlease note, when using AuthoriseOnly, documents will always be issued as \"Draft\"." }, "DocumentType": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentType" } ], "description": "Create document type\nLeave empty for default" }, "MerchantNumber": { "type": [ "null", "string" ], "description": "Shva merchant number (Terminal number).\nThis parameter should only be used when multiple merchants are defined in the company." }, "SendCopyToOrganization": { "type": [ "null", "boolean" ], "description": "Send email to the organization as well.\nDefaults to the accounting application settings.\nRelevant when using either UpdateCustomerByEmail or SendDocumentByEmail." }, "CardTokenNotNeeded": { "type": [ "null", "boolean" ], "description": "Avoids generating credit card token and saving it on the customer payment method.\nDefaults to False" }, "AutoCapture": { "type": [ "null", "boolean" ], "description": "Should the credit card transaction be captured automatically (J4), or only authorized (J5).\nLeave empty for \"True\" (Auto capture).\nPlease note, when setting AutoCapture to false, \"Order\" documents will be issued instead of invoices/receipts." }, "AuthorizeAmount": { "type": [ "null", "number" ], "description": "Allows custom authorization amount, other than the specified items.", "format": "double" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_MultiVendorCharge_Response": { "type": "object", "properties": { "Vendors": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Charge_Response" } } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Cancel_Request": { "required": [ "Credentials", "Customer", "RecurringCustomerItemID" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Customer": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Customer" } ], "description": "Customer" }, "RecurringCustomerItemID": { "type": "integer", "description": "Recurring customer item identifier (מזהה כרטיס הוראת קבע)", "format": "int64" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Cancel_Response": { "type": "object", "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Charge_Request": { "required": [ "Credentials", "Customer", "Items" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Customer": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Customer" } ], "description": "Customer" }, "PaymentMethod": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.PaymentMethod" } ], "description": "Payment method details\nLeave this empty to use the customer payment method, or when using the SingleUseToken" }, "SingleUseToken": { "type": [ "null", "string" ], "description": "Single use token, for all payment details (CardNumber, Expiration, CVV, CitizenID).\nUsed primarily by the Payments JavaScript API." }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.ChargeRecurringItem" }, "description": "Items" }, "UpdateCustomerByEmail": { "type": [ "null", "boolean" ], "description": "Update customer by email\nDefaults to False" }, "UpdateCustomerByEmail_AttachDocument": { "type": [ "null", "boolean" ], "description": "Attach invoice/receipt to email\nDefaults to False" }, "AuthoriseOnly": { "type": [ "null", "boolean" ], "description": "Should the transaction be committed, or authorized only.\nLeave empty for \"False\" (Auto-Commit).\nThis field could be used for testing the Charge action easily.\nPlease note, when using AuthoriseOnly, documents will be created as \"Draft\", and recurring items will be created as cancelled." }, "DocumentType": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentType" } ], "description": "Created document type\nLeave empty for default" }, "SendCopyToOrganization": { "type": [ "null", "boolean" ], "description": "Send email to the organization as well.\nDefaults to the accounting application settings.\nRelevant when using UpdateCustomerByEmail." }, "VATIncluded": { "type": [ "null", "boolean" ], "description": "Is VAT included in the prices?\nLeave empty for false.\nRelevant for items only." }, "AttributionOffset": { "type": [ "null", "integer" ], "description": "Attribution offset in months", "format": "int64" }, "CreditCardPayments_Count": { "type": [ "null", "integer" ], "description": "Credit card payments count.\nPlease note this is not the recurrence (how many months the transaction should last), this parameter shouldn't be used on most use cases.\nLeave this empty to disable payments and use standard direct debit.", "format": "int64" }, "MerchantNumber": { "type": [ "null", "string" ], "description": "Shva merchant number (Terminal number).\nThis parameter should only be used when multiple merchants are defined in the company." }, "OnlyDocument": { "type": "boolean", "description": "Generate documents without payment processing" }, "DocumentLanguage": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Language" } ], "description": "Document language\nDefaults to the company language" }, "FirstDocumentDescription": { "type": [ "null", "string" ], "description": "First document description. The description is shown in the first payment printed document.\nPlease note the description will only be shown when the API requests creates a document, and won't be shown on future documents." }, "PreventStandingOrder": { "type": [ "null", "boolean" ], "description": "Prevents the usage of Standing order recurring chargers, force using debit card merchant number, when multiple merchants are supported.\nDefaults to false." } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Charge_Response": { "type": "object", "properties": { "Payment": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.Payment" } ], "description": "Payment details" }, "DocumentID": { "type": [ "null", "integer" ], "description": "Document ID", "format": "int64" }, "CustomerID": { "type": "integer", "description": "Customer number", "format": "int64" }, "DocumentDownloadURL": { "type": [ "null", "string" ], "description": "Document download URL\nProduced document will be original (on first fetching), or certified copy." }, "RecurringCustomerItemIDs": { "type": [ "null", "array" ], "items": { "type": "integer", "format": "int64" }, "description": "Created recurring customer items identifiers" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_ListForCustomer_Request": { "required": [ "Credentials", "Customer" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Customer": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Customer" } ], "description": "Customer" }, "IncludeInactive": { "type": [ "null", "boolean" ], "description": "Also include inactive items\nDefaults to false" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_ListForCustomer_Response": { "type": "object", "properties": { "RecurringItems": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.RecurringCustomerItem" } } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_UpdateSettings_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "AutomaticBilling_CreditCard": { "type": [ "null", "boolean" ], "description": "Automatic billing mode for credit card payments" }, "AutomaticBilling_DirectDebit": { "type": [ "null", "boolean" ], "description": "Automatic billing mode for direct debit payments" }, "AutomaticBilling_DocumentsOnly": { "type": [ "null", "boolean" ], "description": "Automatic billing mode for documents only" }, "AutomaticBilling_ProformaInvoices": { "type": [ "null", "boolean" ], "description": "Automatic billing mode for charging existing proforma invoices" }, "AutomaticBilling_PaymentRequests": { "type": [ "null", "boolean" ], "description": "Automatic billing mode for charging existing payment requests" }, "AutomaticBilling_Invoices": { "type": [ "null", "boolean" ], "description": "Automatic billing mode charging existing tax invoices" }, "AutomaticBilling_ChargeDocument": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.Typed.ResultDocumentEnum" } ], "description": "Default document type for charges billing" }, "AutomaticBilling_DocumentsOnlyDocument": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.Typed.ExternalDocumentEnum" } ], "description": "Default document type for documents only billing" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_UpdateSettings_Response": { "type": "object", "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Update_Request": { "required": [ "Credentials", "Customer", "RecurringCustomerItemID" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Customer": { "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_Customer" } ], "description": "Customer" }, "RecurringCustomerItemID": { "type": "integer", "description": "Recurring customer item identifier (מזהה כרטיס הוראת קבע)", "format": "int64" }, "UnitPrice": { "type": [ "null", "number" ], "description": "Unit price", "format": "double" }, "Quantity": { "type": [ "null", "number" ], "description": "Quantity\nDefaults to 1", "format": "double" }, "Recurrence": { "type": [ "null", "integer" ], "description": "Number of pending recurring payments\nFor instance, for a total of 1 year of monthly payments, specify 12\nSetting this to 0 will result in continuous payments.\nPlease note this parameter cannot be used when the LastPaymentDate parameter is set.", "format": "int32" }, "NextPaymentDate": { "type": [ "null", "string" ], "description": "Next payment date", "format": "date-time" }, "LastPaymentDate": { "type": [ "null", "string" ], "description": "Last payment date.\nPlease note this parameter cannot be used when the Recurrence parameter is set.", "format": "date-time" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Update_Response": { "type": "object", "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.Typed.ChargeItem": { "type": "object", "properties": { "Item": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_IncomeItem" } ], "description": "Item" }, "Quantity": { "type": [ "null", "number" ], "description": "Quantity\nDefaults to 1", "format": "double" }, "UnitPrice": { "type": [ "null", "number" ], "description": "Single unit price in payment currency\nRequired field.", "format": "double" }, "Total": { "type": [ "null", "number" ], "description": "Total price in payment currency\nOptional field", "format": "double" }, "Currency": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentCurrency" } ], "description": "Payment currency\nLeave empty for company default currency" }, "Description": { "type": [ "null", "string" ], "description": "Item description" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.Typed.ChargeRecurringItem": { "required": [ "Item" ], "type": "object", "properties": { "Item": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.RecurringItem" } ], "description": "Item" }, "Quantity": { "type": [ "null", "number" ], "description": "Quantity\nDefaults to 1", "format": "double" }, "UnitPrice": { "type": [ "null", "number" ], "description": "Single unit price in payment currency", "format": "double" }, "Currency": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentCurrency" } ], "description": "Price currency\nLeave empty for company default currency" }, "Date_Start": { "type": [ "null", "string" ], "description": "First payment date\nDefaults to the current date. Format should be JSON based (such as 2023-11-30).", "format": "date-time" }, "Description": { "type": [ "null", "string" ], "description": "Recurring record description" }, "Duration_Days": { "type": [ "null", "integer" ], "description": "Recurring duration/interval in days\nFor instance, for monthly payments, specify 0. For weekly payments, specify 7.", "format": "int64" }, "Duration_Months": { "type": [ "null", "integer" ], "description": "Recurring duration/interval in months\nFor instance, for monthly payments, specify 1", "format": "int64" }, "Recurrence": { "type": [ "null", "integer" ], "description": "Number of recurring payments\nFor instance, for 1 year of monthly payments, specify 12.\nSetting this to null or 0 will result in continuous payments", "format": "int64" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.Typed.MultiVendorChargeItem": { "type": "object", "properties": { "Item": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_IncomeItem" } ], "description": "Item" }, "Quantity": { "type": [ "null", "number" ], "description": "Quantity\nDefaults to 1", "format": "double" }, "UnitPrice": { "type": [ "null", "number" ], "description": "Single unit price in payment currency\nRequired field.", "format": "double" }, "Total": { "type": [ "null", "number" ], "description": "Total price in payment currency\nOptional field", "format": "double" }, "Currency": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentCurrency" } ], "description": "Payment currency\nLeave empty for company default currency" }, "Description": { "type": [ "null", "string" ], "description": "Item description" }, "CompanyID": { "type": "integer", "format": "int64" }, "APIKey": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.Typed.Payment": { "type": "object", "properties": { "ID": { "type": "integer", "description": "Payment identifier", "format": "int64" }, "CustomerID": { "type": "integer", "description": "Customer identifier", "format": "int64" }, "Date": { "type": [ "null", "string" ], "description": "Payment date", "format": "date-time" }, "ValidPayment": { "type": "boolean", "description": "Indicates if the payment is valid" }, "Status": { "type": [ "null", "string" ], "description": "Payment status" }, "StatusDescription": { "type": [ "null", "string" ], "description": "Payment status description" }, "Amount": { "type": "number", "description": "Payment amount", "format": "double" }, "Currency": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentCurrency" } ] }, "PaymentMethod": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.PaymentMethod" } ], "description": "Payment method details" }, "AuthNumber": { "type": [ "null", "string" ], "description": "Authorization number" }, "FirstPaymentAmount": { "type": [ "null", "number" ], "description": "First credit card installments payment amount", "format": "double" }, "NonFirstPaymentAmount": { "type": [ "null", "number" ], "description": "Non first credit card installments payment amount", "format": "double" }, "RecurringCustomerItemIDs": { "type": [ "null", "array" ], "items": { "type": "integer", "format": "int64" }, "description": "Relevant only for payments originating from recurring payments" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.Typed.PaymentMethod": { "type": "object", "properties": { "ID": { "type": [ "null", "integer" ], "format": "int64" }, "CustomerID": { "type": [ "null", "integer" ], "format": "int64" }, "CreditCard_Number": { "type": [ "null", "string" ], "description": "Credit card full number\nRequired for credit card" }, "CreditCard_LastDigits": { "type": [ "null", "string" ], "description": "Credit card last 4 digits\nShouldn't be input by API caller" }, "CreditCard_ExpirationMonth": { "maximum": 12, "minimum": 1, "type": [ "null", "integer" ], "description": "Credit card expiration month (1-2 digits)\nRequired for credit card", "format": "int32" }, "CreditCard_ExpirationYear": { "type": [ "null", "integer" ], "description": "Credit card expiration year (4 digits)\nRequired for credit card", "format": "int32" }, "CreditCard_CVV": { "type": [ "null", "string" ], "description": "Credit card CVV/CVV2\nRequired when CVV is required by credit company" }, "CreditCard_Track2": { "type": [ "null", "string" ], "description": "Credit card Track2" }, "CreditCard_CitizenID": { "type": [ "null", "string" ], "description": "Credit card owner Israel Citizen ID / Passport Number\nRequired when Citizen ID is required by credit company" }, "CreditCard_CardMask": { "type": [ "null", "string" ], "description": "Credit card mask\nShouldn't be input by API caller" }, "CreditCard_Token": { "type": [ "null", "string" ], "description": "Credit card token" }, "DirectDebit_Bank": { "type": [ "null", "integer" ], "description": "Direct debit bank number\nFor instance, 12 indicates Bank Hapoalim.", "format": "int64" }, "DirectDebit_Branch": { "type": [ "null", "integer" ], "description": "Direct debit bank branch number", "format": "int64" }, "DirectDebit_Account": { "type": [ "null", "integer" ], "description": "Direct debit bank account number", "format": "int64" }, "DirectDebit_ExpirationDate": { "type": [ "null", "string" ], "description": "Direct debit expiration date", "format": "date-time" }, "DirectDebit_MaximumAmount": { "type": [ "null", "integer" ], "description": "Direct debit maximum charge amount", "format": "int64" }, "Type": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.PaymentMethodType" } ], "description": "Payment method type" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.Typed.PaymentMethodType": { "enum": [ "Other (0)", "CreditCard (1)", "DirectDebit (2)" ], "type": "string" }, "OfficeGuy.Apps.Billing.MVC.API.Typed.RecurringCustomerItem": { "type": "object", "properties": { "ID": { "type": "integer", "description": "Identifier", "format": "int64", "readOnly": true }, "Item": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.RecurringItem" } ], "description": "Item" }, "Quantity": { "type": [ "null", "number" ], "description": "Quantity\nDefaults to 1", "format": "double" }, "UnitPrice": { "type": [ "null", "number" ], "description": "Price\nDefaults to 0", "format": "double" }, "Date_Start": { "type": [ "null", "string" ], "description": "First payment date", "format": "date-time" }, "Date_Last": { "type": [ "null", "string" ], "description": "Last payment date", "format": "date-time" }, "Date_NextBilling": { "type": [ "null", "string" ], "description": "Next payment date", "format": "date-time" }, "Date_PreviousBilling": { "type": [ "null", "string" ], "description": "Previous payment date", "format": "date-time" }, "Status": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.Typed.RecurringCustomerItemStatus" } ], "description": "Item status" }, "Description": { "type": [ "null", "string" ], "description": "Recurring record description" } }, "additionalProperties": false }, "OfficeGuy.Apps.Billing.MVC.API.Typed.RecurringCustomerItemStatus": { "enum": [ "Active (0)", "Cancelled (1)", "DisabledFailedBillingPayment (3)", "FinishedExpired (9)", "GracePeriod (11)", "PendingForFirstPayment (12)", "CancelledByCustomer (13)", "PendingRetry (14)" ], "type": "string" }, "OfficeGuy.Apps.Billing.MVC.API.Typed.RecurringItem": { "type": "object", "properties": { "ID": { "type": [ "null", "integer" ], "description": "SUMIT identifier", "format": "int64" }, "Name": { "type": [ "null", "string" ], "description": "Item name" }, "Description": { "type": [ "null", "string" ], "description": "Item description" }, "Price": { "type": [ "null", "number" ], "description": "Item price (for single unit)", "format": "double" }, "Currency": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_DocumentCurrency" } ], "description": "Price currency\nLeave empty for company default" }, "Cost": { "type": [ "null", "number" ], "description": "Item cost (for single unit)", "format": "double" }, "ExternalIdentifier": { "type": [ "null", "string" ], "description": "Income item external identifier" }, "SKU": { "type": [ "null", "string" ] }, "SearchMode": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_IncomeItemSearchMode" } ] }, "Properties": { "type": [ "null", "object" ], "additionalProperties": { "type": "null" }, "description": "Entity fields" }, "Duration_Days": { "type": [ "null", "integer" ], "description": "Recurring duration/interval in days", "format": "int64" }, "Duration_Months": { "type": [ "null", "integer" ], "description": "Recurring duration/interval in months", "format": "int64" } }, "additionalProperties": { } }, "OfficeGuy.Apps.Billing.MVC.API.Typed.UpayProgram": { "enum": [ "OFFICEGUYNEW10 (1)", "UPAYTRANSACTION (2)", "OFFICEGUYNEWMONTHLY10 (3)", "OFFICEGUYMONTHLYNEW10 (4)" ], "type": "string" }, "OfficeGuy.Apps.Billing.Typed.ExternalDocumentEnum": { "enum": [ "ProformaInvoice (0)", "Order (1)", "Invoice (2)", "PaymentRequest (3)", "None (10)" ], "type": "string" }, "OfficeGuy.Apps.Billing.Typed.ResultDocumentEnum": { "enum": [ "InvoiceReceipt (0)", "Invoice (1)", "Receipt (2)", "DonationReceipt (3)", "ProformaInvoice (4)", "Order (5)", "PaymentRequest (6)", "Automatic (9)", "None (10)" ], "type": "string" }, "OfficeGuy.Apps.CRM.MVC.API.DataController_Data_ArchiveEntity_Request": { "required": [ "Credentials", "EntityID" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "EntityID": { "type": "integer", "description": "Entity identifier", "format": "int64" } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.DataController_Data_CountEntityUsage_Request": { "required": [ "Credentials", "EntityID" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "EntityID": { "type": "integer", "description": "Entity identifier", "format": "int64" } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.DataController_Data_CreateEntity_Request": { "required": [ "Credentials", "Entity" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Entity": { "allOf": [ { "$ref": "#/components/schemas/Core_Typed.Entity" } ], "description": "The entity to be created" } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.DataController_Data_CreateEntity_Response": { "type": "object", "properties": { "EntityID": { "type": "integer", "description": "Created entity identifier", "format": "int64" } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.DataController_Data_DeleteEntity_Request": { "required": [ "Credentials", "EntityID" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "EntityID": { "type": "integer", "description": "Entity identifier", "format": "int64" } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntitiesHTML_Request": { "required": [ "Credentials", "SchemaID", "ViewID" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "SchemaID": { "type": "integer", "description": "Schema identifier", "format": "int64" }, "ViewID": { "type": "integer", "description": "View identifier", "format": "int64" }, "PDF": { "type": [ "null", "boolean" ], "description": "Get PDF instead of HTML\nDefaults to False" } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntityPrintHTML_Request": { "required": [ "Credentials", "EntityID", "SchemaID" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "SchemaID": { "type": "integer", "description": "Schema identifier", "format": "int64" }, "EntityID": { "type": "integer", "description": "Entity identifier", "format": "int64" }, "PDF": { "type": [ "null", "boolean" ], "description": "Get PDF instead of HTML\nDefaults to False" } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntity_Request": { "required": [ "Credentials", "EntityID" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "EntityID": { "type": "integer", "description": "Entities identifier", "format": "int64" }, "IncludeIncomingProperties": { "type": [ "null", "boolean" ], "description": "Include incoming entity properties\nDefaults to False" }, "IncludeFields": { "type": [ "null", "boolean" ], "description": "Include all entity fields\nDefaults to True" } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntity_Response": { "type": "object", "properties": { "Entity": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Core_Typed.Entity" } ] } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.DataController_Data_ListEntities_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Folder": { "type": [ "null", "string" ], "description": "Folder identifier.\nPlease note this field is required.\nCan be either application folder name, or FolderID." }, "IncludeInheritedFolders": { "type": [ "null", "boolean" ], "description": "Include entities from inherited folders" }, "Filters": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Core_Typed.Filter" }, "description": "List filters" }, "Order": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Core_Typed.Order" } ], "description": "List results order (sort)" }, "Paging": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Core_Typed.Paging" } ], "description": "List paging" }, "LoadProperties": { "type": [ "null", "boolean" ], "description": "Load results properties\nDefaults to false" } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.DataController_Data_ListEntities_Response": { "type": "object", "properties": { "Entities": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Core_Typed.Entity" }, "description": "Matched entities" }, "HasNextPage": { "type": "boolean", "description": "Indicator whether the last page has reached" } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.DataController_Data_UpdateEntity_Request": { "required": [ "Credentials", "Entity" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Entity": { "allOf": [ { "$ref": "#/components/schemas/Core_Typed.Entity" } ], "description": "The entity to be updated" }, "CreateIfMissing": { "type": [ "null", "boolean" ], "description": "Should the update create the entity if it doesn't exist\nThis can only be used when Entity.ID is 0\nDefaults to false." }, "RemoveExistingProperties": { "type": [ "null", "boolean" ], "description": "Should the update entity remove all existing properties, which didn't pass through the Entity.Properties list?\nDefaults to false" } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.DataController_Data_UpdateEntity_Response": { "type": "object", "properties": { "EntityID": { "type": "integer", "description": "Entity identifier", "format": "int64" } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_GetFolder_Request": { "required": [ "Credentials", "Folder" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Folder": { "minLength": 1, "type": "string", "description": "Folder identifier.\nCan be either application folder name, or FolderID." }, "IncludeProperties": { "type": [ "null", "boolean" ], "description": "Get folder properties\nDefaults to False" } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_GetFolder_Response": { "type": "object", "properties": { "Folder": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.Typed.Folder" } ] }, "Properties": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.Typed.Property" } } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_ListFolders_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "NameFilter": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_ListFolders_Response": { "type": "object", "properties": { "Folders": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.Typed.Folder" } } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.Typed.Folder": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int64" }, "Name": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.Typed.Property": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int64" }, "Name": { "type": [ "null", "string" ] }, "Description": { "type": [ "null", "string" ] }, "Category": { "type": [ "null", "string" ] }, "ValueType": { "type": [ "null", "string" ] }, "APIName": { "type": [ "null", "string" ] }, "Required": { "type": "boolean" } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.Typed.View": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int64" }, "Name": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.ViewsController_Views_ListViews_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "FolderID": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "OfficeGuy.Apps.CRM.MVC.API.ViewsController_Views_ListViews_Response": { "type": "object", "properties": { "Views": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.Typed.View" } } }, "additionalProperties": false }, "OfficeGuy.Apps.CreditGuy.Typed.ExternalTokenizeMode": { "enum": [ "TokenizeOnly (0)", "ValidateCard (2)", "Charge (4)", "Authorize (5)" ], "type": "string" }, "OfficeGuy.Apps.CreditGuy.Typed.ParamJ": { "enum": [ "CheckDetails (2)", "Charge (4)", "AuthorizeOnly (5)" ], "type": "string" }, "OfficeGuy.Apps.CreditGuy.Typed.TransactionStatus": { "enum": [ "Transmit_Valid (10)", "Deposit_Valid (11)", "Deposit_NotNeeded (12)", "Transmit_Invalid (20)", "Deposit_Invalid (21)", "Billing_Pending (30)" ], "type": "string" }, "OfficeGuy.Apps.CreditGuy.Typed.TransactionType": { "enum": [ "Debit (1)", "StandingOrder (11)", "Credit (51)", "CreditEMV (53)" ], "type": "string" }, "OfficeGuy.Core.Typed.UserCompanyRole": { "enum": [ "Shared", "ReadOnly", "None", "Accountant", "Manager", "Owner" ], "type": "string" }, "Response_Accounting_Customers_CreateRemark_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_CreateRemark_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_Customers_Create_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_Create_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_Customers_GetDetailsURL_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_GetDetailsURL_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_Customers_Update_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Customers_Update_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_Documents_AddExpense_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_AddExpense_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_Documents_Cancel_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_Cancel_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_Documents_Create_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_Create_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_Documents_GetDebtReport_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetDebtReport_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_Documents_GetDebt_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetDebt_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_Documents_GetDetails_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_GetDetails_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_Documents_List_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_List_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_Documents_MoveToBooks_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Documents_MoveToBooks_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_General_GetExchangeRate_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_General_GetExchangeRate_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_General_GetNextDocumentNumber_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_General_GetNextDocumentNumber_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_General_GetVATRate_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_General_GetVATRate_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_General_SetNextDocumentNumber_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_General_SetNextDocumentNumber_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_General_UpdateSettings_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_General_UpdateSettings_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_General_VerifyBankAccount_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_General_VerifyBankAccount_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_IncomeItems_Create_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_IncomeItems_Create_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Accounting_IncomeItems_List_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_IncomeItems_List_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Books_Transactions_CreateBatch_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Books_Transactions_CreateBatch_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_CreditGuy_Billing_GetStatus_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Billing_GetStatus_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_CreditGuy_Billing_Load_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Billing_Load_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_CreditGuy_Billing_Process_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Billing_Process_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_CreditGuy_Gateway_BeginRedirect_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_BeginRedirect_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_CreditGuy_Gateway_GetReferenceNumbers_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_GetReferenceNumbers_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_CreditGuy_Gateway_GetTransaction_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_GetTransaction_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_CreditGuy_Gateway_Transaction_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Gateway_Transaction_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_CreditGuy_Vault_TokenizeSingleUse_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Vault_TokenizeSingleUse_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_CreditGuy_Vault_Tokenize_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/CreditGuy_Vault_Tokenize_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_CustomerService_Tickets_Create_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/CustomerService_Tickets_Create_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Deals_Deals_AddDeal_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Deals_Deals_AddDeal_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Deals_Deals_CreateRemark_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Deals_Deals_CreateRemark_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_EmailSubscriptions_MailingLists_Add_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/EmailSubscriptions_MailingLists_Add_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_EmailSubscriptions_MailingLists_List_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/EmailSubscriptions_MailingLists_List_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Fax_Fax_Send_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Fax_Fax_Send_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_OpenUpayTerminal_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_OpenUpayTerminal_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_SetUpayCredentials_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.GeneralBillingController_General_SetUpayCredentials_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_GetForCustomer_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_GetForCustomer_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_Remove_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_Remove_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_SetForCustomer_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentMethodsController_PaymentMethods_SetForCustomer_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_BeginRedirect_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_BeginRedirect_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Charge_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Charge_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Get_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_Get_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_List_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_List_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_MultiVendorCharge_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_MultiVendorCharge_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Cancel_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Cancel_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Charge_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Charge_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_ListForCustomer_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_ListForCustomer_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_UpdateSettings_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_UpdateSettings_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Update_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.RecurringController_Recurring_Update_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.CRM.MVC.API.DataController_Data_CreateEntity_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_CreateEntity_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntity_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_GetEntity_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.CRM.MVC.API.DataController_Data_ListEntities_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_ListEntities_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.CRM.MVC.API.DataController_Data_UpdateEntity_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.DataController_Data_UpdateEntity_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_GetFolder_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_GetFolder_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_ListFolders_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.SchemaController_Schema_ListFolders_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_OfficeGuy.Apps.CRM.MVC.API.ViewsController_Views_ListViews_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Apps.CRM.MVC.API.ViewsController_Views_ListViews_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_SMS_MailingList_List_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/SMS_MailingList_List_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_SMS_MailingLists_Add_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/SMS_MailingLists_Add_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_SMS_SMS_ListSenders_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/SMS_SMS_ListSenders_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_SMS_SMS_SendMultiple_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/SMS_SMS_SendMultiple_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_SMS_SMS_Send_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/SMS_SMS_Send_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_ScheduledDocuments_Documents_CreateFromDocument_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/ScheduledDocuments_Documents_CreateFromDocument_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Stock_Stock_List_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Stock_Stock_List_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_System.Int64": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "integer", "description": "API specific response data", "format": "int64" } }, "additionalProperties": false }, "Response_Triggers_Triggers_Subscribe_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Triggers_Triggers_Subscribe_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Triggers_Triggers_Unsubscribe_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Triggers_Triggers_Unsubscribe_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Website_Companies_Create_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Website_Companies_Create_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Website_Companies_GetDetails_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Website_Companies_GetDetails_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Website_Companies_InstallApplications_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Website_Companies_InstallApplications_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Website_Companies_ListQuotas_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Website_Companies_ListQuotas_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Website_Companies_Update_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Website_Companies_Update_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Website_Users_Create_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Website_Users_Create_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "Response_Website_Users_LoginRedirect_Response": { "type": "object", "properties": { "Status": { "allOf": [ { "$ref": "#/components/schemas/Teva.Common.ResponseStatus" } ], "description": "Response status" }, "UserErrorMessage": { "type": [ "null", "string" ], "description": "Error message, in a user readable format" }, "TechnicalErrorDetails": { "type": [ "null", "string" ], "description": "Technical error details, let us know if you received this." }, "Data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Website_Users_LoginRedirect_Response" } ], "description": "API specific response data" } }, "additionalProperties": false }, "SMS_MailingList_List_Response": { "type": "object", "properties": { "MailingLists": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SMS_Typed_MailingList" } } }, "additionalProperties": false }, "SMS_MailingLists_Add_Request": { "required": [ "Credentials", "MailingListID", "PhoneNumber" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "MailingListID": { "type": "integer", "format": "int64" }, "PhoneNumber": { "minLength": 1, "type": "string" }, "Name": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "SMS_MailingLists_Add_Response": { "type": "object", "additionalProperties": false }, "SMS_MailingLists_List_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" } }, "additionalProperties": false }, "SMS_SMS_ListSenders_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" } }, "additionalProperties": false }, "SMS_SMS_ListSenders_Response": { "type": "object", "properties": { "Senders": { "type": [ "null", "array" ], "items": { "type": "string" } } }, "additionalProperties": false }, "SMS_SMS_SendMultiple_Request": { "required": [ "Credentials", "Recipients", "Text" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Recipients": { "type": "array", "items": { "type": "string" } }, "Text": { "minLength": 1, "type": "string" }, "SaveDraft": { "type": [ "null", "boolean" ] }, "Schedule": { "type": [ "null", "string" ], "format": "date-time" }, "Sender": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "SMS_SMS_SendMultiple_Response": { "type": "object", "properties": { "EntityID": { "type": "integer", "format": "int64" }, "EstimatedQuota": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "SMS_SMS_Send_Request": { "required": [ "Credentials", "Recipient", "Text" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Recipient": { "minLength": 1, "type": "string" }, "Text": { "minLength": 1, "type": "string" }, "SaveDraft": { "type": [ "null", "boolean" ] }, "Sender": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "SMS_SMS_Send_Response": { "type": "object", "properties": { "EntityID": { "type": "integer", "format": "int64" }, "EstimatedQuota": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "SMS_Typed_MailingList": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int64" }, "Name": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "ScheduledDocuments_Documents_CreateFromDocument_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "DocumentID": { "type": "integer", "format": "int64" }, "IncomeItem": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Accounting_Typed_IncomeItem" } ] } }, "additionalProperties": false }, "ScheduledDocuments_Documents_CreateFromDocument_Response": { "type": "object", "properties": { "ScheduledDocuments": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ScheduledDocuments_Documents_CreateFromDocument_Response_ResultDocument" } } }, "additionalProperties": false }, "ScheduledDocuments_Documents_CreateFromDocument_Response_ResultDocument": { "type": "object", "properties": { "ScheduledDocumentID": { "type": "integer", "format": "int64" }, "Date": { "type": "string", "format": "date-time" }, "Total": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Stock_Stock_List_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "ItemIDs": { "type": [ "null", "array" ], "items": { "type": "integer", "format": "int64" } }, "ExcludeZeroStock": { "type": [ "null", "boolean" ] } }, "additionalProperties": false }, "Stock_Stock_List_Response": { "type": "object", "properties": { "Stock": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Stock_Typed_StockItem" } } }, "additionalProperties": false }, "Stock_Typed_StockItem": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int64" }, "Name": { "type": [ "null", "string" ] }, "ExternalIdentifier": { "type": [ "null", "string" ] }, "Stock": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Teva.Common.ResponseStatus": { "enum": [ "Success (0)", "BusinessError (1)", "TechnicalError (2)" ], "type": "string" }, "Triggers_Triggers_Subscribe_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "URL": { "type": [ "null", "string" ], "description": "Your Webhook URL" }, "Folder": { "type": [ "null", "string" ], "description": "The subscribed Folder ID" }, "View": { "type": "integer", "description": "The subscribed View ID", "format": "int64" }, "TriggerType": { "type": [ "null", "string" ], "description": "Trigger type (CreateOrUpdate/Create/Update/Archive/Delete)" } }, "additionalProperties": false }, "Triggers_Triggers_Subscribe_Response": { "type": "object", "additionalProperties": false }, "Triggers_Triggers_Unsubscribe_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "URL": { "type": [ "null", "string" ], "description": "Your Webhook URL" } }, "additionalProperties": false }, "Triggers_Triggers_Unsubscribe_Response": { "type": "object", "additionalProperties": false }, "Website_Companies_Create_Request": { "required": [ "Company", "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Company": { "allOf": [ { "$ref": "#/components/schemas/Website_Typed_Company" } ], "description": "Company details" }, "User": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Website_Typed_User" } ], "description": "Company owner\nLeave empty to set calling company owners as owners" }, "Applications": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Website_Typed_Application" }, "description": "List of applications to be installed on the created company.\nPlease note installing applications might incur additional charges." }, "HideFromCompaniesList": { "type": [ "null", "boolean" ], "description": "Allows hiding the created company from the user companies list\nDefaults to False" }, "Package": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Website_Typed_SumitPackage" } ], "description": "Package. Defaults to Beginners." } }, "additionalProperties": false }, "Website_Companies_Create_Response": { "type": "object", "properties": { "CompanyID": { "type": "integer", "description": "Created company identifier", "format": "int64" }, "APIKey": { "type": [ "null", "string" ], "description": "API Key for future calls" }, "APIPublicKey": { "type": [ "null", "string" ], "description": "Public API Key for future calls" }, "UserPassword": { "type": [ "null", "string" ], "description": "Created user password\nReturned only when new user is created" }, "UserEncryptedPassword": { "type": [ "null", "string" ], "description": "Created user encrypted password\nReturned only when new user is created" } }, "additionalProperties": false }, "Website_Companies_GetDetails_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" } }, "additionalProperties": false }, "Website_Companies_GetDetails_Response": { "type": "object", "properties": { "Company": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Website_Typed_Company" } ], "description": "Company details" } }, "additionalProperties": false }, "Website_Companies_InstallApplications_Request": { "required": [ "Applications", "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Applications": { "type": "array", "items": { "$ref": "#/components/schemas/Website_Typed_Application" }, "description": "List of applications to be installed.\nPlease note this may incur additional charges." } }, "additionalProperties": false }, "Website_Companies_InstallApplications_Response": { "type": "object", "additionalProperties": false }, "Website_Companies_ListQuotas_Request": { "required": [ "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" } }, "additionalProperties": false }, "Website_Companies_ListQuotas_Response": { "type": "object", "properties": { "Data": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Website_Typed_QuotaRecord" } } }, "additionalProperties": false }, "Website_Companies_Update_Request": { "required": [ "Company", "Credentials" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "Company": { "allOf": [ { "$ref": "#/components/schemas/Website_Typed_Company" } ], "description": "Company details\nOnly supplied fields will be updated" } }, "additionalProperties": false }, "Website_Companies_Update_Response": { "type": "object", "additionalProperties": false }, "Website_Permissions_Remove_Request": { "required": [ "Credentials", "UserID" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "UserID": { "type": "integer", "description": "User identifier", "format": "int64" } }, "additionalProperties": false }, "Website_Permissions_Set_Request": { "required": [ "Credentials", "Role", "UserID" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "UserID": { "type": "integer", "description": "User identifier", "format": "int64" }, "Role": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Core.Typed.UserCompanyRole" } ], "description": "User role" } }, "additionalProperties": false }, "Website_Typed_Application": { "enum": [ "CreditCard (0)", "DirectDebit (1)", "RecurringBilling (2)", "PurchasePages (3)", "CRM (4)", "EmailSubscriptions (5)", "SMS (6)", "Accounting (7)", "Expenses (8)", "Cheques (9)", "PayPal (10)", "TaskManagement (11)", "TimeClock (12)", "TimeRecorder (13)", "BusinessCard (14)", "Calendar (16)", "Fax (17)", "AccountingHashExport (18)" ], "type": "string" }, "Website_Typed_Company": { "type": "object", "properties": { "Name": { "type": [ "null", "string" ], "description": "Organization name" }, "EmailAddress": { "type": [ "null", "string" ], "description": "Organization email address\nThis email will be used for communication made by SUMIT to the company." }, "DocumentsEmailAddress": { "type": [ "null", "string" ], "description": "Documents email address\nThis email address will be shown on generated documents.\nDefaults to the company email address." }, "Country": { "type": [ "null", "string" ], "description": "Organization country (Optional field)" }, "Address": { "type": [ "null", "string" ], "description": "Organization address (Optional field)" }, "Phone": { "type": [ "null", "string" ], "description": "Organization phone number (Optional field)" }, "Fax": { "type": [ "null", "string" ], "description": "Organization fax number (Optional field)" }, "Title": { "type": [ "null", "string" ], "description": "Organization title (Optional field)" }, "CorporateNumber": { "type": [ "null", "string" ], "description": "Organization TAX identifier (Optional field)" }, "English_Name": { "type": [ "null", "string" ], "description": "English organization name (Optional field)" }, "English_Address": { "type": [ "null", "string" ], "description": "English organization address (Optional field)" }, "English_Country": { "type": [ "null", "string" ], "description": "English organization country (Optional field)" }, "English_Phone": { "type": [ "null", "string" ], "description": "English organization phone (Optional field)" }, "English_Fax": { "type": [ "null", "string" ], "description": "English organization fax number (Optional field)" }, "English_Title": { "type": [ "null", "string" ], "description": "English organization title" }, "CompanyType": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/Website_Typed_CompanyType" } ], "description": "Organization type.\nCompanyWithVAT - חברה\nVATExemptDealer - עוסק פטור\nLicensedDealer - עוסק מורשה\nFellowship - עמותה\nPartnership - שותפות\nCommunityInterestCompany - חברה לתועלת הציבור\nCooperative - אגודה שיתופית\nHouseCommittee - ועד בית\nElectionGroup - סיעה לבחירות\nParty - מפלגה" }, "Logo": { "type": [ "null", "string" ], "description": "Logo image file (Base64)\nFile should be a standard PNG/JPG/GIF file" }, "Website": { "type": [ "null", "string" ], "description": "Website URL" } }, "additionalProperties": false }, "Website_Typed_CompanyType": { "enum": [ "CompanyWithVAT (0)", "VATExemptDealer (1)", "LicensedDealer (2)", "Fellowship (3)", "Partnership (4)", "CommunityInterestCompany (5)", "Cooperative (6)", "HouseCommittee (7)", "ElectionGroup (8)", "Party (9)", "SelfEmployed (10)", "PublicTrust (11)" ], "type": "string" }, "Website_Typed_QuotaRecord": { "type": "object", "properties": { "ApplicationName": { "type": [ "null", "string" ] }, "StatisticName": { "type": [ "null", "string" ] }, "Usage": { "type": "integer", "format": "int64" }, "Quota": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Website_Typed_SumitPackage": { "enum": [ "Free (1)", "Package_1 (2)", "Package_2 (3)", "Package_3 (4)" ], "type": "string" }, "Website_Typed_User": { "type": "object", "properties": { "Name": { "type": [ "null", "string" ], "description": "User full name" }, "EmailAddress": { "type": [ "null", "string" ], "description": "User email address" }, "Password": { "type": [ "null", "string" ], "description": "User password (raw)" }, "Phone": { "type": [ "null", "string" ], "description": "User phone number" }, "SkipActivation": { "type": [ "null", "boolean" ], "description": "Allows skipping email activation before user can login.\nLeave empty for false (Require activation)" } }, "additionalProperties": false }, "Website_Users_Create_Request": { "required": [ "Credentials", "Role", "User" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "User": { "allOf": [ { "$ref": "#/components/schemas/Website_Typed_User" } ], "description": "User details" }, "Role": { "allOf": [ { "$ref": "#/components/schemas/OfficeGuy.Core.Typed.UserCompanyRole" } ], "description": "User role" } }, "additionalProperties": false }, "Website_Users_Create_Response": { "type": "object", "properties": { "UserID": { "type": "integer", "description": "Created user identifier", "format": "int64" } }, "additionalProperties": false }, "Website_Users_LoginRedirect_Request": { "required": [ "Credentials", "EmailAddress", "Password" ], "type": "object", "properties": { "Credentials": { "allOf": [ { "$ref": "#/components/schemas/Core_APICredentials" } ], "description": "Company API credentials" }, "EmailAddress": { "minLength": 1, "type": "string", "description": "User email address" }, "Password": { "minLength": 1, "type": "string", "description": "User password" } }, "additionalProperties": false }, "Website_Users_LoginRedirect_Response": { "type": "object", "properties": { "RedirectURL": { "type": [ "null", "string" ] } }, "additionalProperties": false } } }, "tags": [ { "name": "הנהלת חשבונות (Transactions)" }, { "name": "Accounting (Customers)" }, { "name": "Accounting (Documents)" }, { "name": "Accounting (General)" }, { "name": "Accounting (IncomeItems)" }, { "name": "Credit card terminal (Billing)" }, { "name": "Credit card terminal (Gateway)" }, { "name": "Credit card terminal (Vault)" }, { "name": "CRM (Data)" }, { "name": "CRM (Schema)" }, { "name": "CRM (Views)" }, { "name": "Customer service (Tickets)" }, { "name": "Deals (Deals)" }, { "name": "Email subscriptions (MailingLists)" }, { "name": "Outgoing faxes (Fax)" }, { "name": "Payments (GeneralBilling)" }, { "name": "Payments (PaymentMethods)" }, { "name": "Payments (Payments)" }, { "name": "Payments (Recurring)" }, { "name": "Scheduled documents (Documents)" }, { "name": "SMS subscriptions (MailingLists)" }, { "name": "SMS subscriptions (SMS)" }, { "name": "Stock management (Stock)" }, { "name": "Triggers (Triggers)" }, { "name": "Website (Companies)" }, { "name": "Website (Permissions)" }, { "name": "Website (Users)" } ] }