Created
March 2, 2026 18:18
-
-
Save franz-see/fc45e5ffc80f6f9a75891b28cfafd782 to your computer and use it in GitHub Desktop.
This file has been truncated, but you can view the full file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| openapi: 3.0.0 | |
| info: | |
| title: Zoho Books API | |
| description: Combined Zoho Books API specification | |
| version: 1.0.0 | |
| servers: | |
| - url: https://www.zohoapis.com/books/v3 | |
| description: API Endpoint | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fullaccess.all | |
| tags: | |
| - name: bank-accounts | |
| description: Bank-Accounts Module | |
| - name: bank-rules | |
| description: Bank-Rules Module | |
| - name: bank-transactions | |
| description: Bank-Transactions Module | |
| - name: base-currency-adjustment | |
| description: Base-Currency-Adjustment Module | |
| - name: bills | |
| description: Bills Module | |
| - name: chart-of-accounts | |
| description: Chart-Of-Accounts Module | |
| - name: contact-persons | |
| description: Contact-Persons Module | |
| - name: contacts | |
| description: Contacts Module | |
| - name: credit-notes | |
| description: Credit-Notes Module | |
| - name: currency | |
| description: Currency Module | |
| - name: custom-modules | |
| description: Custom-Modules | |
| - name: customer-debit-notes | |
| description: Customer Debit Notes Module | |
| - name: customer-payments | |
| description: Customer-Payments Module | |
| - name: estimates | |
| description: Estimates Module | |
| - name: expenses | |
| description: Expenses Module | |
| - name: fixed-assets | |
| description: Fixed-Assets Module | |
| - name: integration | |
| description: integration Module | |
| - name: invoices | |
| description: Invoices Module | |
| - name: items | |
| description: Items Module | |
| - name: journals | |
| description: Journals Module | |
| - name: locations | |
| description: Locations Module | |
| - name: opening-balance | |
| description: Opening-Balance Module | |
| - name: organizations | |
| description: Organizations Module | |
| - name: projects | |
| description: Projects Module | |
| - name: purchase-order | |
| description: Purchase-Order Module | |
| - name: recurring-bills | |
| description: Recurring-Bills Module | |
| - name: recurring-expenses | |
| description: Recurring-Expenses Module | |
| - name: recurring-invoices | |
| description: Recurring-Invoices Module | |
| - name: reporting-tags | |
| description: Reporting Tags Module | |
| - name: retainer-invoices | |
| description: Retainer-Invoices Module | |
| - name: sales-order | |
| description: Sales-Order Module | |
| - name: sales-receipt | |
| description: Sales Receipt Module | |
| - name: tasks | |
| description: Tasks Module | |
| - name: taxes | |
| description: Taxes Module | |
| - name: time-entries | |
| description: Time-Entries Module | |
| - name: users | |
| description: Users Module | |
| - name: vendor-credits | |
| description: Vendor-Credits Module | |
| - name: vendor-payments | |
| description: Vendor-Payments Module | |
| paths: | |
| /bankaccounts: | |
| post: | |
| tags: | |
| - bank-accounts | |
| operationId: create_bank_account | |
| summary: Create a bank account | |
| description: Create a bank account or a credit card account for your organization. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-bank-account-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-bank-account-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.CREATE | |
| get: | |
| tags: | |
| - bank-accounts | |
| operationId: list_bank_accounts | |
| summary: List view of accounts | |
| description: List all bank and credit card accounts for your organization. | |
| parameters: | |
| - name: filter_by | |
| in: query | |
| description: 'Filter the account by their status. Allowed Values: <code>Status.All</code>, | |
| <code>Status.Active</code> and <code>Status.Inactive</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: Status.All | |
| - name: sort_column | |
| in: query | |
| description: 'Sort the values based on the allowed values. Allowed Values: | |
| <code>account_name</code>,<code>account_type</code> and <code>account_code</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: account_name | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-view-of-accounts-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /bankaccounts/rules: | |
| get: | |
| tags: | |
| - bank-rules | |
| operationId: list_bank_account_rules | |
| summary: Get Rules List | |
| description: Fetch all the rules created for a specified bank or credit card | |
| account ID. | |
| parameters: | |
| - name: account_id | |
| in: query | |
| description: ID of the Bank Account | |
| required: true | |
| schema: | |
| type: integer | |
| format: int64 | |
| example: 460000000000361 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-rules-list-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.READ | |
| post: | |
| tags: | |
| - bank-rules | |
| operationId: create_bank_account_rule | |
| summary: Create a rule | |
| description: Create a rule and apply it on deposit/withdrawal for bank accounts | |
| and on refund/charges for credit card accounts. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-rule-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-rule-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.CREATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /bankaccounts/rules/{rule_id}: | |
| get: | |
| tags: | |
| - bank-rules | |
| operationId: get_bank_account_rule | |
| summary: Get a rule | |
| description: Get details of a specific rule. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-rule-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.READ | |
| put: | |
| tags: | |
| - bank-rules | |
| operationId: update_bank_account_rule | |
| summary: Update a rule | |
| description: Make changes to the rule, add or modify it and update. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-rule-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-rule-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.UPDATE | |
| delete: | |
| tags: | |
| - bank-rules | |
| operationId: delete_bank_account_rule | |
| summary: Delete a rule | |
| description: Delete a rule from your account and make it no longer applicable | |
| on the transactions. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-rule-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.DELETE | |
| parameters: | |
| - name: rule_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank account rule. | |
| schema: | |
| type: string | |
| example: '460000000048005' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bankaccounts/{account_id}: | |
| put: | |
| tags: | |
| - bank-accounts | |
| operationId: update_bank_account | |
| summary: Update bank account | |
| description: Modify the account that was created. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-bank-account-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-bank-account-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.UPDATE | |
| get: | |
| tags: | |
| - bank-accounts | |
| operationId: get_bank_account | |
| summary: Get account details | |
| description: Get a detailed look of the account specified. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-account-details-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.READ | |
| delete: | |
| tags: | |
| - bank-accounts | |
| operationId: delete_bank_account | |
| summary: Delete an account | |
| description: Delete a bank account from your organization. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-an-account-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.DELETE | |
| parameters: | |
| - name: account_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank account. | |
| schema: | |
| type: string | |
| example: '460000000050127' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bankaccounts/{account_id}/active: | |
| post: | |
| tags: | |
| - bank-accounts | |
| operationId: mark_bank_account_active | |
| summary: Activate account | |
| description: Make an account active. | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/activate-account-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.CREATE | |
| parameters: | |
| - name: account_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank account. | |
| schema: | |
| type: string | |
| example: '460000000050127' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bankaccounts/{account_id}/inactive: | |
| post: | |
| tags: | |
| - bank-accounts | |
| operationId: mark_bank_account_inactive | |
| summary: Deactivate account. | |
| description: Make an account inactive. | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/deactivate-account-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.CREATE | |
| parameters: | |
| - name: account_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank account. | |
| schema: | |
| type: string | |
| example: '460000000050127' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bankaccounts/{account_id}/statement/lastimported: | |
| get: | |
| tags: | |
| - bank-accounts | |
| operationId: get_last_imported_bank_statement | |
| summary: Get last imported statement | |
| description: Get the details of previously imported statement for the account. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-last-imported-statement-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.READ | |
| parameters: | |
| - name: account_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank account. | |
| schema: | |
| type: string | |
| example: '460000000050127' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bankaccounts/{account_id}/statement/{statement_id}: | |
| delete: | |
| tags: | |
| - bank-accounts | |
| operationId: delete_last_imported_bank_statement | |
| summary: Delete last imported statement | |
| description: Delete the statement that was previously imported. | |
| parameters: | |
| - name: statement_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank statement. | |
| schema: | |
| type: string | |
| example: '460000000049013' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-last-imported-statement-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.DELETE | |
| parameters: | |
| - name: account_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank account. | |
| schema: | |
| type: string | |
| example: '460000000050127' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bankstatements: | |
| post: | |
| tags: | |
| - bank-accounts | |
| operationId: import_bank_statements | |
| summary: Import a Bank/Credit Card Statement | |
| description: Import your bank/credit card feeds into your account. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/import-a-bankcredit-card-statement-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/import-a-bankcredit-card-statement-response' | |
| deprecated: false | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /banktransactions: | |
| post: | |
| tags: | |
| - bank-transactions | |
| operationId: create_bank_transaction | |
| summary: Create a transaction for an account | |
| description: Create a bank transaction based on the allowed transaction types. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-transaction-for-an-account-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-transaction-for-an-account-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.CREATE | |
| get: | |
| tags: | |
| - bank-transactions | |
| operationId: list_bank_transactions | |
| summary: Get transactions list | |
| description: Get all the transaction details involved in an account. | |
| parameters: | |
| - name: account_id | |
| in: query | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| example: '460000000048001' | |
| - name: transaction_type | |
| in: query | |
| required: false | |
| schema: | |
| type: string | |
| example: deposit | |
| - name: date | |
| in: query | |
| description: 'Start and end date, to provide a range within which the transaction | |
| date exist. Variants: <code>date_start</code> and <code>date_end</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '2013-10-01' | |
| - name: amount | |
| in: query | |
| description: 'Start and end amount, to provide a range within which the transaction | |
| amount exist. Variants: <code>amount_start</code> and <code>amount_end</code>' | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| example: 2000 | |
| - name: status | |
| in: query | |
| description: Transaction status wise list view - All, uncategorized, manually_added, | |
| matched, excluded, categorized | |
| required: false | |
| schema: | |
| type: string | |
| example: categorized | |
| - name: reference_number | |
| in: query | |
| description: Search using Reference Number of the transaction | |
| required: false | |
| schema: | |
| type: string | |
| example: Ref-121 | |
| - name: filter_by | |
| in: query | |
| description: 'Filters the transactions based on the allowed types. Allowed | |
| Values: <code>Status.All</code>, <code>Status.Uncategorized</code>, <code>Status.Categorized</code>, | |
| <code>Status.ManuallyAdded</code>, <code>Status.Excluded</code> and <code>Status.Matched</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sort_column | |
| in: query | |
| description: 'Sorts the transactions based on the allowed sort types. Allowed | |
| Values: <code>date</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: transaction_status | |
| in: query | |
| description: Transaction status wise list view - All, uncategorized, manually_added, | |
| matched, excluded, categorized | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: search_text | |
| in: query | |
| description: Search Transactions by contact name or description | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-transactions-list-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /banktransactions/uncategorized/{statement_line_id}/categorize/paymentrefunds: | |
| post: | |
| tags: | |
| - bank-transactions | |
| operationId: categorize_bank_transaction_as_payment_refund | |
| summary: Categorize as Customer Payment refund | |
| description: Categorizing bank transactions as Payment Refund. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/categorize-as-customer-payment-refund-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/categorize-as-customer-payment-refund-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.CREATE | |
| parameters: | |
| - name: statement_line_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank statement line. | |
| schema: | |
| type: string | |
| example: '' | |
| - $ref: '#/components/parameters/organization_id' | |
| /banktransactions/uncategorized/{statement_line_id}/categorize/vendorpaymentrefunds: | |
| post: | |
| tags: | |
| - bank-transactions | |
| operationId: categorize_as_vendor_payment_refund | |
| summary: Categorize as Vendor Payment refund | |
| description: Categorizing bank transactions as Vendor Payment Refund. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/categorize-as-vendor-payment-refund-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/categorize-as-vendor-payment-refund-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.CREATE | |
| parameters: | |
| - name: statement_line_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank statement line. | |
| schema: | |
| type: string | |
| example: '' | |
| - $ref: '#/components/parameters/organization_id' | |
| /banktransactions/uncategorized/{transaction_id}/categorize: | |
| post: | |
| tags: | |
| - bank-transactions | |
| operationId: categorize_bank_transaction | |
| summary: Categorize an uncategorized transaction | |
| description: Categorize an uncategorized transaction by creating a new transaction. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/categorize-an-uncategorized-transaction-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/categorize-an-uncategorized-transaction-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.CREATE | |
| parameters: | |
| - name: transaction_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank transaction. | |
| schema: | |
| type: string | |
| example: '460000000048017' | |
| - $ref: '#/components/parameters/organization_id' | |
| /banktransactions/uncategorized/{transaction_id}/categorize/creditnoterefunds: | |
| post: | |
| tags: | |
| - bank-transactions | |
| operationId: categorize_as_credit_note_refunds | |
| summary: Categorize as credit note refunds | |
| description: Categorize an Uncategorized transaction as a refund from a credit | |
| note. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/categorize-as-credit-note-refunds-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/categorize-as-credit-note-refunds-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.CREATE | |
| parameters: | |
| - name: transaction_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank transaction. | |
| schema: | |
| type: string | |
| example: '460000000048017' | |
| - $ref: '#/components/parameters/organization_id' | |
| /banktransactions/uncategorized/{transaction_id}/categorize/customerpayments: | |
| post: | |
| tags: | |
| - bank-transactions | |
| operationId: categorize_bank_transaction_as_customer_payment | |
| summary: Categorize as customer payment | |
| description: Categorize an uncategorized transaction as Customer Payment. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/categorize-as-customer-payment-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/categorize-as-customer-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.CREATE | |
| parameters: | |
| - name: transaction_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank transaction. | |
| schema: | |
| type: string | |
| example: '460000000048017' | |
| - $ref: '#/components/parameters/organization_id' | |
| /banktransactions/uncategorized/{transaction_id}/categorize/expenses: | |
| post: | |
| tags: | |
| - bank-transactions | |
| operationId: categorize_bank_transaction_as_expense | |
| summary: Categorize as expense | |
| description: Categorize an Uncategorized transaction as expense. | |
| parameters: | |
| - name: doc | |
| in: query | |
| description: Document that is to be attached | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: totalFiles | |
| in: query | |
| description: Total number of files. | |
| required: false | |
| schema: | |
| type: integer | |
| example: 0 | |
| - name: document_ids | |
| in: query | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| example: '' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/categorize-as-expense-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/categorize-as-expense-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.CREATE | |
| parameters: | |
| - name: transaction_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank transaction. | |
| schema: | |
| type: string | |
| example: '460000000048017' | |
| - $ref: '#/components/parameters/organization_id' | |
| /banktransactions/uncategorized/{transaction_id}/categorize/vendorcreditrefunds: | |
| post: | |
| tags: | |
| - bank-transactions | |
| operationId: categorize_as_vendor_credit_refunds | |
| summary: Categorize as vendor credit refunds | |
| description: Categorize an uncategorized transaction as a refund from a vendor | |
| credit. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/categorize-as-vendor-credit-refunds-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/categorize-as-vendor-credit-refunds-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.CREATE | |
| parameters: | |
| - name: transaction_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank transaction. | |
| schema: | |
| type: string | |
| example: '460000000048017' | |
| - $ref: '#/components/parameters/organization_id' | |
| /banktransactions/uncategorized/{transaction_id}/categorize/vendorpayments: | |
| post: | |
| tags: | |
| - bank-transactions | |
| operationId: categorize_bank_transaction_as_vendor_payment | |
| summary: Categorize a vendor payment | |
| description: Categorize an uncategorized transaction as Vendor Payment. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/categorize-a-vendor-payment-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/categorize-a-vendor-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.CREATE | |
| parameters: | |
| - name: transaction_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank transaction. | |
| schema: | |
| type: string | |
| example: '460000000048017' | |
| - $ref: '#/components/parameters/organization_id' | |
| /banktransactions/uncategorized/{transaction_id}/exclude: | |
| post: | |
| tags: | |
| - bank-transactions | |
| operationId: exclude_bank_transaction | |
| summary: Exclude a transaction | |
| description: Exclude a transaction from your bank or credit card account. | |
| parameters: | |
| - name: account_id | |
| in: query | |
| description: Mandatory Account id for which transactions are to be listed. | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000048001' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/exclude-a-transaction-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.CREATE | |
| parameters: | |
| - name: transaction_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank transaction. | |
| schema: | |
| type: string | |
| example: '460000000048017' | |
| - $ref: '#/components/parameters/organization_id' | |
| /banktransactions/uncategorized/{transaction_id}/match: | |
| get: | |
| tags: | |
| - bank-transactions | |
| operationId: get_matching_bank_transactions | |
| summary: Get matching transactions | |
| description: Provide criteria to search for matching uncategorised transactions. | |
| The list of transactions can also include invoices/bills/credit-notes which | |
| will not be matched directly. Instead, a new (payment/refund) transaction | |
| is recorded and matched. | |
| parameters: | |
| - name: transaction_id | |
| in: query | |
| description: ID of the Transaction | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000048017' | |
| - name: transaction_type | |
| in: query | |
| description: 'Type of the transaction. <br> <strong>Allowed transaction types</strong> | |
| : deposit, refund(*Supported only in Credit Card accounts), transfer_fund, | |
| card_payment, sales_without_invoices, expense_refund, owner_contribution, | |
| interest_income, other_income, owner_drawings, sales_return <br> <strong>Note:</strong> | |
| You will not be able to create the following module-specific transaction | |
| types under Bank Transaction endpoints :<div> <a href="#Expenses">Expense</a>, | |
| <a href="#Vendor-Payments">Vendor Advance/Vendor Payment/Bill Payment</a>, | |
| <a href="#Vendor-Credits_Refund_a_vendor_credit">Vendor Credit Refund</a>, | |
| <a href="#Vendor-Payments_Refund_an_excess_vendor_payment">Vendor Payment | |
| Refund</a>, <a href="#Customer-Payments">Customer Advance/Customer Payment</a>, | |
| <a href="#Credit-Notes_Refund_credit_note">Credit Note Refund</a>, <a href="#Customer-Payments_Refund_an_excess_customer_payment">Payment | |
| Refund</a>. Hence, refer them in their repective modules.</div>' | |
| required: false | |
| schema: | |
| type: string | |
| example: deposit | |
| - name: date_after | |
| in: query | |
| description: Date after which Transactions are to be filtered | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: date_before | |
| in: query | |
| description: Date before which Transactions are to be filtered | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: amount_start | |
| in: query | |
| description: Starting amout with which transactions are to be filtered | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| example: '' | |
| - name: amount_end | |
| in: query | |
| description: Starting amout with which transactions are to be filtered | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| example: '' | |
| - name: contact | |
| in: query | |
| description: Contact person name, involved in the transaction. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: reference_number | |
| in: query | |
| description: Reference Number of the transaction | |
| required: false | |
| schema: | |
| type: string | |
| example: Ref-121 | |
| - name: show_all_transactions | |
| in: query | |
| description: Check if all transactions must be shown | |
| required: false | |
| schema: | |
| type: boolean | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-matching-transactions-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.READ | |
| post: | |
| tags: | |
| - bank-transactions | |
| operationId: match_bank_transaction | |
| summary: Match a transaction | |
| description: Match an uncategorized transaction with an existing transaction | |
| in the account. | |
| parameters: | |
| - name: account_id | |
| in: query | |
| description: Mandatory Account id for which transactions are to be listed. | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000048001' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/match-a-transaction-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/match-a-transaction-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.CREATE | |
| parameters: | |
| - name: transaction_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank transaction. | |
| schema: | |
| type: string | |
| example: '460000000048017' | |
| - $ref: '#/components/parameters/organization_id' | |
| /banktransactions/uncategorized/{transaction_id}/restore: | |
| post: | |
| tags: | |
| - bank-transactions | |
| operationId: restore_bank_transaction | |
| summary: Restore a transaction | |
| description: Restore an excluded transaction in your account. | |
| parameters: | |
| - name: account_id | |
| in: query | |
| description: Mandatory Account id for which transactions are to be listed. | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000048001' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/restore-a-transaction-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.CREATE | |
| parameters: | |
| - name: transaction_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank transaction. | |
| schema: | |
| type: string | |
| example: '460000000048017' | |
| - $ref: '#/components/parameters/organization_id' | |
| /banktransactions/{bank_transaction_id}: | |
| put: | |
| tags: | |
| - bank-transactions | |
| operationId: update_bank_transaction | |
| summary: Update a transaction | |
| description: Make changes in the applicable fields of a transaction and update | |
| it. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-transaction-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-transaction-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.UPDATE | |
| get: | |
| tags: | |
| - bank-transactions | |
| operationId: get_bank_transaction | |
| summary: Get transaction | |
| description: Fetch the details of a transaction by specifying the transaction_id. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-transaction-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.READ | |
| delete: | |
| tags: | |
| - bank-transactions | |
| operationId: delete_bank_transaction | |
| summary: Delete a transaction | |
| description: Delete a transaction from an account by specifying the transaction_id. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-transaction-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.DELETE | |
| parameters: | |
| - name: bank_transaction_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank transaction. | |
| schema: | |
| type: string | |
| example: '460000000048017' | |
| - $ref: '#/components/parameters/organization_id' | |
| /banktransactions/{transaction_id}/uncategorize: | |
| post: | |
| tags: | |
| - bank-transactions | |
| operationId: uncategorize_bank_transaction | |
| summary: Uncategorize a categorized transaction | |
| description: Revert a categorized transaction as uncategorized. | |
| parameters: | |
| - name: account_id | |
| in: query | |
| description: Mandatory Account id for which transactions are to be listed. | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000048001' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/uncategorize-a-categorized-transaction-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.CREATE | |
| parameters: | |
| - name: transaction_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank transaction. | |
| schema: | |
| type: string | |
| example: '460000000048017' | |
| - $ref: '#/components/parameters/organization_id' | |
| /banktransactions/{transaction_id}/unmatch: | |
| post: | |
| tags: | |
| - bank-transactions | |
| operationId: unmatch_bank_transaction | |
| summary: Unmatch a matched transaction | |
| description: Unmatch a transaction that was previously matched and make it uncategorized. | |
| parameters: | |
| - name: account_id | |
| in: query | |
| description: Mandatory Account id for which transactions are to be listed. | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000048001' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/unmatch-a-matched-transaction-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.banking.CREATE | |
| parameters: | |
| - name: transaction_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bank transaction. | |
| schema: | |
| type: string | |
| example: '460000000048017' | |
| - $ref: '#/components/parameters/organization_id' | |
| /basecurrencyadjustment: | |
| post: | |
| tags: | |
| - base-currency-adjustment | |
| operationId: create_base_currency_adjustment | |
| summary: Create a base currency adjustment | |
| description: Creates a base currency adjustment for the given information. | |
| parameters: | |
| - name: account_ids | |
| in: query | |
| description: ID of the accounts for which base currency adjustments need to | |
| be posted. | |
| required: true | |
| schema: | |
| type: string | |
| example: 460000000000364 | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-base-currency-adjustment-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-base-currency-adjustment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.CREATE | |
| get: | |
| tags: | |
| - base-currency-adjustment | |
| operationId: list_base_currency_adjustments | |
| summary: List base currency adjustment | |
| description: Lists base currency adjustment. | |
| parameters: | |
| - name: filter_by | |
| in: query | |
| description: 'Filter base currency adjustment list. Allowed Values: <code>Date.All</code>, | |
| <code>Date.Today</code>, <code>Date.ThisWeek</code>, <code>Date.ThisMonth</code>, | |
| <code>Date.ThisQuarter</code> and <code>Date.ThisYear</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sort_column | |
| in: query | |
| description: 'Sort base currency adjustment list. Allowed Values: <code>adjustment_date</code>, | |
| <code>exchange_rate</code>, <code>currency_code</code>, <code>debit_or_credit</code> | |
| and <code>gain_or_loss</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: last_modified_time | |
| in: query | |
| description: Search using the Last Modified Time of the Base Currency Adjustment | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-base-currency-adjustment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /basecurrencyadjustment/accounts: | |
| get: | |
| tags: | |
| - base-currency-adjustment | |
| operationId: list_base_currency_adjustment_accounts | |
| summary: List account details for base currency adjustment | |
| description: List of accounts having transaction with effect to the given exchange | |
| rate. | |
| parameters: | |
| - name: currency_id | |
| in: query | |
| description: ID of currency for which we need to post adjustment. | |
| required: true | |
| schema: | |
| type: string | |
| example: '460000000000109' | |
| - name: adjustment_date | |
| in: query | |
| description: Date of adjustment. | |
| required: true | |
| schema: | |
| type: string | |
| example: '2013-09-05' | |
| - name: exchange_rate | |
| in: query | |
| description: Exchange rate of the currency. | |
| required: true | |
| schema: | |
| type: number | |
| format: double | |
| example: 1 | |
| - name: notes | |
| in: query | |
| description: Notes for base currency adjustment. | |
| required: true | |
| schema: | |
| type: string | |
| example: Base Currency Adjustment against EUR | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-account-details-for-base-currency-adjustment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /basecurrencyadjustment/{base_currency_adjustment_id}: | |
| get: | |
| tags: | |
| - base-currency-adjustment | |
| operationId: get_base_currency_adjustment | |
| summary: Get a base currency adjustment | |
| description: Get the base currency adjustment details. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-base-currency-adjustment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.READ | |
| delete: | |
| tags: | |
| - base-currency-adjustment | |
| operationId: delete_base_currency_adjustment | |
| summary: Delete a base currency adjustment | |
| description: Deletes the base currency adjustment. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-base-currency-adjustment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.DELETE | |
| parameters: | |
| - name: base_currency_adjustment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the base currency adjustment. | |
| schema: | |
| type: string | |
| example: '460000000039001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bill/{bill_id}/customfields: | |
| put: | |
| tags: | |
| - bills | |
| operationId: update_custom_fields_in_bill | |
| summary: Update custom field in existing bills | |
| description: Update the value of the custom field in existing bills. | |
| parameters: | |
| - name: bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bill. | |
| schema: | |
| type: string | |
| example: '460000000098765' | |
| - $ref: '#/components/parameters/organization_id' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/custom_fields' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-bill-customfield-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.UPDATE | |
| /bills: | |
| post: | |
| tags: | |
| - bills | |
| operationId: create_bill | |
| summary: Create a bill | |
| description: Create a bill received from your vendor. | |
| parameters: | |
| - name: attachment | |
| in: query | |
| description: 'File to attach. Allowed Extensions: <code>gif</code>, <code>png</code>, | |
| <code>jpeg</code>, <code>jpg</code>, <code>bmp</code> and <code>pdf</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-bill-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-bill-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.CREATE | |
| get: | |
| tags: | |
| - bills | |
| operationId: list_bills | |
| summary: List bills | |
| description: List all bills with pagination. | |
| parameters: | |
| - name: bill_number | |
| in: query | |
| description: Filter bills by bill number. Accepts exact matches or use <code>bill_number_startswith</code> | |
| for prefix matching and <code>bill_number_contains</code> for substring | |
| matching. Useful for finding bills by unique identifier or partial patterns. | |
| required: false | |
| schema: | |
| type: string | |
| example: '00454' | |
| - name: reference_number | |
| in: query | |
| description: Filter bills by reference number. Accepts exact matches or use | |
| <code>reference_number_startswith</code> for prefix matching and <code>reference_number_contains</code> | |
| for substring matching. Useful for finding bills by external references | |
| or vendor invoice numbers. | |
| required: false | |
| schema: | |
| type: string | |
| example: '4321133' | |
| - name: date | |
| in: query | |
| description: Filter bills by bill date in YYYY-MM-DD format. Use <code>date_start</code>/<code>date_end</code> | |
| for ranges, <code>date_before</code>/<code>date_after</code> for relative | |
| dates. Useful for billing periods and due date management. | |
| required: false | |
| schema: | |
| type: string | |
| example: '2013-09-11' | |
| - name: status | |
| in: query | |
| description: 'Filter bills by status: <code>paid</code>, <code>open</code>, | |
| <code>overdue</code>, <code>void</code>, or <code>partially_paid</code>. | |
| Useful for payment status filtering, accounts payable management, and status-specific | |
| reporting.' | |
| required: false | |
| schema: | |
| type: string | |
| example: open | |
| - name: description | |
| in: query | |
| description: Filter bills by description text. Accepts exact matches or use | |
| <code>description_startswith</code> for prefix matching and <code>description_contains</code> | |
| for substring matching. Useful for finding bills by line item descriptions | |
| or vendor notes. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: vendor_name | |
| in: query | |
| description: Filter bills by vendor name. Use <code>vendor_name_startswith</code> | |
| for prefix matching or <code>vendor_name_contains</code> for substring matching. | |
| Useful for finding bills from specific suppliers. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: total | |
| in: query | |
| description: Filter bills by total amount. Use <code>total_less_than</code>, | |
| <code>total_less_equals</code>, <code>total_greater_than</code>, or <code>total_greater_equals</code> | |
| for amount-based filtering. Useful for finding bills within specific price | |
| ranges or above/below certain thresholds. | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| example: 40 | |
| - name: vendor_id | |
| in: query | |
| description: Filter bills by specific vendor ID. Accepts the unique identifier | |
| for a vendor to retrieve all bills associated with that particular supplier | |
| or vendor account. | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| example: '460000000038029' | |
| - name: item_id | |
| in: query | |
| description: Filter bills by specific item ID. Retrieves all bills containing | |
| a particular product or service item based on its unique identifier. | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| example: '460000000054135' | |
| - name: recurring_bill_id | |
| in: query | |
| description: Filter bills by recurring bill ID. Retrieves all bills generated | |
| from a specific recurring bill template or schedule. | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| example: '' | |
| - name: purchaseorder_id | |
| in: query | |
| description: Filter bills by purchase order ID. Retrieves all bills associated | |
| with a specific purchase order for tracking procurement workflows. | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| example: '460000000068231' | |
| - name: last_modified_time | |
| in: query | |
| description: Filter bills by last modification timestamp. Accepts ISO 8601 | |
| format (YYYY-MM-DDTHH:MM:SS+/-HHMM) to find bills modified at or after a | |
| specific time. | |
| required: false | |
| schema: | |
| type: string | |
| example: 2013-09-11T17:18:32+0530 | |
| - name: filter_by | |
| in: query | |
| description: Filter bills by status using predefined status constants. Options | |
| include <code>Status.All</code>, <code>Status.PartiallyPaid</code>, <code>Status.Paid</code>, | |
| <code>Status.Overdue</code>, <code>Status.Void</code>, and <code>Status.Open</code>. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: search_text | |
| in: query | |
| description: Filter bills using general search text. Searches across bill | |
| number, reference number, and vendor name fields to find matching bills. | |
| Useful for quick searches when you know part of the bill information. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: page | |
| in: query | |
| description: Specify the page number for pagination. Use this parameter to | |
| navigate through multiple pages of bills when the total number of bills | |
| exceeds the per_page limit. | |
| required: false | |
| schema: | |
| type: integer | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Specify the number of bills to retrieve per page. The default | |
| value is 200, but you can adjust this to optimize performance based on your | |
| needs and API rate limits. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| - name: sort_column | |
| in: query | |
| description: Specify the column to sort bills by. Available options include | |
| <code>vendor_name</code>, <code>bill_number</code>, <code>date</code>, <code>due_date</code>, | |
| <code>total</code>, <code>balance</code>, and <code>created_time</code>. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sort_order | |
| in: query | |
| description: Specify the sorting order for bills. Use <code>A</code> for ascending | |
| order (A-Z, 0-9, earliest to latest) or <code>D</code> for descending order | |
| (Z-A, 9-0, latest to earliest). | |
| required: false | |
| schema: | |
| type: string | |
| example: D | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-bills-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.READ | |
| put: | |
| tags: | |
| - bills | |
| operationId: update_bill_using_custom_field | |
| summary: Update a bill using a custom field's unique value | |
| description: A custom field will have unique values if it's configured to not | |
| accept duplicate values. Now, you can use that custom field's value to update | |
| a bill by providing its API name in the X-Unique-Identifier-Key header and | |
| its value in the X-Unique-Identifier-Value header. Based on this value, the | |
| corresponding bill will be retrieved and updated. Additionally, there is an | |
| optional X-Upsert header. If the X-Upsert header is true and the custom field's | |
| unique value is not found in any of the existing bills, a new bill will be | |
| created if the necessary payload details are available | |
| parameters: | |
| - name: X-Unique-Identifier-Key | |
| in: header | |
| description: Specify the API name of the custom field that contains unique | |
| values. This field must be configured to not accept duplicate values for | |
| the upsert functionality to work properly. | |
| required: true | |
| schema: | |
| type: string | |
| example: cf_unique_cf | |
| - name: X-Unique-Identifier-Value | |
| in: header | |
| description: Provide the unique value from the custom field that identifies | |
| the specific bill to update. This value will be used to locate the existing | |
| bill record in the system. | |
| required: true | |
| schema: | |
| type: string | |
| example: unique Value | |
| - name: X-Upsert | |
| in: header | |
| description: When set to true, this header enables upsert functionality. If | |
| no bill is found with the specified custom field value, a new bill will | |
| be created using the provided payload data. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-bill-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-bill-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /bills/editpage/frompurchaseorders: | |
| get: | |
| tags: | |
| - bills | |
| operationId: convert_purchase_order_to_bill | |
| summary: Convert PO to Bill | |
| description: Create a bill for the selected purchase orders. Use this api to | |
| fetch the Bill payload by passing the purchaseorder_ids in the query parameters | |
| and then use the create bill api and pass the payload to create a bill <br> | |
| <a href=/books/api/v3/bills/#create-a-bill>Create bill API Endpoint</a>. | |
| parameters: | |
| - $ref: '#/components/parameters/purchaseorder_ids' | |
| responses: | |
| '200': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/convert-po-to-bill-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.READ | |
| parameters: | |
| - $ref: '#/components/parameters/purchaseorder_ids' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bills/{bill_id}: | |
| put: | |
| tags: | |
| - bills | |
| operationId: update_bill | |
| summary: Update a bill | |
| description: Update a bill. To delete a line item just remove it from the line_items | |
| list. | |
| parameters: | |
| - name: attachment | |
| in: query | |
| description: 'File to attach. Allowed Extensions: <code>gif</code>, <code>png</code>, | |
| <code>jpeg</code>, <code>jpg</code>, <code>bmp</code> and <code>pdf</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-bill-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-bill-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.UPDATE | |
| get: | |
| tags: | |
| - bills | |
| operationId: get_bill | |
| summary: Get a bill | |
| description: Get the details of a bill. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-bill-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.READ | |
| delete: | |
| tags: | |
| - bills | |
| operationId: delete_bill | |
| summary: Delete a bill | |
| description: Delete an existing bill. Bills which have payments applied cannot | |
| be deleted. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-bill-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.DELETE | |
| parameters: | |
| - name: bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bill. | |
| schema: | |
| type: string | |
| example: '460000000098765' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bills/{bill_id}/address/billing: | |
| put: | |
| tags: | |
| - bills | |
| operationId: update_bill_billing_address | |
| summary: Update billing address | |
| description: Updates the billing address for this bill. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-billing-address-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-billing-address-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.UPDATE | |
| parameters: | |
| - name: bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bill. | |
| schema: | |
| type: string | |
| example: '460000000098765' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bills/{bill_id}/approve: | |
| post: | |
| tags: | |
| - bills | |
| operationId: approve_bill | |
| summary: Approve a bill | |
| description: Approve a bill. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/approve-a-bill-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.CREATE | |
| parameters: | |
| - name: bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bill. | |
| schema: | |
| type: string | |
| example: '460000000098765' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bills/{bill_id}/attachment: | |
| get: | |
| tags: | |
| - bills | |
| operationId: get_bill_attachment | |
| summary: Get a bill attachment | |
| description: Returns the file attached to the bill. | |
| parameters: | |
| - name: preview | |
| in: query | |
| description: Get the thumbnail of the attachment. | |
| required: false | |
| schema: | |
| type: boolean | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-bill-attachment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.READ | |
| post: | |
| tags: | |
| - bills | |
| operationId: add_bill_attachment | |
| summary: Add attachment to a bill | |
| description: Attach a file to a bill. | |
| parameters: | |
| - name: attachment | |
| in: query | |
| description: 'File to attach. Allowed Extensions: <code>gif</code>, <code>png</code>, | |
| <code>jpeg</code>, <code>jpg</code>, <code>bmp</code> and <code>pdf</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-attachment-to-a-bill-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.CREATE | |
| delete: | |
| tags: | |
| - bills | |
| operationId: delete_bill_attachment | |
| summary: Delete an attachment | |
| description: Delete the file attached to a bill. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-an-attachment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.DELETE | |
| parameters: | |
| - name: bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bill. | |
| schema: | |
| type: string | |
| example: '460000000098765' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bills/{bill_id}/comments: | |
| get: | |
| tags: | |
| - bills | |
| operationId: get_bill_comments | |
| summary: List bill comments & history | |
| description: Get the complete history and comments of a bill. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-bill-comments-and-history-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.READ | |
| post: | |
| tags: | |
| - bills | |
| operationId: add_bill_comment | |
| summary: Add comment | |
| description: Add a comment for a bill. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-comment-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.CREATE | |
| parameters: | |
| - name: bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bill. | |
| schema: | |
| type: string | |
| example: '460000000098765' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bills/{bill_id}/comments/{comment_id}: | |
| delete: | |
| tags: | |
| - bills | |
| operationId: delete_bill_comment | |
| summary: Delete a comment | |
| description: Delete a bill comment. | |
| parameters: | |
| - name: comment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the comment. | |
| schema: | |
| type: string | |
| example: '460000000069037' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.DELETE | |
| parameters: | |
| - name: bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bill. | |
| schema: | |
| type: string | |
| example: '460000000098765' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bills/{bill_id}/credits: | |
| post: | |
| tags: | |
| - bills | |
| operationId: apply_credits_to_bill | |
| summary: Apply credits | |
| description: Apply the vendor credits from excess vendor payments to a bill. | |
| Multiple credits can be applied at once. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/apply-credits-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/apply-credits-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.CREATE | |
| parameters: | |
| - name: bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bill. | |
| schema: | |
| type: string | |
| example: '460000000098765' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bills/{bill_id}/payments: | |
| get: | |
| tags: | |
| - bills | |
| operationId: list_bill_payments | |
| summary: List bill payments | |
| description: Get the list of payments made for a bill. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-bill-payments-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.READ | |
| parameters: | |
| - name: bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bill. | |
| schema: | |
| type: string | |
| example: '460000000098765' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bills/{bill_id}/payments/{bill_payment_id}: | |
| delete: | |
| tags: | |
| - bills | |
| operationId: delete_bill_payment | |
| summary: Delete a payment | |
| description: Delete a payment made to a bill. | |
| parameters: | |
| - name: bill_payment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bill payment. | |
| schema: | |
| type: string | |
| example: '460000000042061' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.DELETE | |
| parameters: | |
| - name: bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bill. | |
| schema: | |
| type: string | |
| example: '460000000098765' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bills/{bill_id}/status/open: | |
| post: | |
| tags: | |
| - bills | |
| operationId: mark_bill_open | |
| summary: Mark a bill as open | |
| description: Mark a void bill as open. | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-a-bill-as-open-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.CREATE | |
| parameters: | |
| - name: bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bill. | |
| schema: | |
| type: string | |
| example: '460000000098765' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bills/{bill_id}/status/void: | |
| post: | |
| tags: | |
| - bills | |
| operationId: mark_bill_void | |
| summary: Void a bill | |
| description: Mark a bill status as void. | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/void-a-bill-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.CREATE | |
| parameters: | |
| - name: bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bill. | |
| schema: | |
| type: string | |
| example: '460000000098765' | |
| - $ref: '#/components/parameters/organization_id' | |
| /bills/{bill_id}/submit: | |
| post: | |
| tags: | |
| - bills | |
| operationId: submit_bill | |
| summary: Submit a bill for approval | |
| description: Submit a bill for approval. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/submit-a-bill-for-approval-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.CREATE | |
| parameters: | |
| - name: bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the bill. | |
| schema: | |
| type: string | |
| example: '460000000098765' | |
| - $ref: '#/components/parameters/organization_id' | |
| /chartofaccounts: | |
| post: | |
| tags: | |
| - chart-of-accounts | |
| operationId: create_chart_of_account | |
| summary: Create an account | |
| description: Creates an account with the given account type. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-an-account-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-an-account-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.CREATE | |
| get: | |
| tags: | |
| - chart-of-accounts | |
| operationId: list_chart_of_accounts | |
| summary: List chart of accounts | |
| description: List all chart of accounts along with pagination. | |
| parameters: | |
| - name: showbalance | |
| in: query | |
| description: Boolean to get current balance of accounts. | |
| required: false | |
| schema: | |
| type: boolean | |
| - name: filter_by | |
| in: query | |
| description: 'Filter accounts based on its account type and status. Allowed | |
| Values: <code>AccountType.All</code>, <code>AccountType.Active</code>, <code>AccountType.Inactive</code>, | |
| <code>AccountType.Asset</code>, <code>AccountType.Liability</code>, <code>AccountType.Equity</code>, | |
| <code>AccountType.Income</code> and <code>AccountType.Expense</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sort_column | |
| in: query | |
| description: 'Sort accounts. Allowed Values: <code>account_name</code> and | |
| <code>account_type</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: last_modified_time | |
| in: query | |
| required: false | |
| schema: | |
| type: string | |
| example: 2013-01-17T15:27:23+0530 | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-chart-of-accounts-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /chartofaccounts/transactions: | |
| get: | |
| tags: | |
| - chart-of-accounts | |
| operationId: list_chart_of_account_transactions | |
| summary: List of transactions for an account | |
| description: List all involved transactions for the given account. | |
| parameters: | |
| - name: account_id | |
| in: query | |
| description: ID of the Account | |
| required: true | |
| schema: | |
| type: string | |
| example: '460000000038079' | |
| - name: date | |
| in: query | |
| description: 'Search account transactions with the given date range. Default | |
| date format is yyyy-mm-dd. Variants: <code>date.start</code>, <code>date.end</code>, | |
| <code>date.before</code> and <code>date.after</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: amount | |
| in: query | |
| description: 'Search account transactions with given amount range. Variants: | |
| <code>amount.less_than</code>, <code>amount.less_equals</code>, <code>amount.greater_than</code> | |
| and <code>amount.greater_equals</code>.' | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| example: '' | |
| - name: filter_by | |
| in: query | |
| description: 'Filter accounts based on its account type and status. Allowed | |
| Values: <code>AccountType.All</code>, <code>AccountType.Active</code>, <code>AccountType.Inactive</code>, | |
| <code>AccountType.Asset</code>, <code>AccountType.Liability</code>, <code>AccountType.Equity</code>, | |
| <code>AccountType.Income</code> and <code>AccountType.Expense</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: transaction_type | |
| in: query | |
| description: 'Search transactions based on the given transaction type. Allowed | |
| Values: <code>invoice</code>, <code>customer_payment</code>, <code>bills</code>, | |
| <code>vendor_payment</code>, <code>credit_notes</code>, <code>creditnote_refund</code>, | |
| <code>expense</code>, <code>card_payment</code>, <code>purchase_or_charges</code>, | |
| <code>journal</code>, <code>deposit</code>, <code>refund</code>, <code>transfer_fund</code>, | |
| <code>base_currency_adjustment</code>, <code>opening_balance</code>, <code>sales_without_invoices</code>, | |
| <code>expense_refund</code>, <code>tax_refund</code>, <code>receipt_from_initial_debtors</code>, | |
| <code>owner_contribution</code>, <code>interest_income</code>, <code>other_income</code>, | |
| <code>owner_drawings</code> and <code>payment_to_initial_creditors</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: customer_payment | |
| - name: sort_column | |
| in: query | |
| description: 'Sort accounts. Allowed Values: <code>account_name</code> and | |
| <code>account_type</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-of-transactions-for-an-account-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /chartofaccounts/transactions/{transaction_id}: | |
| delete: | |
| tags: | |
| - chart-of-accounts | |
| operationId: delete_chart_of_account_transaction | |
| summary: Delete a transaction | |
| description: Deletes the transaction. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-transaction-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.DELETE | |
| parameters: | |
| - name: transaction_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the transaction. | |
| schema: | |
| type: string | |
| example: '460000000050163' | |
| - $ref: '#/components/parameters/organization_id' | |
| /chartofaccounts/{account_id}: | |
| put: | |
| tags: | |
| - chart-of-accounts | |
| operationId: update_chart_of_account | |
| summary: Update an account | |
| description: Updates the account information. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-account-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-account-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.UPDATE | |
| get: | |
| tags: | |
| - chart-of-accounts | |
| operationId: get_chart_of_account | |
| summary: Get an account | |
| description: Gets the details of an account. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-an-account-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.READ | |
| delete: | |
| tags: | |
| - chart-of-accounts | |
| operationId: delete_chart_of_account | |
| summary: Delete an account | |
| description: Deletes the given account. Accounts associated in any transaction/products | |
| could not be deleted. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-an-account-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.DELETE | |
| parameters: | |
| - name: account_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the account. | |
| schema: | |
| type: string | |
| example: '460000000038079' | |
| - $ref: '#/components/parameters/organization_id' | |
| /chartofaccounts/{account_id}/active: | |
| post: | |
| tags: | |
| - chart-of-accounts | |
| operationId: mark_chart_of_account_active | |
| summary: Mark an account as active | |
| description: Updates the account status as active. | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-an-account-as-active-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.CREATE | |
| parameters: | |
| - name: account_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the account. | |
| schema: | |
| type: string | |
| example: '460000000038079' | |
| - $ref: '#/components/parameters/organization_id' | |
| /chartofaccounts/{account_id}/inactive: | |
| post: | |
| tags: | |
| - chart-of-accounts | |
| operationId: mark_chart_of_account_inactive | |
| summary: Mark an account as inactive | |
| description: Updates the account status as inactive. | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-an-account-as-inactive-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.CREATE | |
| parameters: | |
| - name: account_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the account. | |
| schema: | |
| type: string | |
| example: '460000000038079' | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts: | |
| post: | |
| tags: | |
| - contacts | |
| operationId: create_contact | |
| summary: Create a Contact | |
| description: Create a new contact with comprehensive business information. This | |
| operation allows you to create a customer or vendor by providing details such | |
| as contact name, company information, addresses, contact persons, payment | |
| terms, tax settings, and custom fields. The created contact can be used for | |
| generating invoices, bills, estimates, and other business transactions. The | |
| system automatically assigns a unique contact ID. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-contact-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-contact-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.CREATE | |
| get: | |
| tags: | |
| - contacts | |
| operationId: list_contacts | |
| summary: List Contacts | |
| description: Retrieve a comprehensive list of all contacts with advanced filters. | |
| This operation supports multiple search criteria including contact name, company | |
| name, address, email, phone, and general text search. You can filter contacts | |
| by status (active, inactive, duplicate, CRM) and sort by various fields. The | |
| response includes essential contact information, financial data including | |
| outstanding amounts and credit limits, and pagination details for efficient | |
| data retrieval. | |
| parameters: | |
| - name: contact_type | |
| in: query | |
| description: 'Search contacts by contact type. Allowed Values: <code>customer</code>, | |
| <code>vendor</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: customer | |
| - name: contact_name | |
| in: query | |
| description: 'Search contacts by contact name. Max-length [100] Variants: | |
| <code>contact_name_startswith</code> and <code>contact_name_contains</code>. | |
| Max-length [100]' | |
| required: false | |
| schema: | |
| type: string | |
| example: Bowman and Co | |
| - name: company_name | |
| in: query | |
| description: 'Search contacts by company name. Max-length [100] Variants: | |
| <code>company_name_startswith</code> and <code>company_name_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: Bowman and Co | |
| - name: first_name | |
| in: query | |
| description: 'Search contacts by first name of the primary contact person. | |
| Max-length [100] Variants: <code>first_name_startswith</code> and <code>first_name_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: Will | |
| - name: last_name | |
| in: query | |
| description: 'Search contacts by last name of the primary contact person. | |
| Max-length [100] Variants: <code>last_name_startswith</code> and <code>last_name_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: Smith | |
| - name: address | |
| in: query | |
| description: 'Search contacts by any of the address fields. Max-length [100] | |
| Variants: <code>address_startswith</code> and <code>address_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: 4900 Hopyard Rd | |
| - name: email | |
| in: query | |
| description: 'Search contacts by email of the primary contact person. Max-length | |
| [100] Variants: <code>email_startswith</code> and <code>email_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: willsmith@bowmanfurniture.com | |
| - name: phone | |
| in: query | |
| description: 'Search contacts by phone number of the primary contact person. | |
| Max-length [100] Variants: <code>phone_startswith</code> and <code>phone_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: +1-925-921-9201 | |
| - name: filter_by | |
| in: query | |
| description: 'Filter contacts by status. Allowed Values: <code>Status.All, | |
| Status.Active, Status.Inactive, Status.Duplicate, Status.PortalEnabled, | |
| Status.PortalDisabled, Invoice.OverDue, Invoice.Unpaid, Status.CreditLimitExceed | |
| and Status.Crm</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: search_text | |
| in: query | |
| description: Search contacts by contact name or notes. Max-length [100] | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sort_column | |
| in: query | |
| description: 'Sort contacts. Allowed Values: <code>contact_name, first_name, | |
| last_name, email, outstanding_receivable_amount, created_time and last_modified_time</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: contact_name | |
| - name: zcrm_contact_id | |
| in: query | |
| description: CRM Contact ID for the contact. | |
| required: false | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - name: zcrm_account_id | |
| in: query | |
| description: CRM Account ID for the contact. | |
| required: false | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - name: zcrm_vendor_id | |
| in: query | |
| description: CRM Vendor ID for the contact. | |
| required: false | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-contacts-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.READ | |
| put: | |
| tags: | |
| - contacts | |
| operationId: update_contact_using_custom_field | |
| summary: Update a contact using a custom field's unique value | |
| description: A custom field will have unique values if it's configured to not | |
| accept duplicate values. Now, you can use that custom field's value to update | |
| a contact by providing its API name in the X-Unique-Identifier-Key header | |
| and its value in the X-Unique-Identifier-Value header. Based on this value, | |
| the corresponding contact will be retrieved and updated. Additionally, there | |
| is an optional X-Upsert header. If the X-Upsert header is true and the custom | |
| field's unique value is not found in any of the existing contacts, a new contact | |
| will be created if the necessary payload details are available | |
| parameters: | |
| - name: X-Unique-Identifier-Key | |
| in: header | |
| description: Unique CustomField Api Name | |
| required: true | |
| schema: | |
| type: string | |
| example: cf_unique_cf | |
| - name: X-Unique-Identifier-Value | |
| in: header | |
| description: Unique CustomField Value | |
| required: true | |
| schema: | |
| type: string | |
| example: unique Value | |
| - name: X-Upsert | |
| in: header | |
| description: If there is no record is found unique custom field value , will | |
| create new invoice | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-contact-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-contact-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/contactpersons: | |
| post: | |
| tags: | |
| - contact-persons | |
| operationId: create_contact_person | |
| summary: Create a contact person | |
| description: Create a contact person for contact. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-contact-person-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-contact-person-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.CREATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/contactpersons/{contact_person_id}: | |
| put: | |
| tags: | |
| - contact-persons | |
| operationId: update_contact_person | |
| summary: Update a contact person | |
| description: Update an existing contact person. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-contact-person-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-contact-person-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.UPDATE | |
| delete: | |
| tags: | |
| - contact-persons | |
| operationId: delete_contact_person | |
| summary: Delete a contact person | |
| description: Delete an existing contact person. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-contact-person-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.DELETE | |
| parameters: | |
| - name: contact_person_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact person. | |
| schema: | |
| type: string | |
| example: 460000000026051 | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/contactpersons/{contact_person_id}/primary: | |
| post: | |
| tags: | |
| - contact-persons | |
| operationId: mark_contact_person_primary | |
| summary: Mark as primary contact person | |
| description: Mark a contact person as primary for the contact. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-as-primary-contact-person-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.CREATE | |
| parameters: | |
| - name: contact_person_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact person. | |
| schema: | |
| type: string | |
| example: 460000000026051 | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/{contact_id}: | |
| parameters: | |
| - name: contact_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact. | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - $ref: '#/components/parameters/organization_id' | |
| put: | |
| tags: | |
| - contacts | |
| operationId: update_contact | |
| summary: Update a Contact | |
| description: Update an existing contact with comprehensive business information. | |
| This operation allows you to modify all contact details including basic information, | |
| addresses, contact persons, payment terms, tax settings, and custom fields. | |
| For contact person, you can add new contact persons, update existing ones, | |
| or remove them by excluding them from the contact_persons list. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-contact-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-contact-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.UPDATE | |
| get: | |
| tags: | |
| - contacts | |
| operationId: get_contact | |
| summary: Get Contact | |
| description: Retrieve comprehensive details of a specific contact. This operation | |
| provides complete contact details such as basic information, addresses, contact | |
| persons, payment terms, tax settings, custom fields, and financial data including | |
| outstanding amounts, credit limits, and transaction history. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-contact-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.READ | |
| delete: | |
| tags: | |
| - contacts | |
| operationId: delete_contact | |
| summary: Delete a Contact | |
| description: Delete an existing contact. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-contact-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.DELETE | |
| /contacts/{contact_id}/active: | |
| post: | |
| tags: | |
| - contacts | |
| operationId: mark_contact_active | |
| summary: Mark as Active | |
| description: Mark a contact as active. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-as-active-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.CREATE | |
| parameters: | |
| - name: contact_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact. | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/{contact_id}/address: | |
| get: | |
| tags: | |
| - contacts | |
| operationId: get_contact_address | |
| summary: Get Contact Addresses | |
| description: Get addresses of a contact including its Shipping Address, Billing | |
| Address and other additional addresses. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-contact-addresses-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.READ | |
| post: | |
| tags: | |
| - contacts | |
| operationId: add_contact_address | |
| summary: Add Additional Address | |
| description: Add an additional address for a contact using the arguments below. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-additional-address-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-additional-address-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.CREATE | |
| parameters: | |
| - name: contact_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact. | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/{contact_id}/address/{address_id}: | |
| put: | |
| tags: | |
| - contacts | |
| operationId: update_contact_address | |
| summary: Edit Additional Address | |
| description: Edit the additional address of a contact using the arguments below. | |
| parameters: | |
| - name: address_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the address. | |
| schema: | |
| type: string | |
| example: 1053791000000186000 | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/edit-additional-address-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/edit-additional-address-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.UPDATE | |
| delete: | |
| tags: | |
| - contacts | |
| operationId: delete_contact_address | |
| summary: Delete Additional Address | |
| description: Delete the additional address of a contact. | |
| parameters: | |
| - name: address_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the address. | |
| schema: | |
| type: string | |
| example: 1053791000000186000 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-additional-address-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.DELETE | |
| parameters: | |
| - name: contact_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact. | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/{contact_id}/comments: | |
| get: | |
| tags: | |
| - contacts | |
| operationId: list_contact_comments | |
| summary: List Comments | |
| description: List recent activities of a contact. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-comments-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.READ | |
| parameters: | |
| - name: contact_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact. | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/{contact_id}/contactpersons: | |
| get: | |
| tags: | |
| - contact-persons | |
| operationId: list_contact_persons | |
| summary: List contact persons | |
| description: List all contacts with pagination. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-contact-persons-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.READ | |
| parameters: | |
| - name: contact_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact. | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/{contact_id}/contactpersons/{contact_person_id}: | |
| get: | |
| tags: | |
| - contact-persons | |
| operationId: get_contact_person | |
| summary: Get a contact person | |
| description: Get the contact person details. | |
| parameters: | |
| - name: contact_person_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact person. | |
| schema: | |
| type: string | |
| example: 460000000026051 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-contact-person-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.READ | |
| parameters: | |
| - name: contact_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact. | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/{contact_id}/email: | |
| post: | |
| tags: | |
| - contacts | |
| operationId: email_contact | |
| summary: Email Contact | |
| description: Send email to contact. | |
| parameters: | |
| - name: send_customer_statement | |
| in: query | |
| description: Send customer statement pdf with email. | |
| required: false | |
| schema: | |
| type: boolean | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-contact-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-contact-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.CREATE | |
| parameters: | |
| - name: contact_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact. | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/{contact_id}/inactive: | |
| post: | |
| tags: | |
| - contacts | |
| operationId: mark_contact_inactive | |
| summary: Mark as Inactive | |
| description: Mark a contact as inactive. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-as-inactive-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.CREATE | |
| parameters: | |
| - name: contact_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact. | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/{contact_id}/paymentreminder/disable: | |
| post: | |
| tags: | |
| - contacts | |
| operationId: disable_contact_payment_reminder | |
| summary: Disable Payment Reminders | |
| description: Disable automated payment reminders for a contact. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/disable-payment-reminders-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.CREATE | |
| parameters: | |
| - name: contact_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact. | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/{contact_id}/paymentreminder/enable: | |
| post: | |
| tags: | |
| - contacts | |
| operationId: enable_contact_payment_reminder | |
| summary: Enable Payment Reminders | |
| description: Enable automated payment reminders for a contact. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/enable-payment-reminders-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.CREATE | |
| parameters: | |
| - name: contact_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact. | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/{contact_id}/portal/enable: | |
| post: | |
| tags: | |
| - contacts | |
| operationId: enable_contact_portal | |
| summary: Enable Portal Access | |
| description: Enable portal access for a contact. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/enable-portal-access-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/enable-portal-access-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.CREATE | |
| parameters: | |
| - name: contact_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact. | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/{contact_id}/receivables/unusedretainerpayments: | |
| get: | |
| tags: | |
| - contacts | |
| operationId: get_unused_retainer_payments | |
| summary: Get Unused Retainer Payments | |
| description: Retrieve information about unused retainer payments for a specific | |
| contact. This endpoint returns details of retainer payments that have been | |
| made but not yet applied to invoices, providing insight into available credit | |
| balances from retainer payments. | |
| parameters: | |
| - name: currency_id | |
| in: query | |
| description: Currency ID to filter unused retainer payments by specific currency. | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000000097' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-unused-retainer-payments-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.READ | |
| parameters: | |
| - name: contact_id | |
| in: path | |
| required: true | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/{contact_id}/refunds: | |
| get: | |
| tags: | |
| - contacts | |
| operationId: list_contact_refunds | |
| summary: List Refunds | |
| description: List the refund history of a contact. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-refunds-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.READ | |
| parameters: | |
| - name: contact_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact. | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/{contact_id}/statements/email: | |
| post: | |
| tags: | |
| - contacts | |
| operationId: email_contact_statement | |
| summary: Email Statement | |
| description: Email statement to the contact. If JSONString is not inputted, | |
| mail will be sent with the default mail content. | |
| parameters: | |
| - name: start_date | |
| in: query | |
| description: If start_date and end_date are not given, current month's statement | |
| will be sent to contact. Date format [yyyy-mm-dd] | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: end_date | |
| in: query | |
| description: End date for the statement. Date format [yyyy-mm-dd] | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: multipart_or_formdata | |
| in: query | |
| description: Files to be attached along with the statement. | |
| required: false | |
| schema: | |
| type: string | |
| example: file | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-statement-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-statement-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.CREATE | |
| get: | |
| tags: | |
| - contacts | |
| operationId: get_contact_statement_mail | |
| summary: Get Statement Mail Content | |
| description: Get the statement mail content. | |
| parameters: | |
| - name: start_date | |
| in: query | |
| description: If start_date and end_date are not given, current month's statement | |
| will be sent to contact. Date format [yyyy-mm-dd] | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: end_date | |
| in: query | |
| description: End date for the statement. Date format [yyyy-mm-dd] | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-statement-mail-content-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.READ | |
| parameters: | |
| - name: contact_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact. | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/{contact_id}/track1099: | |
| post: | |
| tags: | |
| - contacts | |
| operationId: track_contact_1099 | |
| summary: Track 1099 | |
| description: 'Track a contact for 1099 reporting: (Note: This API is only available | |
| when the organization''s country is U.S.A).' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/track-1099-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.CREATE | |
| parameters: | |
| - name: contact_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact. | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /contacts/{contact_id}/untrack1099: | |
| post: | |
| tags: | |
| - contacts | |
| operationId: untrack_contact_1099 | |
| summary: Untrack 1099 | |
| description: 'Use this API to stop tracking payments to a vendor for 1099 reporting. | |
| (Note: This API is only available when the organization''s country is U.S.A).' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/untrack-1099-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.CREATE | |
| parameters: | |
| - name: contact_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the contact. | |
| schema: | |
| type: string | |
| example: 460000000026049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes: | |
| post: | |
| tags: | |
| - credit-notes | |
| operationId: create_credit_note | |
| summary: Create a credit note | |
| description: Create a new credit note to record credits issued to customers | |
| for returned items, overpayments, or adjustments. Supports multi-currency | |
| transactions, custom line items, tax calculations, and workflows. | |
| parameters: | |
| - name: invoice_id | |
| in: query | |
| description: Invoice ID of the required invoice. | |
| required: false | |
| schema: | |
| type: string | |
| example: '90300000079426' | |
| - name: ignore_auto_number_generation | |
| in: query | |
| description: Set to true if you need to provide your own credit note number. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-credit-note-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-credit-note-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.CREATE | |
| get: | |
| tags: | |
| - credit-notes | |
| operationId: list_credit_notes | |
| summary: List all Credit Notes | |
| description: Retrieve a paginated list of credit notes with comprehensive filtering, | |
| sorting, and search capabilities. Use query parameters to filter by date, | |
| status, amount, customer details, items, taxes, and custom fields. | |
| parameters: | |
| - name: creditnote_number | |
| in: query | |
| description: Filter credit notes by specific credit note number. Use this | |
| parameter to search for a particular credit note by its unique number. Max-Length | |
| [100] | |
| required: false | |
| schema: | |
| type: string | |
| example: CN-29 | |
| - name: date | |
| in: query | |
| description: Filter credit notes by the date they were raised. Use yyyy-mm-dd | |
| format to search for credit notes created on a specific date. | |
| required: false | |
| schema: | |
| type: string | |
| example: '2016-06-05' | |
| - name: status | |
| in: query | |
| description: 'Filter credit notes by their current status. Allowed values: | |
| <code>open</code>, <code>closed</code>, <code>void</code>, or <code>draft</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: draft | |
| - name: total | |
| in: query | |
| description: Filter credit notes by their total amount. Use this parameter | |
| to search for credit notes with a specific total value. | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| example: 450 | |
| - name: reference_number | |
| in: query | |
| description: Filter credit notes by their reference number. Use this parameter | |
| to search for credit notes with a specific reference number. Max-Length | |
| [100] | |
| required: false | |
| schema: | |
| type: string | |
| example: INV-384 | |
| - name: customer_name | |
| in: query | |
| description: Filter credit notes by customer name. Use this parameter to search | |
| for credit notes associated with a specific customer. Max-Length [100] | |
| required: false | |
| schema: | |
| type: string | |
| example: Bowman Furniture | |
| - name: item_name | |
| in: query | |
| description: Filter credit notes by item name. Use this parameter to search | |
| for credit notes containing specific items. Max-Length [100] | |
| required: false | |
| schema: | |
| type: string | |
| example: kit | |
| - name: customer_id | |
| in: query | |
| description: Filter credit notes by customer ID. Use this parameter to search | |
| for credit notes associated with a specific customer. Retrieve customer | |
| IDs from the contacts API. | |
| required: false | |
| schema: | |
| type: string | |
| example: '903000000000099' | |
| - name: item_description | |
| in: query | |
| description: Filter credit notes by item description. Supports variants <code>item_description_startswith</code> | |
| and <code>item_description_contains</code> for flexible searching. Max-length | |
| [100] | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: item_id | |
| in: query | |
| description: Filter credit notes by item ID. Use this parameter to search | |
| for credit notes containing a specific item. Retrieve item IDs from the | |
| items API. | |
| required: false | |
| schema: | |
| type: string | |
| example: '90300000081501' | |
| - name: line_item_id | |
| in: query | |
| description: Filter credit notes by line item ID. Use this parameter to search | |
| for credit notes containing a specific line item within the credit note. | |
| required: false | |
| schema: | |
| type: string | |
| example: 903000006245 | |
| - name: tax_id | |
| in: query | |
| description: Filter credit notes by tax ID. Use this parameter to search for | |
| credit notes with a specific tax applied. Retrieve tax IDs from the taxes | |
| API. | |
| required: false | |
| schema: | |
| type: string | |
| example: '903000000000356' | |
| - name: filter_by | |
| in: query | |
| description: 'Filter credit notes by status using predefined status values. | |
| Allowed values: <code>Status.All</code>, <code>Status.Open</code>, <code>Status.Draft</code>, | |
| <code>Status.Closed</code>, and <code>Status.Void</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: search_text | |
| in: query | |
| description: Search credit notes using text search across multiple fields. | |
| Searches credit note number, customer name, and reference number. Max-length | |
| [100] | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sort_column | |
| in: query | |
| description: 'Sort credit notes by specified column. Allowed values: <code>customer_name</code>, | |
| <code>creditnote_number</code>, <code>balance</code>, <code>total</code>, | |
| <code>date</code>, and <code>created_time</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: created_time | |
| - name: page | |
| in: query | |
| description: Page number for pagination. Specify which page of results to | |
| retrieve. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records per page for pagination. Controls how many | |
| credit notes are returned in each page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-all-credit-notes-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.READ | |
| put: | |
| tags: | |
| - credit-notes | |
| operationId: update_credit_note_using_custom_field | |
| summary: Update a credit note using a custom field's unique value | |
| description: A custom field will have unique values if it's configured to not | |
| accept duplicate values. Now, you can use that custom field's value to update | |
| a credit note by providing its API name in the X-Unique-Identifier-Key header | |
| and its value in the X-Unique-Identifier-Value header. Based on this value, | |
| the corresponding credit note will be retrieved and updated. Additionally, | |
| there is an optional X-Upsert header. If the X-Upsert header is true and the | |
| custom field's unique value is not found in any of the existing credit notes, | |
| a new credit note will be created if the necessary payload details are available | |
| parameters: | |
| - name: X-Unique-Identifier-Key | |
| in: header | |
| description: Unique CustomField Api Name | |
| required: true | |
| schema: | |
| type: string | |
| example: cf_unique_cf | |
| - name: X-Unique-Identifier-Value | |
| in: header | |
| description: Unique CustomField Value | |
| required: true | |
| schema: | |
| type: string | |
| example: unique Value | |
| - name: X-Upsert | |
| in: header | |
| description: If there is no record is found unique custom field value , will | |
| create new invoice | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-credit-note-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-credit-note-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/refunds: | |
| get: | |
| tags: | |
| - credit-notes | |
| operationId: list_credit_note_refunds | |
| summary: List credit note refunds | |
| description: List all refunds with pagination. | |
| parameters: | |
| - name: customer_id | |
| in: query | |
| description: Customer ID of the customer for whom the credit note is raised. | |
| required: false | |
| schema: | |
| type: string | |
| example: '903000000000099' | |
| - name: sort_column | |
| in: query | |
| description: 'Sort refunds list. Allowed Values: <code>refund_mode</code>, | |
| <code>reference_number</code>, <code>date</code>, <code>creditnote_number</code>, | |
| <code>customer_name</code>, <code>amount_bcy</code> and <code>amount_fcy</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: created_time | |
| - name: page | |
| in: query | |
| description: Page number for pagination. Specify which page of results to | |
| retrieve. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records per page for pagination. Controls how many | |
| credit notes are returned in each page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-credit-note-refunds-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/templates: | |
| get: | |
| tags: | |
| - credit-notes | |
| operationId: list_credit_note_templates | |
| summary: List credit note template | |
| description: Get all credit note pdf templates. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-credit-note-template-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/{creditnote_id}: | |
| put: | |
| tags: | |
| - credit-notes | |
| operationId: update_credit_note | |
| summary: Update a credit note | |
| description: Details of an existing creditnote. | |
| parameters: | |
| - name: ignore_auto_number_generation | |
| in: query | |
| description: Set to true if you need to provide your own credit note number. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-credit-note-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-credit-note-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.UPDATE | |
| get: | |
| tags: | |
| - credit-notes | |
| operationId: get_credit_note | |
| summary: Get a credit note | |
| description: Details of an existing creditnote. | |
| parameters: | |
| - name: print | |
| in: query | |
| description: 'Export credit note pdf with default print option. Allowed Values: | |
| <code>true</code>, <code>false</code>, <code>on</code> and <code>off</code>' | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| - name: accept | |
| in: query | |
| description: 'You can get credit note details as json/pdf/html. Default format | |
| is html. Allowed Values: <code>json</code>, <code>pdf</code> and <code>html</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-credit-note-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.READ | |
| delete: | |
| tags: | |
| - credit-notes | |
| operationId: delete_credit_note | |
| summary: Delete a credit note | |
| description: Delete an existing credit note. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-credit-note-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.DELETE | |
| parameters: | |
| - name: creditnote_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the credit note. | |
| schema: | |
| type: string | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/{creditnote_id}/address/billing: | |
| put: | |
| tags: | |
| - credit-notes | |
| operationId: update_credit_note_billing_address | |
| summary: Update billing address | |
| description: Updates the billing address for an existing credit note alone. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-billing-address-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-billing-address-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.UPDATE | |
| parameters: | |
| - name: creditnote_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the credit note. | |
| schema: | |
| type: string | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/{creditnote_id}/address/shipping: | |
| put: | |
| tags: | |
| - credit-notes | |
| operationId: update_credit_note_shipping_address | |
| summary: Update Shipping address | |
| description: Updates the shipping address for an existing credit note alone. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-shipping-address-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-shipping-address-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.UPDATE | |
| parameters: | |
| - name: creditnote_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the credit note. | |
| schema: | |
| type: string | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/{creditnote_id}/approve: | |
| post: | |
| tags: | |
| - credit-notes | |
| operationId: approve_credit_note | |
| summary: Approve a credit note. | |
| description: Approve a credit note. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/approve-a-credit-note-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.CREATE | |
| parameters: | |
| - name: creditnote_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the credit note. | |
| schema: | |
| type: string | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/{creditnote_id}/comments: | |
| get: | |
| tags: | |
| - credit-notes | |
| operationId: list_credit_note_comments | |
| summary: List credit note comments & history | |
| description: Get history and comments of a credit note. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-credit-note-comments-and-history-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.READ | |
| post: | |
| tags: | |
| - credit-notes | |
| operationId: add_credit_note_comment | |
| summary: Add a comment | |
| description: Add a comment to an existing credit note. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-a-comment-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-a-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.CREATE | |
| parameters: | |
| - name: creditnote_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the credit note. | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/{creditnote_id}/comments/{comment_id}: | |
| delete: | |
| tags: | |
| - credit-notes | |
| operationId: delete_credit_note_comment | |
| summary: Delete a Comment | |
| description: Delete a credit note comment. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.DELETE | |
| parameters: | |
| - name: creditnote_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the credit note. | |
| example: '90300000072369' | |
| - name: comment_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the comment. | |
| example: '982000000570001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/{creditnote_id}/email: | |
| post: | |
| tags: | |
| - credit-notes | |
| operationId: email_credit_note | |
| summary: Email a credit note | |
| description: Email a credit note. | |
| parameters: | |
| - name: customer_id | |
| in: query | |
| description: Customer ID of the customer for whom the credit note is raised. | |
| required: false | |
| schema: | |
| type: string | |
| example: '903000000000099' | |
| - name: attachments | |
| in: query | |
| description: The files to be attached with the email. | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-a-credit-note-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-a-credit-note-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.CREATE | |
| get: | |
| tags: | |
| - credit-notes | |
| operationId: get_credit_note_email | |
| summary: Get email content | |
| description: Get email content of a credit note. | |
| parameters: | |
| - name: email_template_id | |
| in: query | |
| description: Get the email content based on a specific email template. If | |
| this param is not inputted, then the content will be based on the email | |
| template associated with the customer. If no template is associated with | |
| the customer, then default template will be used. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-email-content-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.READ | |
| parameters: | |
| - name: creditnote_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the credit note. | |
| schema: | |
| type: string | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/{creditnote_id}/emailhistory: | |
| get: | |
| tags: | |
| - credit-notes | |
| operationId: get_credit_note_email_history | |
| summary: Email history | |
| description: Get email history of a credit code. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-history-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.READ | |
| parameters: | |
| - name: creditnote_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the credit note. | |
| schema: | |
| type: string | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/{creditnote_id}/invoices: | |
| get: | |
| tags: | |
| - credit-notes | |
| operationId: list_invoices_of_credit_note | |
| summary: List invoices credited | |
| description: List invoices to which the credit note is applied. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-invoices-credited-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.READ | |
| post: | |
| tags: | |
| - credit-notes | |
| operationId: apply_credit_note_to_invoice | |
| summary: Credit to an invoice | |
| description: Apply credit note to existing invoices. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/credit-to-an-invoice-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/credit-to-an-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.CREATE | |
| parameters: | |
| - name: creditnote_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the credit note. | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/{creditnote_id}/invoices/{creditnote_invoice_id}: | |
| delete: | |
| tags: | |
| - credit-notes | |
| operationId: delete_invoice_of_credit_note | |
| summary: Delete invoices credited | |
| description: Delete the credits applied to an invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-invoices-credited-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.DELETE | |
| parameters: | |
| - name: creditnote_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the credit note. | |
| example: '90300000072369' | |
| - name: creditnote_invoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the credit note invoice. | |
| example: '982000000567172' | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/{creditnote_id}/refunds: | |
| get: | |
| tags: | |
| - credit-notes | |
| operationId: list_credit_note_refunds | |
| summary: List refunds of a credit note | |
| description: List all refunds of an existing credit note. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number for pagination. Specify which page of results to | |
| retrieve. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records per page for pagination. Controls how many | |
| credit notes are returned in each page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-refunds-of-a-credit-note-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.READ | |
| post: | |
| tags: | |
| - credit-notes | |
| operationId: create_credit_note_refund | |
| summary: Refund credit note | |
| description: Refund credit note amount. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/refund-credit-note-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/refund-credit-note-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.CREATE | |
| parameters: | |
| - name: creditnote_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the credit note. | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/{creditnote_id}/refunds/{creditnote_refund_id}: | |
| get: | |
| tags: | |
| - credit-notes | |
| operationId: get_credit_note_refund | |
| summary: Get credit note refund | |
| description: Get refund of a particular credit note. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-credit-note-refund-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.READ | |
| put: | |
| tags: | |
| - credit-notes | |
| operationId: update_credit_note_refund | |
| summary: Update credit note refund | |
| description: Update the refunded transaction. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-credit-note-refund-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-credit-note-refund-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.UPDATE | |
| delete: | |
| tags: | |
| - credit-notes | |
| operationId: delete_credit_note_refund | |
| summary: Delete credit note refund | |
| description: Delete a credit note refund. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-credit-note-refund-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.DELETE | |
| parameters: | |
| - name: creditnote_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the credit note. | |
| example: '90300000072369' | |
| - name: creditnote_refund_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the credit note refund. | |
| example: '982000000567158' | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/{creditnote_id}/status/draft: | |
| post: | |
| tags: | |
| - credit-notes | |
| operationId: mark_credit_note_draft | |
| summary: Convert Credit Note to Draft. | |
| description: Convert a voided credit note to Draft. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/convert-credit-note-to-draft-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.CREATE | |
| parameters: | |
| - name: creditnote_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the credit note. | |
| schema: | |
| type: string | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/{creditnote_id}/status/open: | |
| post: | |
| tags: | |
| - credit-notes | |
| operationId: mark_credit_note_open | |
| summary: Convert to Open | |
| description: Convert a credit note in Draft status to Open. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/convert-to-open-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.CREATE | |
| parameters: | |
| - name: creditnote_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the credit note. | |
| schema: | |
| type: string | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/{creditnote_id}/status/void: | |
| post: | |
| tags: | |
| - credit-notes | |
| operationId: mark_credit_note_void | |
| summary: Void a Credit Note | |
| description: Mark the credit note as Void. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/void-a-credit-note-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.CREATE | |
| parameters: | |
| - name: creditnote_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the credit note. | |
| schema: | |
| type: string | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/{creditnote_id}/submit: | |
| post: | |
| tags: | |
| - credit-notes | |
| operationId: submit_credit_note | |
| summary: Submit a credit note for approval | |
| description: Submit an estimate for approval. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/submit-a-credit-note-for-approval-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.CREATE | |
| parameters: | |
| - name: creditnote_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the credit note. | |
| schema: | |
| type: string | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /creditnotes/{creditnote_id}/templates/{template_id}: | |
| put: | |
| tags: | |
| - credit-notes | |
| operationId: update_credit_note_template | |
| summary: Update a credit note template | |
| description: Update the pdf template associated with the credit note. | |
| parameters: | |
| - name: template_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the credit note template. | |
| schema: | |
| type: string | |
| example: '90300000001336' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-credit-note-template-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.creditnotes.UPDATE | |
| parameters: | |
| - name: creditnote_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the credit note. | |
| schema: | |
| type: string | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /crm/account/{crm_account_id}/import: | |
| post: | |
| tags: | |
| - integration | |
| operationId: import_customer_using_crm_account_id | |
| summary: Import a customer using the CRM account ID | |
| description: 'Zoho Books must be integrated with Zoho CRM using Accounts and | |
| Contacts sync or using Accounts only sync to import a customer from CRM with | |
| its CRM account ID. <br> Note: You can get a contact by CRM account ID by | |
| using this <a href=/books/api/v3/contacts/#list-contacts/zcrm_account_id>API | |
| Endpoint</a>' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/import-a-customer-using-the-crm-account-id-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.CREATE | |
| parameters: | |
| - name: crm_account_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the zoho crm account. | |
| schema: | |
| type: string | |
| example: '460000000026041' | |
| - $ref: '#/components/parameters/organization_id' | |
| /crm/contact/{crm_contact_id}/import: | |
| post: | |
| tags: | |
| - integration | |
| operationId: import_customer_using_crm_contact_id | |
| summary: Import a customer using CRM contact ID | |
| description: 'Zoho Books must be integrated with Zoho CRM using <code>Contacts | |
| only sync</code> or <code>Accounts & their Contacts and Include contacts that | |
| are not associated to any accounts </code> sync type contacts that are not | |
| associated to any accounts in Zoho CRM to import a customer from CRM with | |
| its CRM contact ID. <br> Note: You can get a contact by CRM contact ID by | |
| using this <a href=/books/api/v3/contacts/#list-contacts/zcrm_contact_id>API | |
| Endpoint</a>' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/import-a-customer-using-crm-contact-id-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.CREATE | |
| parameters: | |
| - name: crm_contact_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the zoho crm contact. | |
| schema: | |
| type: string | |
| example: '460000000026042' | |
| - $ref: '#/components/parameters/organization_id' | |
| /crm/item/{crm_product_id}/import: | |
| post: | |
| tags: | |
| - integration | |
| summary: Import an item using the CRM product ID | |
| description: Zoho Books must be integrated with Zoho CRM using Products only | |
| sync to import an item from CRM with its CRM product ID. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/import-an-item-using-the-crm-product-id-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| parameters: | |
| - name: crm_product_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the zoho crm product. | |
| schema: | |
| type: string | |
| example: '460000000026055' | |
| - $ref: '#/components/parameters/organization_id' | |
| /crm/vendor/{crm_vendor_id}/import: | |
| post: | |
| tags: | |
| - integration | |
| operationId: import_vendor_using_crm_vendor_id | |
| summary: Import a vendor using the CRM vendor ID | |
| description: Zoho Books must be integrated with Zoho CRM using Vendor only sync | |
| to import a vendor from CRM with its CRM vendor ID. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/import-a-vendor-using-the-crm-vendor-id-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.contacts.CREATE | |
| parameters: | |
| - name: crm_vendor_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the zoho crm vendor. | |
| schema: | |
| type: string | |
| example: '460000000026043' | |
| - $ref: '#/components/parameters/organization_id' | |
| /customerpayment/{customer_payment_id}/customfields: | |
| put: | |
| tags: | |
| - customer-payments | |
| operationId: update_custom_fields_in_customer_payment | |
| summary: Update custom field in existing customerpayments | |
| description: Update the value of the custom field in existing customerpayments. | |
| parameters: | |
| - name: customer_payment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the customer payment. | |
| schema: | |
| type: string | |
| example: '9030000079467' | |
| - $ref: '#/components/parameters/organization_id' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/custom_fields_update' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-customerpayment-customfield-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.customerpayments.UPDATE | |
| /customerpayments: | |
| post: | |
| tags: | |
| - customer-payments | |
| operationId: create_customer_payment | |
| summary: Create a payment | |
| description: Create a new payment. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-payment-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.customerpayments.CREATE | |
| get: | |
| tags: | |
| - customer-payments | |
| operationId: list_customer_payments | |
| summary: List Customer Payments | |
| description: List all the payments made by your customer. | |
| parameters: | |
| - name: customer_name | |
| in: query | |
| description: 'Search payments by customer name. Variants: <code>customer_name_startswith</code> | |
| and <code>customer_name_contains</code>. Max-len [100]' | |
| required: false | |
| schema: | |
| type: string | |
| example: Bowman Furniture | |
| - name: reference_number | |
| in: query | |
| description: 'Search payments by reference number. Variants: <code>reference_number_startswith</code> | |
| and <code>reference_number_contains</code>. Max-len [100]' | |
| required: false | |
| schema: | |
| type: string | |
| example: INV-384 | |
| - name: date | |
| in: query | |
| required: false | |
| schema: | |
| type: string | |
| example: '2016-06-05' | |
| - name: amount | |
| in: query | |
| description: 'Search payments by payment amount. Variants: <code>amount_less_than</code>, | |
| <code>amount_less_equals</code>, <code>amount_greater_than</code> and <code>amount_greater_equals</code>' | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| example: 450 | |
| - name: notes | |
| in: query | |
| description: 'Search payments by customer notes. Variants: <code>notes_startswith</code> | |
| and <code>notes_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: payment_mode | |
| in: query | |
| description: 'Search payments by payment mode. Variants: <code>payment_mode_startswith</code> | |
| and <code>payment_mode_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: cash | |
| - name: filter_by | |
| in: query | |
| description: 'Filter payments by mode.Allowed Values: <code>PaymentMode.All</code>, | |
| <code>PaymentMode.Check</code>, <code>PaymentMode.Cash</code>, <code>PaymentMode.BankTransfer</code>, | |
| <code>PaymentMode.Paypal</code>, <code>PaymentMode.CreditCard</code>, <code>PaymentMode.GoogleCheckout</code>, | |
| <code>PaymentMode.Credit</code>, <code>PaymentMode.Authorizenet</code>, | |
| <code>PaymentMode.BankRemittance</code>, <code>PaymentMode.Payflowpro</code>, | |
| <code>PaymentMode.Stripe</code>, <code>PaymentMode.TwoCheckout</code>, <code>PaymentMode.Braintree</code> | |
| and <code>PaymentMode.Others</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sort_column | |
| in: query | |
| required: false | |
| schema: | |
| type: string | |
| example: created_time | |
| - name: search_text | |
| in: query | |
| description: Search payments by reference number or customer name or payment | |
| description. Max-length [100] | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: customer_id | |
| in: query | |
| description: Customer ID of the customer involved in the payment. | |
| required: false | |
| schema: | |
| type: string | |
| example: '903000000000099' | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-customer-payments-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.customerpayments.READ | |
| delete: | |
| tags: | |
| - customer-payments | |
| operationId: bulk_delete_customer_payments | |
| summary: Bulk delete Customer payments | |
| description: Delete multiple customer payments. | |
| parameters: | |
| - name: payment_id | |
| in: query | |
| description: Comma-separated list of payment IDs to be deleted | |
| required: true | |
| schema: | |
| type: string | |
| example: 9030000079467,9030000079468,9030000079469 | |
| - name: bulk_delete | |
| in: query | |
| description: Flag to indicate bulk delete operation | |
| required: true | |
| schema: | |
| type: boolean | |
| example: true | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/bulk-delete-customer-payments-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.customerpayments.DELETE | |
| put: | |
| tags: | |
| - customer-payments | |
| operationId: update_customer_payment_using_custom_field | |
| summary: Update a payment using a custom field's unique value | |
| description: A custom field will have unique values if it's configured to not | |
| accept duplicate values. Now, you can use that custom field's value to update | |
| a payment by providing its API name in the X-Unique-Identifier-Key header | |
| and its value in the X-Unique-Identifier-Value header. Based on this value, | |
| the corresponding payment will be retrieved and updated. Additionally, there | |
| is an optional X-Upsert header. If the X-Upsert header is true and the custom | |
| field's unique value is not found in any of the existing payments, a new payment | |
| will be created if the necessary payload details are available | |
| parameters: | |
| - name: X-Unique-Identifier-Key | |
| in: header | |
| description: Unique CustomField Api Name | |
| required: true | |
| schema: | |
| type: string | |
| example: cf_unique_cf | |
| - name: X-Unique-Identifier-Value | |
| in: header | |
| description: Unique CustomField Value | |
| required: true | |
| schema: | |
| type: string | |
| example: unique Value | |
| - name: X-Upsert | |
| in: header | |
| description: If there is no record is found unique custom field value , will | |
| create new invoice | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-payment-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.customerpayments.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /customerpayments/{customer_payment_id}/refunds: | |
| get: | |
| tags: | |
| - customer-payments | |
| operationId: list_customer_payment_refunds | |
| summary: List refunds of a customer payment | |
| description: List all the refunds pertaining to an existing customer payment. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-refunds-of-a-customer-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.customerpayments.READ | |
| post: | |
| tags: | |
| - customer-payments | |
| operationId: create_customer_payment_refund | |
| summary: Refund an excess customer payment | |
| description: Refund the excess amount paid by the customer. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/refund-an-excess-customer-payment-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/refund-an-excess-customer-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.customerpayments.CREATE | |
| parameters: | |
| - name: customer_payment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the customer payment. | |
| schema: | |
| type: string | |
| example: '9030000079467' | |
| - $ref: '#/components/parameters/organization_id' | |
| /customerpayments/{customer_payment_id}/refunds/{refund_id}: | |
| get: | |
| tags: | |
| - customer-payments | |
| operationId: get_customer_payment_refund | |
| summary: Details of a refund | |
| description: Obtain details of a particular refund of a customer payment. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/details-of-a-refund-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.customerpayments.READ | |
| put: | |
| tags: | |
| - customer-payments | |
| operationId: update_customer_payment_refund | |
| summary: Update a refund | |
| description: Update the refunded transaction. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-refund-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-refund-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.customerpayments.UPDATE | |
| delete: | |
| tags: | |
| - customer-payments | |
| operationId: delete_customer_payment_refund | |
| summary: Delete a Refund | |
| description: Delete refund pertaining to an existing customer payment. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-refund-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.customerpayments.DELETE | |
| parameters: | |
| - name: customer_payment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the customer payment. | |
| schema: | |
| type: string | |
| example: '9030000079467' | |
| - name: refund_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the refund. | |
| schema: | |
| type: string | |
| example: '3000000003017' | |
| - $ref: '#/components/parameters/organization_id' | |
| /customerpayments/{payment_id}: | |
| put: | |
| tags: | |
| - customer-payments | |
| operationId: update_customer_payment | |
| summary: Update a payment | |
| description: Update an existing payment information. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-payment-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.customerpayments.UPDATE | |
| get: | |
| tags: | |
| - customer-payments | |
| operationId: get_customer_payment | |
| summary: Retrieve a payment | |
| description: Details of an existing payment. | |
| parameters: | |
| - name: accept | |
| in: query | |
| description: Format of the response. Allowed values are <code>json</code> | |
| and <code>pdf</code>. Default is <code>json</code>. | |
| required: false | |
| schema: | |
| type: string | |
| enum: | |
| - json | |
| default: json | |
| example: json | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/retrieve-a-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.customerpayments.READ | |
| delete: | |
| tags: | |
| - customer-payments | |
| operationId: delete_customer_payment | |
| summary: Delete a payment | |
| description: Delete an existing payment. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.customerpayments.DELETE | |
| parameters: | |
| - name: payment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the payment. | |
| schema: | |
| type: string | |
| example: '9030000079467' | |
| - $ref: '#/components/parameters/organization_id' | |
| /employee/{employee_id}: | |
| delete: | |
| tags: | |
| - expenses | |
| operationId: delete_employee | |
| summary: Delete an employee | |
| description: Delete an existing employee. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-an-employee-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.DELETE | |
| parameters: | |
| - name: employee_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the expense. | |
| schema: | |
| type: string | |
| example: '982000000030040' | |
| - $ref: '#/components/parameters/organization_id' | |
| /employees: | |
| get: | |
| tags: | |
| - expenses | |
| operationId: list_employees | |
| summary: List employees | |
| description: List employees with pagination. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-employees-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.READ | |
| post: | |
| tags: | |
| - expenses | |
| operationId: create_employee | |
| summary: Create an employee | |
| description: Create an employee for an expense. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-an-employee-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-an-employee-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.CREATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /employees/{employee_id}: | |
| get: | |
| tags: | |
| - expenses | |
| operationId: get_employee | |
| summary: Get an employee | |
| description: Get the details of the employee. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-an-employee-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.READ | |
| parameters: | |
| - name: employee_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the expense. | |
| schema: | |
| type: string | |
| example: '982000000030040' | |
| - $ref: '#/components/parameters/organization_id' | |
| /estimate/{estimate_id}/customfields: | |
| put: | |
| tags: | |
| - estimates | |
| operationId: update_custom_fields_in_estimate | |
| summary: Update custom field in existing estimates | |
| description: Update the value of the custom field in existing estimates. | |
| parameters: | |
| - name: estimate_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the estimate. | |
| schema: | |
| type: string | |
| example: 982000000567011 | |
| - $ref: '#/components/parameters/organization_id' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/custom_fields_update' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-estimate-customfield-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.UPDATE | |
| /estimates: | |
| post: | |
| tags: | |
| - estimates | |
| operationId: create_estimate | |
| summary: Create an Estimate | |
| description: Create an estimate for your customer. | |
| parameters: | |
| - name: send | |
| in: query | |
| description: 'Send the estimate to the contact person(s) associated with the | |
| estimate.Allowed Values: <code>true</code> and <code>false</code>' | |
| required: false | |
| schema: | |
| type: boolean | |
| - name: ignore_auto_number_generation | |
| in: query | |
| description: Ignore auto estimate number generation for this estimate. This | |
| mandates the estimate number. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-an-estimate-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-an-estimate-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.CREATE | |
| get: | |
| tags: | |
| - estimates | |
| operationId: list_estimates | |
| summary: List estimates | |
| description: List all estimates with pagination. | |
| parameters: | |
| - name: estimate_number | |
| in: query | |
| description: Filter or search estimates by their unique estimate number. Supports | |
| variants such as <code>estimate_number_startswith</code> and <code>estimate_number_contains</code> | |
| for partial matches. Useful for quickly locating a specific estimate or | |
| a group of estimates with similar numbering. | |
| required: false | |
| schema: | |
| type: string | |
| example: EST-00002 | |
| - name: reference_number | |
| in: query | |
| description: Filter or search estimates by their reference number. Supports | |
| variants such as <code>reference_number_startswith</code> and <code>reference_number_contains</code> | |
| for partial matches. Useful for linking estimates to external systems, customer | |
| requests, or internal workflows. | |
| required: false | |
| schema: | |
| type: string | |
| example: QRT-12346 | |
| - name: customer_name | |
| in: query | |
| description: Filter or search estimates by the customer's name. Supports variants | |
| such as <code>customer_name_startswith</code> and <code>customer_name_contains</code> | |
| for partial matches. Useful for quickly locating all estimates associated | |
| with a specific customer or group of customers with similar names. | |
| required: false | |
| schema: | |
| type: string | |
| example: Bowman & Co | |
| - name: total | |
| in: query | |
| description: Filter or search estimates by the total amount of the estimate. | |
| Supports variants such as <code>total_less_than</code>, <code>total_less_equals</code>, | |
| <code>total_greater_than</code>, and <code>total_greater_equals</code> for | |
| range-based queries. Useful for finding estimates within a specific budget | |
| or identifying high-value quotes. | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| example: 40.6 | |
| - name: customer_id | |
| in: query | |
| description: Filter or search estimates by the unique customer ID. Use the | |
| <code>customer_id</code> returned by the Contacts API for the same organization. | |
| This helps you retrieve all estimates linked to a specific customer. | |
| required: false | |
| schema: | |
| type: string | |
| example: 982000000567001 | |
| - name: item_id | |
| in: query | |
| description: Filter or search estimates by the unique item ID. Use the <code>item_id</code> | |
| returned by the Items API for the same organization. This allows you to | |
| find all estimates that include a specific product or service. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: item_name | |
| in: query | |
| description: Search estimates by item name.Variants <code>item_name_startswith</code> | |
| and <code>item_name_contains</code> | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: item_description | |
| in: query | |
| description: Search estimates by item description.Variants<code>item_description_startswith</code> | |
| and <code>item_description_contains</code> | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: custom_field | |
| in: query | |
| description: Search estimates by custom field.Variants<code>custom_field_startswith</code> | |
| and <code>custom_field_contains</code> | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: expiry_date | |
| in: query | |
| description: The date of expiration of the estimates | |
| required: false | |
| schema: | |
| type: string | |
| example: '2013-11-30' | |
| - name: date | |
| in: query | |
| description: Search estimates by estimate date.Variants <code>date_start</code>, | |
| <code>date_end</code>, <code>date_before</code> and <code>date_after</code> | |
| required: false | |
| schema: | |
| type: string | |
| example: '2013-11-18' | |
| - name: status | |
| in: query | |
| description: Search estimates by status.Allowed Values<code>draft</code>, | |
| <code>sent</code>,<code> invoiced </code>, <code>accepted</code>, <code>declined</code> | |
| and <code>expired</code> | |
| required: false | |
| schema: | |
| type: string | |
| example: draft | |
| - name: filter_by | |
| in: query | |
| description: Filter estimates by status.Allowed Values <code>Status.All</code>, | |
| <code>Status.Sent</code>, <code>Status.Draft</code>, <code>Status.Invoiced</code>, | |
| <code>Status.Accepted</code>, <code>Status.Declined</code> and <code>Status.Expired</code> | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: search_text | |
| in: query | |
| description: Perform a keyword search across estimate number, reference number, | |
| or customer name. Use this parameter to quickly find estimates that match | |
| any of these fields, making it easier to locate relevant records with minimal | |
| input. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sort_column | |
| in: query | |
| description: Sort estimates. Allowed Values <code>customer_name</code>, <code>estimate_number</code>, | |
| <code>date</code>, <code>total</code> and <code>created_time</code> | |
| required: false | |
| schema: | |
| type: string | |
| example: created_time | |
| - name: zcrm_potential_id | |
| in: query | |
| description: Potential ID of a Deal in CRM. | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| example: 460000000026049 | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-estimates-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.READ | |
| put: | |
| tags: | |
| - contacts | |
| operationId: update_estimate_using_custom_field | |
| summary: update an Estimate using a custom field's unique value | |
| description: A custom field will have unique values if it's configured to not | |
| accept duplicate values. Now, you can use that custom field's value to update | |
| an estimate by providing its API name in the X-Unique-Identifier-Key header | |
| and its value in the X-Unique-Identifier-Value header. Based on this value, | |
| the corresponding estimate will be retrieved and updated. Additionally, there | |
| is an optional X-Upsert header. If the X-Upsert header is true and the custom | |
| field's unique value is not found in any of the existing estimates, a new | |
| estimate will be created if the necessary payload details are available | |
| parameters: | |
| - name: X-Unique-Identifier-Key | |
| in: header | |
| description: Unique CustomField Api Name | |
| required: true | |
| schema: | |
| type: string | |
| example: cf_unique_cf | |
| - name: X-Unique-Identifier-Value | |
| in: header | |
| description: Unique CustomField Value | |
| required: true | |
| schema: | |
| type: string | |
| example: unique Value | |
| - name: X-Upsert | |
| in: header | |
| description: If there is no record is found unique custom field value , will | |
| create new invoice | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-estimate-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-estimate-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /estimates/email: | |
| post: | |
| tags: | |
| - estimates | |
| operationId: email_multiple_estimates | |
| summary: Email multiple estimates | |
| description: Send estimates to your customers by email. Maximum of 10 estimates | |
| can be sent at once. | |
| parameters: | |
| - name: estimate_ids | |
| in: query | |
| description: Comma separated estimate ids which are to be emailed. | |
| required: true | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-multiple-estimates-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.CREATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /estimates/pdf: | |
| get: | |
| tags: | |
| - estimates | |
| operationId: bulk_export_estimates_as_pdf | |
| summary: Bulk export estimates | |
| description: Maximum of 25 estimates can be exported in a single pdf. | |
| parameters: | |
| - name: estimate_ids | |
| in: query | |
| description: Comma separated estimate ids which are to be emailed. | |
| required: true | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/bulk-export-estimates-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /estimates/print: | |
| get: | |
| tags: | |
| - estimates | |
| operationId: bulk_print_estimates | |
| summary: Bulk print estimates | |
| description: Export estimates as pdf and print them. Maximum of 25 estimates | |
| can be printed. | |
| parameters: | |
| - name: estimate_ids | |
| in: query | |
| description: Comma separated estimate ids which are to be emailed. | |
| required: true | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/bulk-print-estimates-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /estimates/templates: | |
| get: | |
| tags: | |
| - estimates | |
| operationId: list_estimate_templates | |
| summary: List estimate template | |
| description: Get all estimate pdf templates. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-estimate-template-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /estimates/{estimate_id}: | |
| put: | |
| tags: | |
| - estimates | |
| operationId: update_estimate | |
| summary: Update an Estimate | |
| description: Update an existing estimate. To delete a line item just remove | |
| it from the line_items list. | |
| parameters: | |
| - name: ignore_auto_number_generation | |
| in: query | |
| description: Ignore auto estimate number generation for this estimate. This | |
| mandates the estimate number. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-estimate-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-estimate-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.UPDATE | |
| get: | |
| tags: | |
| - estimates | |
| operationId: get_estimate | |
| summary: Get an estimate | |
| description: Get the details of an estimate. | |
| parameters: | |
| - name: print | |
| in: query | |
| description: Print the exported pdf. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: ' ' | |
| - name: accept | |
| in: query | |
| description: 'Get the details of a particular estimate in formats such as | |
| json/ pdf/ html. Default format is json.Allowed Values: <code>json</code>, | |
| <code>pdf</code> and <code>html</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-an-estimate-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.READ | |
| delete: | |
| tags: | |
| - estimates | |
| operationId: delete_estimate | |
| summary: Delete an Estimate | |
| description: Delete an existing estimate. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-an-estimate-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.DELETE | |
| parameters: | |
| - name: estimate_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the estimate. | |
| schema: | |
| type: string | |
| example: 982000000567011 | |
| - $ref: '#/components/parameters/organization_id' | |
| /estimates/{estimate_id}/address/billing: | |
| put: | |
| tags: | |
| - estimates | |
| operationId: update_estimate_billing_address | |
| summary: Update billing address | |
| description: Updates the billing address for this estimate alone. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-billing-address-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-billing-address-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.UPDATE | |
| parameters: | |
| - name: estimate_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the estimate. | |
| schema: | |
| type: string | |
| example: 982000000567011 | |
| - $ref: '#/components/parameters/organization_id' | |
| /estimates/{estimate_id}/address/shipping: | |
| put: | |
| tags: | |
| - estimates | |
| operationId: update_estimate_shipping_address | |
| summary: Update shipping address | |
| description: Updates the shipping address for an existing estimate alone. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-shipping-address-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-shipping-address-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.UPDATE | |
| parameters: | |
| - name: estimate_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the estimate. | |
| schema: | |
| type: string | |
| example: 982000000567011 | |
| - $ref: '#/components/parameters/organization_id' | |
| /estimates/{estimate_id}/approve: | |
| post: | |
| tags: | |
| - estimates | |
| operationId: approve_estimate | |
| summary: Approve an estimate. | |
| description: Approve an estimate. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/approve-an-estimate-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.CREATE | |
| parameters: | |
| - name: estimate_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the estimate. | |
| schema: | |
| type: string | |
| example: 982000000567011 | |
| - $ref: '#/components/parameters/organization_id' | |
| /estimates/{estimate_id}/comments: | |
| get: | |
| tags: | |
| - estimates | |
| operationId: list_estimate_comments | |
| summary: List estimate comments & history | |
| description: Get the complete history and comments of an estimate. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-estimate-comments-and-history-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.READ | |
| post: | |
| tags: | |
| - estimates | |
| operationId: create_estimate_comment | |
| summary: Add Comments | |
| description: Add a comment for an estimate. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-comments-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-comments-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.CREATE | |
| parameters: | |
| - name: estimate_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the estimate. | |
| schema: | |
| type: string | |
| example: 982000000567011 | |
| - $ref: '#/components/parameters/organization_id' | |
| /estimates/{estimate_id}/comments/{comment_id}: | |
| put: | |
| tags: | |
| - estimates | |
| operationId: update_estimate_comment | |
| summary: Update comment | |
| description: Update an existing comment of an estimate. | |
| parameters: | |
| - name: comment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the comment. | |
| schema: | |
| type: string | |
| example: 982000000567019 | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-comment-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.UPDATE | |
| delete: | |
| tags: | |
| - estimates | |
| operationId: delete_estimate_comment | |
| summary: Delete a comment | |
| description: Delete an estimate comment. | |
| parameters: | |
| - name: comment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the comment. | |
| schema: | |
| type: string | |
| example: 982000000567019 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.DELETE | |
| parameters: | |
| - name: estimate_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the estimate. | |
| schema: | |
| type: string | |
| example: 982000000567011 | |
| - $ref: '#/components/parameters/organization_id' | |
| /estimates/{estimate_id}/email: | |
| post: | |
| tags: | |
| - estimates | |
| operationId: email_estimate | |
| summary: Email an estimate | |
| description: Email an estimate to the customer. Input json string is not mandatory. | |
| If input json string is empty, mail will be send with default mail content. | |
| parameters: | |
| - name: attachments | |
| in: query | |
| description: Files to be attached to the email | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-an-estimate-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-an-estimate-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.CREATE | |
| get: | |
| tags: | |
| - estimates | |
| operationId: get_estimate_email | |
| summary: Get estimate email content | |
| description: Get the email content of an estimate. | |
| parameters: | |
| - name: email_template_id | |
| in: query | |
| description: Get the email content based on a specific email template. If | |
| this param is not inputted, then the content will be based on the email | |
| template associated with the customer. If no template is associated with | |
| the customer, then default template will be used. | |
| required: true | |
| schema: | |
| type: string | |
| example: 982000000000079 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-estimate-email-content-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.READ | |
| parameters: | |
| - name: estimate_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the estimate. | |
| schema: | |
| type: string | |
| example: 982000000567011 | |
| - $ref: '#/components/parameters/organization_id' | |
| /estimates/{estimate_id}/status/accepted: | |
| post: | |
| tags: | |
| - estimates | |
| operationId: mark_estimate_accepted | |
| summary: Mark an estimate as accepted | |
| description: Mark a sent estimate as accepted if the customer has accepted it. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-an-estimate-as-accepted-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.CREATE | |
| parameters: | |
| - name: estimate_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the estimate. | |
| schema: | |
| type: string | |
| example: 982000000567011 | |
| - $ref: '#/components/parameters/organization_id' | |
| /estimates/{estimate_id}/status/declined: | |
| post: | |
| tags: | |
| - estimates | |
| operationId: mark_estimate_declined | |
| summary: Mark an estimate as declined | |
| description: Mark a sent estimate as declined if the customer has rejected it. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-an-estimate-as-declined-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.CREATE | |
| parameters: | |
| - name: estimate_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the estimate. | |
| schema: | |
| type: string | |
| example: 982000000567011 | |
| - $ref: '#/components/parameters/organization_id' | |
| /estimates/{estimate_id}/status/sent: | |
| post: | |
| tags: | |
| - estimates | |
| operationId: mark_estimate_sent | |
| summary: Mark an estimate as sent | |
| description: Mark a draft estimate as sent. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-an-estimate-as-sent-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.CREATE | |
| parameters: | |
| - name: estimate_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the estimate. | |
| schema: | |
| type: string | |
| example: 982000000567011 | |
| - $ref: '#/components/parameters/organization_id' | |
| /estimates/{estimate_id}/submit: | |
| post: | |
| tags: | |
| - estimates | |
| operationId: submit_estimate | |
| summary: Submit an estimate for approval | |
| description: Submit an estimate for approval. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/submit-an-estimate-for-approval-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.CREATE | |
| parameters: | |
| - name: estimate_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the estimate. | |
| schema: | |
| type: string | |
| example: 982000000567011 | |
| - $ref: '#/components/parameters/organization_id' | |
| /estimates/{estimate_id}/templates/{template_id}: | |
| put: | |
| tags: | |
| - estimates | |
| operationId: update_estimate_template | |
| summary: Update estimate template | |
| description: Update the pdf template associated with the estimate. | |
| parameters: | |
| - name: template_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the estimate template. | |
| schema: | |
| type: string | |
| example: 982000000000143 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-estimate-template-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.estimates.UPDATE | |
| parameters: | |
| - name: estimate_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the estimate. | |
| schema: | |
| type: string | |
| example: 982000000567011 | |
| - $ref: '#/components/parameters/organization_id' | |
| /expenses: | |
| post: | |
| tags: | |
| - expenses | |
| operationId: create_expense | |
| summary: Create an Expense | |
| description: Create billable or non-billable expense. | |
| parameters: | |
| - name: receipt | |
| in: query | |
| description: 'Expense receipt file to attach. Allowed Extensions: <code>gif</code>, | |
| <code>png</code>, <code>jpeg</code>, <code>jpg</code>, <code>bmp</code>, | |
| <code>pdf</code>, <code>xls</code>, <code>xlsx</code>, <code>doc</code> | |
| and <code>docx</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-an-expense-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-an-expense-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.CREATE | |
| get: | |
| tags: | |
| - expenses | |
| operationId: list_expenses | |
| summary: List Expenses | |
| description: List all the Expenses with pagination. | |
| parameters: | |
| - name: description | |
| in: query | |
| description: Search expenses by description.Variants <code>description_startswith</code> | |
| and <code>description_contains</code>. Max-length [100] | |
| required: false | |
| schema: | |
| type: string | |
| example: Marketing | |
| - name: reference_number | |
| in: query | |
| description: Search expenses by reference number. Variants <code>reference_number_startswith</code> | |
| and <code>reference_number_contains</code>. Max-length [100] | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: date | |
| in: query | |
| description: Search expenses by expense date. Variants <code>date_start</code>, | |
| <code>date_end</code>, <code>date_before</code> and <code>date_after</code>. | |
| Format [yyyy-mm-dd] | |
| required: false | |
| schema: | |
| type: string | |
| example: '2013-11-18T00:00:00+00:00' | |
| - name: status | |
| in: query | |
| description: Search expenses by expense status. Allowed Values <code>unbilled</code>, | |
| <code>invoiced</code>, <code>reimbursed</code>, <code>non-billable</code> | |
| and <code>billable</code> | |
| required: false | |
| schema: | |
| type: string | |
| example: unbilled | |
| - name: amount | |
| in: query | |
| description: 'Search expenses by amount. Variants: <code>amount_less_than</code>, | |
| <code>amount_less_equals</code>, <code>amount_greater_than</code> and <code>amount_greater_than</code>' | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| example: 112.5 | |
| - name: account_name | |
| in: query | |
| description: Search expenses by expense account name. Variants <code>account_name_startswith</code> | |
| and <code>account_name_contains</code>. Max-length [100] | |
| required: false | |
| schema: | |
| type: string | |
| example: Rent | |
| - name: customer_name | |
| in: query | |
| description: 'Search expenses by customer name. Variants: <code>customer_name_startswith</code> | |
| and <code>customer_name_contains</code>. Max-length [100]' | |
| required: false | |
| schema: | |
| type: string | |
| example: Bowman & Co | |
| - name: vendor_name | |
| in: query | |
| description: 'Search expenses by vendor name. Variants: <code>vendor_name_startswith</code> | |
| and <code>vendor_name_contains</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: customer_id | |
| in: query | |
| description: ID of the expense account. | |
| required: false | |
| schema: | |
| type: string | |
| example: 982000000567001 | |
| - name: vendor_id | |
| in: query | |
| description: ID of the vendor the expense is made. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: recurring_expense_id | |
| in: query | |
| description: Search expenses by recurring expense id. | |
| required: false | |
| schema: | |
| type: string | |
| example: 982000000000190 | |
| - name: paid_through_account_id | |
| in: query | |
| description: Search expenses by paid through account id. | |
| required: false | |
| schema: | |
| type: string | |
| example: 982000000567250 | |
| - name: search_text | |
| in: query | |
| description: Search expenses by account name or description or <code>customer | |
| name</code> or <code>vendor name</code>. Max-length [100] | |
| required: false | |
| schema: | |
| type: string | |
| example: Rent | |
| - name: sort_column | |
| in: query | |
| description: Sort expenses.Allowed Values <code>date</code>, <code>account_name</code>, | |
| <code>total</code>, <code>bcy_total</code>, <code>reference_number</code>, | |
| <code>customer_name</code> and <code>created_time</code> | |
| required: false | |
| schema: | |
| type: string | |
| example: total | |
| - name: filter_by | |
| in: query | |
| description: Filter expenses by expense status. Allowed Values <code>Status.All</code>, | |
| <code>Status.Billable</code>, <code>Status.Nonbillable</code>, <code>Status.Reimbursed</code>, | |
| <code>Status.Invoiced</code>and <code>Status.Unbilled</code> | |
| required: false | |
| schema: | |
| type: string | |
| example: Status.Billable | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-expenses-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.READ | |
| put: | |
| tags: | |
| - expenses | |
| operationId: update_expense_using_custom_field | |
| summary: Update an expense using a custom field's unique value | |
| description: A custom field will have unique values if it's configured to not | |
| accept duplicate values. Now, you can use that custom field's value to update | |
| a expense by providing its API name in the X-Unique-Identifier-Key header | |
| and its value in the X-Unique-Identifier-Value header. Based on this value, | |
| the corresponding bill expense be retrieved and updated. Additionally, there | |
| is an optional X-Upsert header. If the X-Upsert header is true and the custom | |
| field's unique value is not found in any of the existing expenses, a new expense | |
| will be created if the necessary payload details are available | |
| parameters: | |
| - name: X-Unique-Identifier-Key | |
| in: header | |
| description: Unique CustomField Api Name | |
| required: true | |
| schema: | |
| type: string | |
| example: cf_unique_cf | |
| - name: X-Unique-Identifier-Value | |
| in: header | |
| description: Unique CustomField Value | |
| required: true | |
| schema: | |
| type: string | |
| example: unique Value | |
| - name: X-Upsert | |
| in: header | |
| description: If there is no record is found unique custom field value , will | |
| create new invoice | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-expense-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-expense-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /expenses/{expense_id}: | |
| put: | |
| tags: | |
| - expenses | |
| operationId: update_expense | |
| summary: Update an Expense | |
| description: Update an existing Expense. | |
| parameters: | |
| - name: receipt | |
| in: query | |
| description: 'Expense receipt file to attach. Allowed Extensions: <code>gif</code>, | |
| <code>png</code>, <code>jpeg</code>, <code>jpg</code>, <code>bmp</code>, | |
| <code>pdf</code>, <code>xls</code>, <code>xlsx</code>, <code>doc</code> | |
| and <code>docx</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| - name: delete_receipt | |
| in: query | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-expense-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-expense-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.UPDATE | |
| get: | |
| tags: | |
| - expenses | |
| operationId: get_expense | |
| summary: Get an Expense | |
| description: Get the details of the Expense. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-an-expense-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.READ | |
| delete: | |
| tags: | |
| - expenses | |
| operationId: delete_expense | |
| summary: Delete an Expense | |
| description: Delete an existing expense. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-an-expense-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.DELETE | |
| parameters: | |
| - name: expense_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the expense. | |
| schema: | |
| type: string | |
| example: 982000000030049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /expenses/{expense_id}/attachment: | |
| post: | |
| tags: | |
| - expenses | |
| operationId: add_expense_attachment | |
| summary: Add attachment to an expense | |
| description: Attach one or multiple files to an expense. This endpoint allows | |
| you to attach various types of documents to support your expense records. | |
| Returns document details for the uploaded attachments. | |
| requestBody: | |
| content: | |
| multipart/form-data: | |
| schema: | |
| $ref: '#/components/schemas/add-attachment-to-an-expense-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-attachment-to-an-expense-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.CREATE | |
| parameters: | |
| - name: expense_id | |
| in: path | |
| required: true | |
| schema: | |
| type: string | |
| example: 982000000030049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /expenses/{expense_id}/comments: | |
| get: | |
| tags: | |
| - expenses | |
| operationId: list_expense_comments | |
| summary: List expense History & Comments | |
| description: Get history and comments of expense. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-expense-history-and-comments-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.READ | |
| parameters: | |
| - name: expense_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the expense. | |
| schema: | |
| type: string | |
| example: 982000000030049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /expenses/{expense_id}/receipt: | |
| get: | |
| tags: | |
| - expenses | |
| operationId: get_expense_receipt | |
| summary: Get an expense receipt | |
| description: Returns the receipt attached to the expense. | |
| parameters: | |
| - name: preview | |
| in: query | |
| description: Get the thumbnail of the receipt. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-an-expense-receipt-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.READ | |
| post: | |
| tags: | |
| - expenses | |
| operationId: create_expense_receipt | |
| summary: Add receipt to an expense. | |
| description: Attach a receipt to an expense. | |
| parameters: | |
| - name: receipt | |
| in: query | |
| description: 'Expense receipt file to attach. Allowed Extensions: <code>gif</code>, | |
| <code>png</code>, <code>jpeg</code>, <code>jpg</code>, <code>bmp</code>, | |
| <code>pdf</code>, <code>xls</code>, <code>xlsx</code>, <code>doc</code> | |
| and <code>docx</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-receipt-to-an-expense-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.CREATE | |
| delete: | |
| tags: | |
| - expenses | |
| operationId: delete_expense_receipt | |
| summary: Delete a receipt | |
| description: Delete the receipt attached to the expense. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-receipt-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.DELETE | |
| parameters: | |
| - name: expense_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the expense. | |
| schema: | |
| type: string | |
| example: 982000000030049 | |
| - $ref: '#/components/parameters/organization_id' | |
| /fixedassets: | |
| post: | |
| tags: | |
| - fixed-assets | |
| operationId: create_fixed_asset | |
| summary: Create a fixed asset | |
| description: Create a fixed asset. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-fixed-asset-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-fixed-asset-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fixedasset.CREATE | |
| get: | |
| tags: | |
| - fixed-assets | |
| operationId: list_fixed_assets | |
| summary: Get fixed asset list | |
| description: fixed asset list. | |
| parameters: | |
| - name: filter_by | |
| in: query | |
| description: 'Filter fixed asset by fixed asset status. Allowed Values: <code>Status.All</code>, | |
| <code>Status.Active</code>, <code>Status.Cancel</code>, <code>Status.FullyDepreciated</code>, | |
| <code>Status.WriteOff</code>, <code>Status.Sold</code> and <code>Status.Draft</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sort_column | |
| in: query | |
| description: 'Sort fixed asset list. Allowed Values: <code>asset_name</code>, | |
| <code>asset_number</code>, <code>asset_cost</code>, <code>created_time</code> | |
| and <code>current_asset_value</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: asset_number | |
| - name: sort_order | |
| in: query | |
| description: 'Sort fixed asset list in ascendeing or descending order. Allowed | |
| Values: <code>A</code> and <code>D</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: A | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-fixed-asset-list-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fixedasset.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /fixedassets/{fixed_asset_id}: | |
| put: | |
| tags: | |
| - fixed-assets | |
| operationId: update_fixed_asset | |
| summary: Update a fixed asset | |
| description: Updates the fixed asset with given information. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-fixed-asset-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-fixed-asset-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fixedasset.UPDATE | |
| get: | |
| tags: | |
| - fixed-assets | |
| operationId: get_fixed_asset | |
| summary: Get fixed asset | |
| description: Get the details of the fixed asset. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-fixed-asset-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fixedasset.READ | |
| delete: | |
| tags: | |
| - fixed-assets | |
| operationId: delete_fixed_asset | |
| summary: Delete a fixed asset | |
| description: Deletes the given fixed asset. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-fixed-asset-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fixedasset.DELETE | |
| parameters: | |
| - name: fixed_asset_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the fixed asset. | |
| schema: | |
| type: string | |
| example: '3640355000000319008' | |
| - $ref: '#/components/parameters/organization_id' | |
| /fixedassets/{fixed_asset_id}/comments: | |
| post: | |
| tags: | |
| - fixed-assets | |
| operationId: create_fixed_asset_comment | |
| summary: Add a comment | |
| description: Add a comment to the fixed asset. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-comment-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fixedasset.CREATE | |
| parameters: | |
| - name: fixed_asset_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the fixed asset. | |
| schema: | |
| type: string | |
| example: '3640355000000319008' | |
| - $ref: '#/components/parameters/organization_id' | |
| /fixedassets/{fixed_asset_id}/comments/{comment_id}: | |
| delete: | |
| tags: | |
| - fixed-assets | |
| operationId: delete_fixed_asset_comment | |
| summary: Delete a comment | |
| description: Delete the comment of the fixed asset. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fixedasset.DELETE | |
| parameters: | |
| - name: fixed_asset_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the fixed asset. | |
| schema: | |
| type: string | |
| example: '3640355000000319008' | |
| - name: comment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the comment. | |
| schema: | |
| type: string | |
| example: '3640355000000319013' | |
| - $ref: '#/components/parameters/organization_id' | |
| /fixedassets/{fixed_asset_id}/forecast: | |
| get: | |
| tags: | |
| - fixed-assets | |
| operationId: get_fixed_asset_forecast | |
| summary: Get fixed asset's forecast depreciation | |
| description: It displays a detailed summary of the asset's future depreciation | |
| rates. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-fixed-asset-forecast-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fixedasset.READ | |
| parameters: | |
| - name: fixed_asset_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the fixed asset. | |
| schema: | |
| type: string | |
| example: '3640355000000319008' | |
| - $ref: '#/components/parameters/organization_id' | |
| /fixedassets/{fixed_asset_id}/history: | |
| get: | |
| tags: | |
| - fixed-assets | |
| operationId: get_fixed_asset_history | |
| summary: Get fixed asset history | |
| description: It displays a detailed summary of the asset from acquisition till | |
| write off. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-fixed-asset-history-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fixedasset.READ | |
| parameters: | |
| - name: fixed_asset_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the fixed asset. | |
| schema: | |
| type: string | |
| example: '3640355000000319008' | |
| - $ref: '#/components/parameters/organization_id' | |
| /fixedassets/{fixed_asset_id}/sell: | |
| post: | |
| tags: | |
| - fixed-assets | |
| operationId: sell_fixed_asset | |
| summary: Sell fixed asset | |
| description: Sell the fixed asset. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/sell-fixed-asset-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/sell-fixed-asset-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fixedasset.CREATE | |
| parameters: | |
| - name: fixed_asset_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the fixed asset. | |
| schema: | |
| type: string | |
| example: '3640355000000319008' | |
| - $ref: '#/components/parameters/organization_id' | |
| /fixedassets/{fixed_asset_id}/status/active: | |
| post: | |
| tags: | |
| - fixed-assets | |
| operationId: mark_fixed_asset_active | |
| summary: Mark fixed asset as active | |
| description: Mark the fixed asset as active to start calculating depreciation | |
| for the asset. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-fixed-asset-status' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fixedasset.CREATE | |
| parameters: | |
| - name: fixed_asset_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the fixed asset. | |
| schema: | |
| type: string | |
| example: '3640355000000319008' | |
| - $ref: '#/components/parameters/organization_id' | |
| /fixedassets/{fixed_asset_id}/status/cancel: | |
| post: | |
| tags: | |
| - fixed-assets | |
| operationId: mark_fixed_asset_cancel | |
| summary: Cancel fixed asset | |
| description: Cancel the fixed asset. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-fixed-asset-status' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fixedasset.CREATE | |
| parameters: | |
| - name: fixed_asset_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the fixed asset. | |
| schema: | |
| type: string | |
| example: '3640355000000319008' | |
| - $ref: '#/components/parameters/organization_id' | |
| /fixedassets/{fixed_asset_id}/status/draft: | |
| post: | |
| tags: | |
| - fixed-assets | |
| operationId: mark_fixed_asset_draft | |
| summary: Mark fixed asset as draft | |
| description: Mark the fixed asset as draft. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-fixed-asset-status' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fixedasset.CREATE | |
| parameters: | |
| - name: fixed_asset_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the fixed asset. | |
| schema: | |
| type: string | |
| example: '3640355000000319008' | |
| - $ref: '#/components/parameters/organization_id' | |
| /fixedassets/{fixed_asset_id}/writeoff: | |
| post: | |
| tags: | |
| - fixed-assets | |
| operationId: write_off_fixed_asset | |
| summary: Write off fixed asset | |
| description: Write off the fixed asset. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/write-off-fixed-asset-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/write-off-fixed-asset-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fixedasset.CREATE | |
| parameters: | |
| - name: fixed_asset_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the fixed asset. | |
| schema: | |
| type: string | |
| example: '3640355000000319008' | |
| - $ref: '#/components/parameters/organization_id' | |
| /fixedassettypes: | |
| post: | |
| tags: | |
| - fixed-assets | |
| operationId: create_fixed_asset_type | |
| summary: Create a fixed asset type | |
| description: Create a fixed asset type. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-fixed-asset-type-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-fixed-asset-type-response' | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fixedasset.CREATE | |
| get: | |
| tags: | |
| - fixed-assets | |
| operationId: get_fixed_asset_type_list | |
| summary: Get fixed asset type list | |
| description: fixed asset type list. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-fixed-asset-type-list-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fixedasset.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /fixedassettypes/{fixed_asset_type_id}: | |
| put: | |
| tags: | |
| - fixed-assets | |
| operationId: update_fixed_asset_type | |
| summary: Update a fixed asset type | |
| description: Updates the fixed asset type with given information. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-fixed-asset-type-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-fixed-asset-type-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fixedasset.UPDATE | |
| delete: | |
| tags: | |
| - fixed-assets | |
| operationId: delete_fixed_asset_type | |
| summary: Delete a fixed asset type | |
| description: Deletes the given fixed asset type. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-fixed-asset-type-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.fixedasset.DELETE | |
| parameters: | |
| - name: fixed_asset_type_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the fixed asset type. | |
| schema: | |
| type: string | |
| example: '3640355000000319008' | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoice/{invoice_id}/customfields: | |
| put: | |
| tags: | |
| - invoices | |
| operationId: update_custom_fields_in_invoice | |
| summary: Update custom field in existing invoices | |
| description: Update the value of the custom field in existing invoices. | |
| parameters: | |
| - $ref: '#/components/parameters/invoice_id' | |
| - $ref: '#/components/parameters/organization_id' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/custom_fields' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-invoice-customfield-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| /invoices: | |
| post: | |
| tags: | |
| - invoices | |
| operationId: create_invoice | |
| summary: Create an invoice | |
| description: Create an invoice for your customer. | |
| parameters: | |
| - name: send | |
| in: query | |
| description: Send the invoice to the contact person(s) associated with the | |
| invoice. Allowed values <code>true</code> and <code>false</code>. | |
| required: false | |
| schema: | |
| type: boolean | |
| - name: ignore_auto_number_generation | |
| in: query | |
| description: Ignore auto invoice number generation for this invoice. This | |
| mandates the invoice number. Allowed values <code>true</code> and <code>false</code> | |
| required: false | |
| schema: | |
| type: boolean | |
| - name: is_quick_create | |
| in: query | |
| description: Enable quick create mode for simplified invoice creation. When | |
| true, the invoice creation process is streamlined with minimal required | |
| fields. Allowed values <code>true</code> and <code>false</code> | |
| required: false | |
| schema: | |
| type: boolean | |
| - name: batch_payments | |
| in: query | |
| description: 'Enable batch payment processing for the invoice. When true, | |
| the invoice can be included in batch payment operations. Allowed values | |
| <code>true</code> and <code>false</code> <br> Note : <code>is_quick_create</code> | |
| needs to be true for batch payments to be processed and batch_payments vales | |
| need to pass in request body' | |
| required: false | |
| schema: | |
| type: boolean | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-an-invoice-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-an-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| get: | |
| tags: | |
| - invoices | |
| operationId: list_invoices | |
| summary: List invoices | |
| description: Get a list of invoices with helpful pagination, filtering, search, | |
| and sorting features. Perfect for viewing your invoice data in organized ways, | |
| whether you need to find specific invoices or browse through your records. | |
| parameters: | |
| - name: invoice_number | |
| in: query | |
| description: Search invoices by invoice number. Filters invoices based on | |
| their unique identifier. Supports <code>invoice_number_startswith</code> | |
| and <code>invoice_number_contains</code> variants. Maximum length is 100 | |
| characters. Useful for finding specific invoices or invoices with similar | |
| numbering patterns. | |
| required: false | |
| schema: | |
| type: string | |
| example: INV-00003 | |
| - name: item_name | |
| in: query | |
| description: Search invoices by item name. Filters invoices based on product | |
| or service names in invoice line items. Supports <code>item_name_startswith</code> | |
| and <code>item_name_contains</code> variants. Maximum length is 100 characters. | |
| Useful for finding invoices with specific products or services. | |
| required: false | |
| schema: | |
| type: string | |
| example: Desktop Units | |
| - name: item_id | |
| in: query | |
| description: Search invoices by item ID. Filters invoices based on the unique | |
| identifier of specific products or services in line items. Use the GET `/items` | |
| API to find available item IDs. Useful for finding all invoices containing | |
| a specific product or service. | |
| required: false | |
| schema: | |
| type: string | |
| example: 982000000030049 | |
| - name: item_description | |
| in: query | |
| description: Search invoices by item description. Filters invoices based on | |
| detailed descriptions of products or services in line items. Supports <code>item_description_startswith</code> | |
| and <code>item_description_contains</code> variants. Maximum length is 100 | |
| characters. Useful for finding invoices with specific item descriptions | |
| or technical specifications. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: reference_number | |
| in: query | |
| description: Search invoices by reference number. Filters invoices based on | |
| external reference identifiers like purchase order numbers, contract numbers, | |
| or project codes. Useful for finding invoices associated with specific projects | |
| or business transactions. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: customer_name | |
| in: query | |
| description: Search invoices by customer name. Filters invoices based on the | |
| business or individual name associated with the invoice. Maximum length | |
| is 100 characters. Useful for finding all invoices for a specific customer | |
| or generating customer reports. | |
| required: false | |
| schema: | |
| type: string | |
| example: Bowman & Co | |
| - name: recurring_invoice_id | |
| in: query | |
| description: ID of the recurring invoice from which the invoice is created. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: email | |
| in: query | |
| description: Search invoices by customer email address. Filters invoices based | |
| on the email address of the customer or contact person. Maximum length is | |
| 100 characters. Useful for finding invoices for specific customers or generating | |
| customer segment reports. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: total | |
| in: query | |
| description: Search invoices by total amount. Filters invoices based on the | |
| final invoice amount including taxes, discounts, and adjustments. Useful | |
| for finding invoices within specific price ranges or identifying high-value | |
| transactions. | |
| required: false | |
| schema: | |
| type: string | |
| example: 40.6 | |
| - name: balance | |
| in: query | |
| description: Search invoices by outstanding balance. Filters invoices based | |
| on the remaining unpaid amount owed by the customer. Useful for finding | |
| overdue invoices, tracking receivables, or generating aging reports. | |
| required: false | |
| schema: | |
| type: string | |
| example: 40.6 | |
| - name: custom_field | |
| in: query | |
| description: 'Search invoices by custom fields.Variants: <code>custom_field_startswith</code> | |
| and <code>custom_field_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: date | |
| in: query | |
| description: 'Search invoices by invoice date. Filters invoices based on the | |
| date they were created. Use yyyy-mm-dd format. Supports variants: <code>date_start</code>, | |
| <code>date_end</code>, <code>date_before</code> and <code>date_after</code>. | |
| Useful for finding invoices within date ranges or specific time periods.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '2013-11-17' | |
| - name: due_date | |
| in: query | |
| description: 'Search invoices by due date. Filters invoices based on the payment | |
| due date. Use yyyy-mm-dd format. Supports variants: <code>due_date_start</code>, | |
| <code>due_date_end</code>, <code>due_date_before</code> and <code>due_date_after</code>. | |
| Useful for finding overdue invoices or invoices due within specific periods.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '2013-12-03' | |
| - name: created_date | |
| in: query | |
| description: 'Search invoices by creation date. Filters invoices based on | |
| the date they were created. Use yyyy-mm-dd format. Supports variants: <code>created_date_start</code>, | |
| <code>created_date_end</code>, <code>created_date_before</code> and <code>created_date_after</code>. | |
| Useful for finding invoices created within specific time periods or date | |
| ranges.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '2013-11-17' | |
| - name: last_modified_time | |
| in: query | |
| required: false | |
| description: 'Search invoices modified after a specific time. Filters invoices | |
| based on their last modification timestamp. Use YYYY-MM-DDTHH:MM:SS-UTC | |
| format. Useful for finding recently updated invoices or syncing data changes. | |
| Example : 2023-11-18T02:02:51-0800, 2025-19-19T02:02:51%2B0800' | |
| schema: | |
| type: string | |
| example: 2013-11-18T02:02:51-0800 | |
| - name: status | |
| in: query | |
| description: 'Search invoices by status. Filters invoices based on their current | |
| state in the billing workflow. Allowed values: <code>sent</code>, <code>draft</code>, | |
| <code>overdue</code>, <code>paid</code>, <code>void</code>, <code>unpaid</code>, | |
| <code>partially_paid</code> and <code>viewed</code>. Useful for finding | |
| invoices in specific stages of the billing process.' | |
| required: false | |
| schema: | |
| type: string | |
| example: draft | |
| - name: customer_id | |
| in: query | |
| description: Search invoices by customer ID. Filters invoices based on the | |
| unique identifier of the customer for whom the invoice was created. Use | |
| the customer ID returned by the Contacts API to find all invoices for a | |
| specific customer. | |
| required: false | |
| schema: | |
| type: string | |
| example: 982000000567001 | |
| - name: filter_by | |
| in: query | |
| description: Filter invoices by status or payment expected date. Use <code>Status.*</code> | |
| for status-based filtering (e.g., Status.Sent, Status.Paid) or <code>Date.PaymentExpectedDate</code> | |
| for date-based filtering. Provides advanced filtering options beyond basic | |
| search parameters. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: search_text | |
| in: query | |
| description: Search invoices by invoice number, purchase order, or customer | |
| name. This parameter performs a general search across multiple invoice fields. | |
| Maximum length is 100 characters. Useful for quick searches when you know | |
| part of the invoice information but are unsure which specific field to search. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sort_column | |
| in: query | |
| description: 'Sort invoices by specific column. Allowed values: <code>customer_name</code>, | |
| <code>invoice_number</code>, <code>date</code>, <code>due_date</code>, <code>total</code>, | |
| <code>balance</code> and <code>created_time</code>. Use this parameter to | |
| organize invoice results in a specific order for better data analysis and | |
| reporting.' | |
| required: false | |
| schema: | |
| type: string | |
| example: created_time | |
| - name: zcrm_potential_id | |
| in: query | |
| description: Search invoices by CRM potential ID. This parameter allows you | |
| to find invoices associated with a specific deal or opportunity in your | |
| Zoho CRM system. Use the potential ID from your CRM to link invoices to | |
| sales opportunities and track revenue from specific deals. | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| example: 460000000026049 | |
| - name: response_option | |
| in: query | |
| description: 'To get desired response format. There are 5 formats of responses: | |
| 0 (Includes all invoices), 1 (Includes all invoices, the number of invoices, | |
| and the sum of their total and balance amounts), 2 (Includes only the number | |
| of invoices), 3 (Includes the number of invoices and the sum of their total | |
| and balance amounts), and 4 (Includes all invoices and the sum of their | |
| total and balance amounts).' | |
| required: false | |
| schema: | |
| type: integer | |
| example: 2 | |
| - name: page | |
| in: query | |
| description: Page number to be fetched from the paginated results. Default | |
| value is 1. Use this parameter along with per_page to navigate through large | |
| sets of invoice data. Useful for implementing pagination in your application. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| Use this parameter to control the size of each page of results. Maximum | |
| value is 200. Useful for optimizing data transfer and improving application | |
| performance. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-invoices-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| put: | |
| tags: | |
| - invoices | |
| operationId: update_invoice_using_custom_field | |
| summary: Update an invoice using a custom field's unique value | |
| description: A custom field will have unique values if it's configured to not | |
| accept duplicate values. Now, you can use that custom field's value to update | |
| an invoice by providing its API name in the X-Unique-Identifier-Key header | |
| and its value in the X-Unique-Identifier-Value header. Based on this value, | |
| the corresponding invoice will be retrieved and updated. Additionally, there | |
| is an optional X-Upsert header. If the X-Upsert header is true and the custom | |
| field's unique value is not found in any of the existing invoices, a new invoice | |
| will be created if the necessary payload details are available | |
| parameters: | |
| - name: X-Unique-Identifier-Key | |
| in: header | |
| description: Unique CustomField Api Name | |
| required: true | |
| schema: | |
| type: string | |
| example: cf_unique_cf | |
| - name: X-Unique-Identifier-Value | |
| in: header | |
| description: Unique CustomField Value | |
| required: true | |
| schema: | |
| type: string | |
| example: unique Value | |
| - name: X-Upsert | |
| in: header | |
| description: If there is no record is found unique custom field value , will | |
| create new invoice | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-invoice-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| /invoices/email: | |
| post: | |
| tags: | |
| - invoices | |
| operationId: email_invoices | |
| summary: Email multiple invoices | |
| description: Send invoices to your customers by email. Maximum of 10 invoices | |
| can be sent at once. | |
| parameters: | |
| - name: invoice_ids | |
| in: query | |
| description: Comma separated invoice ids which are to be emailed. | |
| required: true | |
| schema: | |
| type: string | |
| example: '' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-invoices-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-invoices-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/expenses/{expense_id}/receipt: | |
| delete: | |
| tags: | |
| - invoices | |
| operationId: delete_invoice_expense_receipt | |
| summary: Delete the expense receipt | |
| description: Delete the expense receipts attached to an invoice which is raised | |
| from an expense. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-the-expense-receipt-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.DELETE | |
| parameters: | |
| - name: expense_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the expense. | |
| schema: | |
| type: string | |
| example: '460000000028080' | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/fromsalesorder: | |
| post: | |
| tags: | |
| - invoices | |
| operationId: create_invoice_from_salesorder | |
| summary: Create an instant invoice | |
| description: ' Create an instant invoice for all the confirmed sales orders | |
| you have selected.' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-an-instant-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: salesorder_id | |
| in: query | |
| required: true | |
| schema: | |
| type: string | |
| example: 2000000014088 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/mapwithorder: | |
| post: | |
| tags: | |
| - invoices | |
| operationId: map_invoice_with_salesorder | |
| summary: Associate invoices with sales order | |
| description: Associate one or more existing invoices with a sales orders. | |
| parameters: | |
| - name: invoice_ids | |
| in: query | |
| description: Array of invoice IDs to be associated with a sales order. | |
| required: true | |
| schema: | |
| type: string | |
| example: 982000000567114,982000000567115,982000000567116 | |
| - $ref: '#/components/parameters/organization_id' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/map-invoice-with-salesorder-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| /invoices/paymentreminder: | |
| post: | |
| tags: | |
| - invoices | |
| operationId: bulk_invoice_reminder | |
| summary: Bulk invoice reminder | |
| description: Remind your customer about an unpaid invoices by email. Reminder | |
| mail will be send, only for the invoices is in open or overdue status. Maximum | |
| 10 invoices can be reminded at once. | |
| parameters: | |
| - name: invoice_ids | |
| in: query | |
| description: Array of invoice ids for which the reminder has to be sent. | |
| required: true | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/bulk-invoice-reminder-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/pdf: | |
| get: | |
| tags: | |
| - invoices | |
| operationId: bulk_export_invoices_as_pdf | |
| summary: Bulk export Invoices | |
| description: Maximum of 25 invoices can be exported in a single pdf. | |
| parameters: | |
| - name: invoice_ids | |
| in: query | |
| description: Comma separated invoice ids which are to be export as pdf. | |
| required: true | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/bulk-export-invoices-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/print: | |
| get: | |
| tags: | |
| - invoices | |
| operationId: bulk_print_invoices | |
| summary: Bulk print invoices | |
| description: Export invoices as pdf and print them. Maximum of 25 invoices can | |
| be printed. | |
| parameters: | |
| - name: invoice_ids | |
| in: query | |
| description: Export invoices as pdf and print them. Maximum of 25 invoices | |
| can be printed. | |
| required: true | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/bulk-print-invoices-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/templates: | |
| get: | |
| tags: | |
| - invoices | |
| operationId: list_invoice_templates | |
| summary: List invoice templates | |
| description: Get all invoice pdf templates. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-invoice-templates-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{debit_note_id}: | |
| parameters: | |
| - $ref: '#/components/parameters/invoice_id' | |
| - $ref: '#/components/parameters/organization_id' | |
| put: | |
| tags: | |
| - customer-debit-notes | |
| operationId: update_customer_debit_note | |
| summary: Update a customer debit note | |
| description: Update an existing customer debit note. To delete a line item just | |
| remove it from the line_items list. | |
| parameters: | |
| - name: ignore_auto_number_generation | |
| in: query | |
| description: Ignore auto debit note number generation for this debit note. | |
| This mandates the debit note number. Allowed values <code>true</code> and | |
| <code>false</code> | |
| required: false | |
| schema: | |
| type: boolean | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-customer-debit-note-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-customer-debit-note-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| get: | |
| tags: | |
| - customer-debit-notes | |
| operationId: get_customer_debit_note | |
| summary: Get a customer debit note | |
| description: Get the details of a customer debit note. | |
| parameters: | |
| - name: print | |
| in: query | |
| description: Print the exported pdf. | |
| required: false | |
| schema: | |
| type: boolean | |
| - name: accept | |
| in: query | |
| description: Get the details of a particular debit note in formats such as | |
| json/ pdf/ html. Default format is json. Allowed values <code>json</code> | |
| <code>pdf</code> and <code>html</code> | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-customer-debit-note-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| delete: | |
| tags: | |
| - customer-debit-notes | |
| operationId: delete_customer_debit_note | |
| summary: Delete a customer debit note | |
| description: Delete an existing customer debit note. Debit notes which have | |
| payment or credits note applied cannot be deleted. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-customer-debit-note-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.DELETE | |
| /invoices/{invoice_id}: | |
| parameters: | |
| - $ref: '#/components/parameters/invoice_id' | |
| - $ref: '#/components/parameters/organization_id' | |
| put: | |
| tags: | |
| - invoices | |
| operationId: update_invoice | |
| summary: Update an invoice | |
| description: Update an existing invoice. To delete a line item just remove it | |
| from the line_items list. | |
| parameters: | |
| - name: ignore_auto_number_generation | |
| in: query | |
| description: Ignore auto invoice number generation for this invoice. This | |
| mandates the invoice number. Allowed values <code>true</code> and <code>false</code> | |
| required: false | |
| schema: | |
| type: boolean | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-invoice-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| get: | |
| tags: | |
| - invoices | |
| operationId: get_invoice | |
| summary: Get an invoice | |
| description: Get the details of an invoice. | |
| parameters: | |
| - name: print | |
| in: query | |
| description: Print the exported pdf. | |
| required: false | |
| schema: | |
| type: boolean | |
| - name: accept | |
| in: query | |
| description: Get the details of a particular invoice in formats such as json/ | |
| pdf/ html. Default format is json. Allowed values <code>json</code> <code>pdf</code> | |
| and <code>html</code> | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-an-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| delete: | |
| tags: | |
| - invoices | |
| operationId: delete_invoice | |
| summary: Delete an invoice | |
| description: Delete an existing invoice. Invoices which have payment or credits | |
| note applied cannot be deleted. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-an-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.DELETE | |
| /invoices/{invoice_id}/address/billing: | |
| put: | |
| tags: | |
| - invoices | |
| operationId: update_invoice_billing_address | |
| summary: Update billing address | |
| description: Updates the billing address for this invoice alone. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-billing-address-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-billing-address-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the invoice. | |
| schema: | |
| type: string | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/address/shipping: | |
| put: | |
| tags: | |
| - invoices | |
| operationId: update_invoice_shipping_address | |
| summary: Update shipping address | |
| description: Updates the shipping address for this invoice alone. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-shipping-address-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-shipping-address-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the invoice. | |
| schema: | |
| type: string | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/approve: | |
| post: | |
| tags: | |
| - invoices | |
| operationId: approve_invoice | |
| summary: Approve an invoice. | |
| description: Approve an invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/approve-an-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the invoice. | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/attachment: | |
| get: | |
| tags: | |
| - invoices | |
| operationId: get_invoice_attachment | |
| summary: Get last attached attachment | |
| description: Returns the file attached to the invoice. | |
| parameters: | |
| - name: preview | |
| in: query | |
| description: Get the thumbnail of the attachment. | |
| required: false | |
| schema: | |
| type: boolean | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-an-invoice-attachment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| post: | |
| tags: | |
| - invoices | |
| operationId: add_invoice_attachment | |
| summary: Add attachment to an invoice | |
| description: Attach a file to an invoice. | |
| parameters: | |
| - name: can_send_in_mail | |
| in: query | |
| description: True to send the attachment with the invoice when emailed. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| - name: attachment | |
| in: query | |
| description: 'The file to be attached.Allowed Extensions: <code>gif</code>, | |
| <code>png</code>, <code>jpeg</code>, <code>jpg</code>, <code>bmp</code> | |
| and <code>pdf</code>' | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-attachment-to-an-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| put: | |
| tags: | |
| - invoices | |
| operationId: update_invoice_attachment_preference | |
| summary: Update attachment preference | |
| description: Set whether you want to send the attached file while emailing the | |
| invoice. | |
| parameters: | |
| - name: can_send_in_mail | |
| in: query | |
| description: Boolean to send the attachment with the invoice when emailed. | |
| required: true | |
| schema: | |
| type: boolean | |
| example: true | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-attachment-preference-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| delete: | |
| tags: | |
| - invoices | |
| operationId: delete_invoice_attachment | |
| summary: Delete last attached attachment | |
| description: Delete the file attached to the invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-an-attachment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.DELETE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the invoice. | |
| schema: | |
| type: string | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/comments: | |
| get: | |
| tags: | |
| - invoices | |
| operationId: list_invoice_comments | |
| summary: List invoice comments & history | |
| description: Get the complete history and comments of an invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-invoice-comments-and-history-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| post: | |
| tags: | |
| - invoices | |
| operationId: add_invoice_comment | |
| summary: Add comment | |
| description: Add a comment for an invoice. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-comment-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the invoice. | |
| schema: | |
| type: string | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/comments/{comment_id}: | |
| put: | |
| tags: | |
| - invoices | |
| operationId: update_invoice_comment | |
| summary: Update comment | |
| description: Update an existing comment of an invoice. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-comment-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| delete: | |
| tags: | |
| - invoices | |
| operationId: delete_invoice_comment | |
| summary: Delete a comment | |
| description: Delete an invoice comment. | |
| parameters: | |
| - name: comment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the comment. | |
| schema: | |
| type: string | |
| example: 982000000567019 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.DELETE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the invoice. | |
| schema: | |
| type: string | |
| example: 982000000567114 | |
| - name: comment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the comment. | |
| schema: | |
| type: string | |
| example: 982000000567019 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/credits: | |
| post: | |
| tags: | |
| - invoices | |
| operationId: apply_credits_to_invoice | |
| summary: Apply credits | |
| description: Apply the customer credits either from credit notes or excess customer | |
| payments to an invoice. Multiple credits can be applied at once. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/apply-credits-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/apply-credits-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the invoice. | |
| schema: | |
| type: string | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/creditsapplied: | |
| get: | |
| tags: | |
| - invoices | |
| operationId: list_invoice_credits_applied | |
| summary: List credits applied | |
| description: Get the list of credits applied for an invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-credits-applied-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the invoice. | |
| schema: | |
| type: string | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/creditsapplied/{creditnotes_invoice_id}: | |
| delete: | |
| tags: | |
| - invoices | |
| operationId: delete_invoice_applied_credit | |
| summary: Delete applied credit | |
| description: Delete a particular credit applied to an invoice. | |
| parameters: | |
| - name: creditnotes_invoice_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the credit note invoice. | |
| schema: | |
| type: string | |
| example: '982000000567172' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-applied-credit-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.DELETE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the invoice. | |
| schema: | |
| type: string | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/documents/{document_id}: | |
| get: | |
| tags: | |
| - invoices | |
| operationId: get_invoice_document_details | |
| summary: Retrieve Invoice Document | |
| description: Retrieve a specific document attached to an invoice with advanced | |
| retrieval options. | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| required: true | |
| schema: | |
| type: string | |
| - name: document_id | |
| in: path | |
| required: true | |
| schema: | |
| type: string | |
| - name: responseformat | |
| in: query | |
| description: Specify the response format (e.g., json, pdf, html) | |
| required: false | |
| schema: | |
| type: string | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-invoice-document-response' | |
| application/pdf: | |
| schema: | |
| type: string | |
| format: binary | |
| image/jpeg: | |
| schema: | |
| type: string | |
| format: binary | |
| image/png: | |
| schema: | |
| type: string | |
| format: binary | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| delete: | |
| tags: | |
| - invoices | |
| operationId: delete_invoice_document | |
| summary: Delete Invoice attachment | |
| description: Delete a specific document attached to an invoice. This operation | |
| permanently removes the document from the invoice and cannot be undone. Only | |
| documents that are not system-generated can be deleted. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-invoice-document-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.DELETE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| required: true | |
| schema: | |
| type: string | |
| example: 982000000567114 | |
| - name: document_id | |
| in: path | |
| required: true | |
| schema: | |
| type: string | |
| example: 982000000567200 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/email: | |
| get: | |
| tags: | |
| - invoices | |
| operationId: get_invoice_email | |
| summary: Get invoice email content | |
| description: Get the email content of an invoice. | |
| parameters: | |
| - name: email_template_id | |
| in: query | |
| description: Get the email content based on a specific email template. If | |
| this param is not inputted, then the content will be based on the email | |
| template associated with the customer. If no template is associated with | |
| the customer, then default template will be used. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-invoice-email-content-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| post: | |
| tags: | |
| - invoices | |
| operationId: email_invoice | |
| summary: Email an invoice | |
| description: Email an invoice to the customer. Input json string is not mandatory. | |
| If input json string is empty, mail will be send with default mail content. | |
| parameters: | |
| - name: send_customer_statement | |
| in: query | |
| description: Send customer statement pdf a with email. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: ' ' | |
| - name: send_attachment | |
| in: query | |
| description: Send the invoice attachment a with the email. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: ' ' | |
| - name: attachments | |
| in: query | |
| description: Files to be attached to the email | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-an-invoice-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-an-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the invoice. | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/paymentreminder: | |
| post: | |
| tags: | |
| - invoices | |
| operationId: remind_customer_for_invoice_payment | |
| summary: Remind Customer | |
| description: Remind your customer about an unpaid invoice by email. Reminder | |
| will be sent, only for the invoices which are in open or overdue status. | |
| parameters: | |
| - name: send_customer_statement | |
| in: query | |
| description: Send customer statement pdf a with email. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: ' ' | |
| - name: attachments | |
| in: query | |
| description: Files to be attached to the email | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/remind-customer-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/remind-customer-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| get: | |
| tags: | |
| - invoices | |
| operationId: get_payment_reminder_mail_content_for_invoice | |
| summary: Get payment reminder mail content | |
| description: Get the mail content of the payment reminder. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-payment-reminder-mail-content-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the invoice. | |
| schema: | |
| type: string | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/paymentreminder/disable: | |
| post: | |
| tags: | |
| - invoices | |
| operationId: disable_invoice_payment_reminder | |
| summary: Disable payment reminder | |
| description: Disable automated payment reminders for an invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/disable-payment-reminder-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the invoice. | |
| schema: | |
| type: string | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/paymentreminder/enable: | |
| post: | |
| tags: | |
| - invoices | |
| operationId: enable_invoice_payment_reminder | |
| summary: Enable payment reminder | |
| description: Enable automated payment reminders for an invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/enable-payment-reminder-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the invoice. | |
| schema: | |
| type: string | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/payments: | |
| get: | |
| tags: | |
| - invoices | |
| operationId: list_invoice_payments | |
| summary: List invoice payments | |
| description: Get the list of payments made for an invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-invoice-payments-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the invoice. | |
| schema: | |
| type: string | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/payments/{invoice_payment_id}: | |
| delete: | |
| tags: | |
| - invoices | |
| operationId: delete_invoice_payment | |
| summary: Delete a payment | |
| description: Delete a payment made to an invoice. | |
| parameters: | |
| - name: invoice_payment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the invoice payment. | |
| schema: | |
| type: string | |
| example: 982000000567192 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.DELETE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the invoice. | |
| schema: | |
| type: string | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/status/draft: | |
| post: | |
| tags: | |
| - invoices | |
| operationId: mark_invoice_draft | |
| summary: Mark as draft | |
| description: Mark a voided invoice as draft. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-as-draft-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the invoice. | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/status/sent: | |
| post: | |
| tags: | |
| - invoices | |
| operationId: mark_invoice_sent | |
| summary: Mark an invoice as sent | |
| description: Mark a draft invoice as sent. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-an-invoice-as-sent-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the invoice. | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/status/void: | |
| post: | |
| tags: | |
| - invoices | |
| operationId: mark_invoice_void | |
| summary: Void an invoice | |
| description: Mark an invoice status as void. Upon voiding, the payments and | |
| credits associated with the invoices will be unassociated and will be under | |
| customer credits. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/void-an-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the invoice. | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/submit: | |
| post: | |
| tags: | |
| - invoices | |
| operationId: submit_invoice | |
| summary: Submit an invoice for approval | |
| description: Submit an invoice for approval. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/submit-an-invoice-for-approval-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the invoice. | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/templates/{template_id}: | |
| put: | |
| tags: | |
| - invoices | |
| operationId: update_invoice_template | |
| summary: Update invoice template | |
| description: Update the pdf template associated with the invoice. | |
| parameters: | |
| - name: template_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the invoice template. | |
| schema: | |
| type: string | |
| example: 982000000000143 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-invoice-template-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the invoice. | |
| schema: | |
| type: string | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/writeoff: | |
| post: | |
| tags: | |
| - invoices | |
| operationId: write_off_invoice | |
| summary: Write off invoice | |
| description: Write off the invoice balance amount of an invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/write-off-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the invoice. | |
| schema: | |
| type: string | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /invoices/{invoice_id}/writeoff/cancel: | |
| post: | |
| tags: | |
| - invoices | |
| operationId: cancel_write_off_invoice | |
| summary: Cancel write off | |
| description: Cancel the write off amount of an invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/cancel-write-off-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: invoice_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the invoice. | |
| schema: | |
| type: string | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /item/{item_id}/customfields: | |
| put: | |
| tags: | |
| - items | |
| operationId: update_custom_fields_in_item | |
| summary: Update custom field in existing items | |
| description: Update the value of the custom field in existing items. | |
| parameters: | |
| - name: item_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the item. | |
| schema: | |
| type: string | |
| example: 45667789900 | |
| - $ref: '#/components/parameters/organization_id' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/custom_fields' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-item-customfield-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| /itemdetails: | |
| get: | |
| tags: | |
| - items | |
| operationId: list_item_details | |
| summary: Bulk fetch item details | |
| description: Fetch item details for the mentioned item IDs | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/bulk-fetch-item-details-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| parameters: | |
| - name: item_ids | |
| in: query | |
| required: true | |
| description: <code>List of item ids separated by comma</code> | |
| schema: | |
| type: string | |
| example: 4815000000044208,4815000000044274,4815000000044340 | |
| - $ref: '#/components/parameters/organization_id' | |
| /items: | |
| post: | |
| tags: | |
| - items | |
| operationId: create_item | |
| summary: Create an Item | |
| description: Create a new item. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-an-item-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-an-item-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| get: | |
| tags: | |
| - items | |
| operationId: list_items | |
| summary: List items | |
| description: Get the list of all active items with pagination. | |
| parameters: | |
| - name: name | |
| in: query | |
| description: 'Search items by name. Max-length [100]. Variants: <code>name_startswith</code> | |
| and <code>name_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: Hard Drive | |
| - name: description | |
| in: query | |
| description: 'Search items by description. Max-length [100]. Variants: <code>description_startswith</code> | |
| and <code>description_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: 500GB | |
| - name: rate | |
| in: query | |
| description: 'Search items by rate. Variants: <code>rate_less_than</code>, | |
| <code>rate_less_equals</code>, <code>rate_greater_than</code> and <code>rate_greater_equals</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: 120 | |
| - name: tax_id | |
| in: query | |
| description: Search items by tax id. | |
| required: false | |
| schema: | |
| type: string | |
| example: 982000000037049 | |
| - name: tax_name | |
| in: query | |
| required: false | |
| schema: | |
| type: string | |
| example: Sales Tax | |
| - name: is_taxable | |
| in: query | |
| description: Boolean to track the taxability of the item. | |
| required: false | |
| schema: | |
| type: boolean | |
| x-node_available_in: | |
| - in | |
| - us | |
| - mx | |
| x-node_unavailable_in: [] | |
| - name: tax_exemption_id | |
| in: query | |
| description: ID of the tax exemption. Mandatory, if <code>is_taxable</code> | |
| is false. | |
| required: false | |
| schema: | |
| type: string | |
| x-node_available_in: | |
| - in | |
| - us | |
| - mx | |
| x-node_unavailable_in: [] | |
| example: '' | |
| - name: account_id | |
| in: query | |
| description: ID of the account to which the item has to be associated with. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: filter_by | |
| in: query | |
| description: 'Filter items by status. Allowed Values: <code>Status.All</code>, | |
| <code>Status.Active</code> and <code>Status.Inactive</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: search_text | |
| in: query | |
| description: Search items by name or description. Max-length [100] | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sort_column | |
| in: query | |
| description: 'Sort items. Allowed Values: <code>name</code>, <code>rate</code> | |
| and <code>tax_name</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sat_item_key_code | |
| in: query | |
| description: SAT Item key code | |
| required: false | |
| schema: | |
| type: string | |
| x-node_available_in: | |
| - mx | |
| x-node_unavailable_in: [] | |
| example: '' | |
| - name: unitkey_code | |
| in: query | |
| description: SAT Unit code | |
| required: false | |
| schema: | |
| type: string | |
| x-node_available_in: | |
| - mx | |
| x-node_unavailable_in: [] | |
| example: '' | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-items-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| put: | |
| tags: | |
| - items | |
| operationId: update_item_using_custom_field | |
| summary: Update an item using a custom field's unique value | |
| description: A custom field will have unique values if it's configured to not | |
| accept duplicate values. Now, you can use that custom field's value to update | |
| an item by providing its API name in the X-Unique-Identifier-Key header and | |
| its value in the X-Unique-Identifier-Value header. Based on this value, the | |
| corresponding item will be retrieved and updated. Additionally, there is an | |
| optional X-Upsert header. If the X-Upsert header is true and the custom field's | |
| unique value is not found in any of the existing items, a new item will be | |
| created if the necessary payload details are available | |
| parameters: | |
| - name: X-Unique-Identifier-Key | |
| in: header | |
| description: Unique CustomField Api Name | |
| required: true | |
| schema: | |
| type: string | |
| example: cf_unique_cf | |
| - name: X-Unique-Identifier-Value | |
| in: header | |
| description: Unique CustomField Value | |
| required: true | |
| schema: | |
| type: string | |
| example: unique Value | |
| - name: X-Upsert | |
| in: header | |
| description: If there is no record is found unique custom field value , will | |
| create new invoice | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-item-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-item-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /items/{item_id}: | |
| put: | |
| tags: | |
| - items | |
| operationId: update_item | |
| summary: Update an item | |
| description: Update the details of an item. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-item-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-item-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| get: | |
| tags: | |
| - items | |
| operationId: get_item | |
| summary: Get an item | |
| description: Details of an existing item. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-an-item-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| delete: | |
| tags: | |
| - items | |
| operationId: delete_item | |
| summary: Delete an item | |
| description: Delete the item created.items that are part of transaction cannot | |
| be deleted. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-an-item-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.DELETE | |
| parameters: | |
| - name: item_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the item. | |
| schema: | |
| type: string | |
| example: 45667789900 | |
| - $ref: '#/components/parameters/organization_id' | |
| /items/{item_id}/active: | |
| post: | |
| tags: | |
| - items | |
| operationId: mark_item_active | |
| summary: Mark as active | |
| description: Mark an inactive item as active. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-as-active-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| parameters: | |
| - name: item_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the item. | |
| schema: | |
| type: string | |
| example: 45667789900 | |
| - $ref: '#/components/parameters/organization_id' | |
| /items/{item_id}/inactive: | |
| post: | |
| tags: | |
| - items | |
| operationId: mark_item_inactive | |
| summary: Mark as inactive | |
| description: Mark an active item as inactive. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-as-inactive-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| parameters: | |
| - name: item_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the item. | |
| schema: | |
| type: string | |
| example: 45667789900 | |
| - $ref: '#/components/parameters/organization_id' | |
| /journals: | |
| post: | |
| tags: | |
| - journals | |
| operationId: create_journal | |
| summary: Create a journal | |
| description: Create a journal. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-journal-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-journal-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.CREATE | |
| get: | |
| tags: | |
| - journals | |
| operationId: list_journals | |
| summary: Get journal list | |
| description: Get journal list. | |
| parameters: | |
| - name: entry_number | |
| in: query | |
| description: 'Search journals by journal entry number. Variants: <code>entry_number_startswith</code> | |
| and <code>entry_number_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '1' | |
| - name: reference_number | |
| in: query | |
| description: 'Search journals by journal reference number. Variants: <code>reference_number_startswith</code> | |
| and <code>reference_number_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '7355' | |
| - name: date | |
| in: query | |
| description: 'Search journals by journal date. Variants: <code>date_start</code>, | |
| <code>date_end</code>, <code>date_before and</code> <code>date_after</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: notes | |
| in: query | |
| description: 'Search journals by journal notes. Variants: <code>notes_startswith</code> | |
| and <code>notes_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: Loan repayment | |
| - name: last_modified_time | |
| in: query | |
| description: Search the journals using Last Modified Time | |
| required: false | |
| schema: | |
| type: string | |
| example: 2013-09-05T17:13:31+0530 | |
| - name: total | |
| in: query | |
| description: 'Search journals by journal total. Variants: <code>total_less_than</code>, | |
| <code>total_less_equals</code>, <code>total_greater_than</code> and <code>total_greater_equals</code>' | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| example: 5000 | |
| - name: customer_id | |
| in: query | |
| description: Search Journals using Customer ID | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| example: '' | |
| - name: vendor_id | |
| in: query | |
| description: Search the journals using Vendor ID | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| example: '' | |
| - name: filter_by | |
| in: query | |
| description: 'Filter journals by journal date. Allowed Values: <code>JournalDate.All</code>, | |
| <code>JournalDate.Today</code>, <code>JournalDate.ThisWeek</code>, <code>JournalDate.ThisMonth</code>, | |
| <code>JournalDate.ThisQuarter</code> and <code>JournalDate.ThisYear</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sort_column | |
| in: query | |
| description: 'Sort journal list. Allowed Values: <code>journal_date</code>, | |
| <code>entry_number</code>, <code>reference_number</code> and <code>total</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: journal_date | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-journal-list-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /journals/{journal_id}: | |
| put: | |
| tags: | |
| - journals | |
| operationId: update_journal | |
| summary: Update a journal | |
| description: Updates the journal with given information. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-journal-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-journal-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.UPDATE | |
| get: | |
| tags: | |
| - journals | |
| operationId: get_journal | |
| summary: Get journal | |
| description: Get the details of the journal. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-journal-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.READ | |
| delete: | |
| tags: | |
| - journals | |
| operationId: delete_journal | |
| summary: Delete a journal | |
| description: Deletes the given journal. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-journal-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.DELETE | |
| parameters: | |
| - name: journal_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the journal. | |
| schema: | |
| type: string | |
| example: '460000000038001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /journals/{journal_id}/attachment: | |
| post: | |
| tags: | |
| - journals | |
| operationId: add_journal_attachment | |
| summary: Add attachment to a journal | |
| description: Attach a file to a journal. | |
| parameters: | |
| - name: attachment | |
| in: query | |
| description: The file that is to be added as an Attachment in the Journal | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| - name: doc | |
| in: query | |
| description: Document that is to be attached | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| - name: totalFiles | |
| in: query | |
| description: Total number of files. | |
| required: false | |
| schema: | |
| type: integer | |
| example: 0 | |
| - name: document_ids | |
| in: query | |
| description: ID's of the document | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-attachment-to-a-journal-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.CREATE | |
| parameters: | |
| - name: journal_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the journal. | |
| schema: | |
| type: string | |
| example: '460000000038001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /journals/{journal_id}/comments: | |
| post: | |
| tags: | |
| - journals | |
| operationId: add_journal_comment | |
| summary: Add comment | |
| description: Add a comment for a journal. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-comment-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.CREATE | |
| parameters: | |
| - name: journal_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the journal. | |
| schema: | |
| type: string | |
| example: '460000000038001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /journals/{journal_id}/comments/{comment_id}: | |
| delete: | |
| tags: | |
| - journals | |
| operationId: delete_journal_comment | |
| summary: Delete a comment | |
| description: Delete a jounral comment. | |
| parameters: | |
| - name: comment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the comment. | |
| schema: | |
| type: string | |
| example: '460000000048023' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.DELETE | |
| parameters: | |
| - name: journal_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the journal. | |
| schema: | |
| type: string | |
| example: '460000000038001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /journals/{journal_id}/status/publish: | |
| post: | |
| tags: | |
| - journals | |
| operationId: mark_journal_published | |
| summary: Mark a journal as published | |
| description: Mark a draft journal as published. | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-a-journal-as-published-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.accountants.CREATE | |
| parameters: | |
| - name: journal_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the journal. | |
| schema: | |
| type: string | |
| example: '460000000038001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /locations: | |
| post: | |
| tags: | |
| - locations | |
| operationId: create_location | |
| summary: Create a location | |
| description: Create a location. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-location-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-location-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| get: | |
| tags: | |
| - locations | |
| operationId: list_locations | |
| summary: List all locations | |
| description: List all the available locations in your zoho inventory. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-all-location-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /locations/{location_id}: | |
| put: | |
| tags: | |
| - locations | |
| operationId: update_location | |
| summary: Update location | |
| description: Update location | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-location-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-location-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| delete: | |
| tags: | |
| - locations | |
| operationId: delete_location | |
| summary: Delete a location | |
| description: Delete a location. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-location-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.DELETE | |
| parameters: | |
| - name: location_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the location. | |
| schema: | |
| type: string | |
| example: 130426000000664020 | |
| - $ref: '#/components/parameters/organization_id' | |
| /locations/{location_id}/active: | |
| post: | |
| tags: | |
| - locations | |
| operationId: mark_location_active | |
| summary: Mark as Active | |
| description: Mark location as Active. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-as-active-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| parameters: | |
| - name: location_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the location. | |
| schema: | |
| type: string | |
| example: 130426000000664020 | |
| - $ref: '#/components/parameters/organization_id' | |
| /locations/{location_id}/inactive: | |
| post: | |
| tags: | |
| - locations | |
| operationId: mark_location_inactive | |
| summary: Mark as Inactive | |
| description: Mark location as Inactive. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-as-inactive-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| parameters: | |
| - name: location_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the location. | |
| schema: | |
| type: string | |
| example: 130426000000664020 | |
| - $ref: '#/components/parameters/organization_id' | |
| /locations/{location_id}/markasprimary: | |
| post: | |
| tags: | |
| - locations | |
| operationId: mark_location_primary | |
| summary: Mark as Primary | |
| description: Mark location as primary. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-as-primary-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| parameters: | |
| - name: location_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the location. | |
| schema: | |
| type: string | |
| example: 130426000000664020 | |
| - $ref: '#/components/parameters/organization_id' | |
| /organizations: | |
| post: | |
| tags: | |
| - organizations | |
| operationId: create_organization | |
| summary: Create an organization | |
| description: Create an organization. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-an-organization-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-an-organization-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| get: | |
| tags: | |
| - organizations | |
| operationId: list_organizations | |
| summary: List organizations | |
| description: Get the list of organizations. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-organizations-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| /organizations/{organization_id}: | |
| put: | |
| tags: | |
| - organizations | |
| operationId: update_organization | |
| summary: Update an organization | |
| description: Update the details of an organization. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-organization-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-organization-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| get: | |
| tags: | |
| - organizations | |
| operationId: get_organization | |
| summary: Get an organization | |
| description: Get the details of an organization. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-an-organization-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| parameters: | |
| - name: organization_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the organization. | |
| example: '10229182' | |
| /projects: | |
| post: | |
| tags: | |
| - projects | |
| operationId: create_project | |
| summary: Create a project | |
| description: Create a project. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-project-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-project-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.CREATE | |
| get: | |
| tags: | |
| - projects | |
| operationId: list_projects | |
| summary: List projects | |
| description: List all projects with pagination. | |
| parameters: | |
| - name: filter_by | |
| in: query | |
| description: 'Filter projects by any status. Allowed Values: <code>Status.All</code>, | |
| <code>Status.Active</code> and <code>Status.Inactive</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: Status.All | |
| - name: customer_id | |
| in: query | |
| description: Search projects by customer id. | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000044001' | |
| - name: sort_column | |
| in: query | |
| description: 'Sort projects. Allowed Values: <code>project_name</code>, <code>customer_name</code>, | |
| <code>rate</code> and <code>created_time</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: created_time | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-projects-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.READ | |
| put: | |
| tags: | |
| - projects | |
| operationId: update_projects_using_custom_field | |
| summary: Update a project using a custom field's unique value | |
| description: A custom field will have unique values if it's configured to not | |
| accept duplicate values. Now, you can use that custom field's value to update | |
| a project by providing its API name in the X-Unique-Identifier-Key header | |
| and its value in the X-Unique-Identifier-Value header. Based on this value, | |
| the corresponding project will be retrieved and updated. Additionally, there | |
| is an optional X-Upsert header. If the X-Upsert header is true and the custom | |
| field's unique value is not found in any of the existing projects, a new project | |
| will be created if the necessary payload details are available | |
| parameters: | |
| - name: X-Unique-Identifier-Key | |
| in: header | |
| description: Unique CustomField Api Name | |
| required: true | |
| schema: | |
| type: string | |
| example: cf_unique_cf | |
| - name: X-Unique-Identifier-Value | |
| in: header | |
| description: Unique CustomField Value | |
| required: true | |
| schema: | |
| type: string | |
| example: unique Value | |
| - name: X-Upsert | |
| in: header | |
| description: If there is no record is found unique custom field value , will | |
| create new invoice | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-project-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-project-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /projects/timeentries: | |
| post: | |
| tags: | |
| - time-entries | |
| operationId: create_time_entries | |
| summary: Log time entries | |
| description: Logging time entries. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/log-time-entries-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/log-time-entries-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.CREATE | |
| get: | |
| tags: | |
| - time-entries | |
| operationId: list_time_entries | |
| summary: List time entries. | |
| description: List all time entries with pagination. | |
| parameters: | |
| - name: from_date | |
| in: query | |
| description: Date from which the time entries logged to be fetched | |
| required: false | |
| schema: | |
| type: string | |
| example: '2013-09-17' | |
| - name: to_date | |
| in: query | |
| description: Date up to which the time entries logged to be fetched | |
| required: false | |
| schema: | |
| type: string | |
| example: '2013-09-17' | |
| - name: filter_by | |
| in: query | |
| description: 'Filter time entries by date and status. Allowed Values: <code>Date.All</code>, | |
| <code>Date.Today</code>, <code>Date.ThisWeek</code>, <code>Date.ThisMonth</code>, | |
| <code>Date.ThisQuarter</code>, <code>Date.ThisYear</code>, <code>Date.PreviousDay</code>, | |
| <code>Date.PreviousWeek</code>, <code>Date.PreviousMonth</code>, <code>Date.PreviousQuarter</code>, | |
| <code>Date.PreviousYear</code>, <code>Date.CustomDate</code>, <code>Status.Unbilled</code> | |
| and <code>Status.Invoiced</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: Status.Unbilled | |
| - name: project_id | |
| in: query | |
| description: Search time entries by project_id. | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000044019' | |
| - name: user_id | |
| in: query | |
| description: Search time entries by user_id. | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000024003' | |
| - name: sort_column | |
| in: query | |
| description: 'Sort time entries. Allowed Values: <code>project_name</code>, | |
| <code>task_name</code>, <code>user_name</code>, <code>log_date</code>, <code>timer_started_at</code> | |
| and <code>customer_name</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: customer_name | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-time-entries-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.READ | |
| delete: | |
| tags: | |
| - time-entries | |
| operationId: delete_time_entries | |
| summary: Delete time entries | |
| description: Deleting time entries. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-time-entries-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.DELETE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /projects/timeentries/runningtimer/me: | |
| get: | |
| tags: | |
| - time-entries | |
| operationId: get_running_timer | |
| summary: Get timer | |
| description: Get current running timer. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-timer-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /projects/timeentries/timer/stop: | |
| post: | |
| tags: | |
| - time-entries | |
| operationId: stop_entry_timer | |
| summary: Stop timer | |
| description: Stop tracking time, say taking a break or leaving. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/stop-timer-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.CREATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /projects/timeentries/{time_entry_id}: | |
| put: | |
| tags: | |
| - time-entries | |
| operationId: update_time_entry | |
| summary: Update time entry | |
| description: Update logged time entry. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-time-entry-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-time-entry-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.UPDATE | |
| get: | |
| tags: | |
| - time-entries | |
| operationId: get_time_entry | |
| summary: Get a time entry | |
| description: Get details of a time entry. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-time-entry-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.READ | |
| delete: | |
| tags: | |
| - time-entries | |
| operationId: delete_time_entry | |
| summary: Delete time entry | |
| description: Deleting a logged time entry. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-time-entry-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.DELETE | |
| parameters: | |
| - name: time_entry_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the time entry. | |
| example: '460000000044021' | |
| - $ref: '#/components/parameters/organization_id' | |
| /projects/timeentries/{time_entry_id}/timer/start: | |
| post: | |
| tags: | |
| - time-entries | |
| operationId: start_entry_timer | |
| summary: Start timer | |
| description: Start tracking time spent. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/start-timer-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.CREATE | |
| parameters: | |
| - name: time_entry_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the time entry. | |
| example: '460000000044021' | |
| - $ref: '#/components/parameters/organization_id' | |
| /projects/{project_id}: | |
| put: | |
| tags: | |
| - projects | |
| operationId: update_project | |
| summary: Update project | |
| description: Update details of a project. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-project-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-project-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.UPDATE | |
| get: | |
| tags: | |
| - projects | |
| operationId: get_project | |
| summary: Get a project | |
| description: Get the details of a project. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-project-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.READ | |
| delete: | |
| tags: | |
| - projects | |
| operationId: delete_project | |
| summary: Delete project | |
| description: Deleting a existing project. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-project-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.DELETE | |
| parameters: | |
| - name: project_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the project. | |
| example: '460000000044019' | |
| - $ref: '#/components/parameters/organization_id' | |
| /projects/{project_id}/active: | |
| post: | |
| tags: | |
| - projects | |
| operationId: mark_project_active | |
| summary: Activate project | |
| description: Mark project as active. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/activate-project-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.CREATE | |
| parameters: | |
| - name: project_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the project. | |
| example: '460000000044019' | |
| - $ref: '#/components/parameters/organization_id' | |
| /projects/{project_id}/clone: | |
| post: | |
| tags: | |
| - projects | |
| operationId: clone_project | |
| summary: Clone project | |
| description: Cloning a project. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/clone-project-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/clone-project-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.CREATE | |
| parameters: | |
| - name: project_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the project. | |
| example: '460000000044019' | |
| - $ref: '#/components/parameters/organization_id' | |
| /projects/{project_id}/comments: | |
| post: | |
| tags: | |
| - projects | |
| operationId: add_project_comment | |
| summary: Post comment | |
| description: Post comment to a project. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/post-comment-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/post-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.CREATE | |
| get: | |
| tags: | |
| - projects | |
| operationId: list_project_comments | |
| summary: List comments | |
| description: Get comments for a project. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-comments-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.READ | |
| parameters: | |
| - name: project_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the project. | |
| example: '460000000044019' | |
| - $ref: '#/components/parameters/organization_id' | |
| /projects/{project_id}/comments/{comment_id}: | |
| delete: | |
| tags: | |
| - projects | |
| operationId: delete_project_comment | |
| summary: Delete comment | |
| description: Deleting a comment. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.DELETE | |
| parameters: | |
| - name: project_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the project. | |
| example: '460000000044019' | |
| - name: comment_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the comment. | |
| example: '460000000044027' | |
| - $ref: '#/components/parameters/organization_id' | |
| /projects/{project_id}/inactive: | |
| post: | |
| tags: | |
| - projects | |
| operationId: mark_project_inactive | |
| summary: Inactivate a project | |
| description: Marking a project as inactive. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/inactivate-a-project-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.CREATE | |
| parameters: | |
| - name: project_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the project. | |
| example: '460000000044019' | |
| - $ref: '#/components/parameters/organization_id' | |
| /projects/{project_id}/invoices: | |
| get: | |
| tags: | |
| - projects | |
| operationId: list_project_invoices | |
| summary: List invoices | |
| description: Lists invoices created for this project. | |
| parameters: | |
| - name: sort_column | |
| in: query | |
| description: 'Sort invoices raised. Allowed Values: <code>invoice_number</code>, | |
| <code>date</code>, <code>total</code>, <code>balance</code> and <code>created_time</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: created_time | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-invoices-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.READ | |
| parameters: | |
| - name: project_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the project. | |
| example: '460000000044019' | |
| - $ref: '#/components/parameters/organization_id' | |
| /projects/{project_id}/tasks: | |
| post: | |
| tags: | |
| - tasks | |
| operationId: add_task | |
| summary: Add a task | |
| description: The task has been added. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-a-task-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-a-task-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.CREATE | |
| get: | |
| tags: | |
| - tasks | |
| operationId: list_tasks | |
| summary: List tasks | |
| description: Get list of tasks added to a project. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-tasks-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.READ | |
| parameters: | |
| - name: project_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the project. | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /projects/{project_id}/tasks/{task_id}: | |
| put: | |
| tags: | |
| - tasks | |
| operationId: update_task | |
| summary: Update a task | |
| description: Update the details of a task. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-task-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-task-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.UPDATE | |
| get: | |
| tags: | |
| - tasks | |
| operationId: get_task | |
| summary: Get a task | |
| description: Get the details of a task. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-task-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.READ | |
| delete: | |
| tags: | |
| - tasks | |
| operationId: delete_task | |
| summary: Delete Task | |
| description: Delete a task added to a project. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-task-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.DELETE | |
| parameters: | |
| - name: project_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the project. | |
| example: '90300000072369' | |
| - name: task_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the task. | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /projects/{project_id}/users: | |
| post: | |
| tags: | |
| - projects | |
| operationId: add_project_user | |
| summary: Assign users | |
| description: Assign a users to a project. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/assign-users-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/assign-users-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.CREATE | |
| get: | |
| tags: | |
| - projects | |
| operationId: list_project_users | |
| summary: List Users | |
| description: Get list of users associated with a project. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-users-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.READ | |
| parameters: | |
| - name: project_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the project. | |
| schema: | |
| type: string | |
| example: '460000000044019' | |
| - $ref: '#/components/parameters/organization_id' | |
| /projects/{project_id}/users/invite: | |
| post: | |
| tags: | |
| - projects | |
| operationId: invite_project_user | |
| summary: Invite user | |
| description: Invite and user to the project. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/invite-user-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/invite-user-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.CREATE | |
| parameters: | |
| - name: project_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the project. | |
| schema: | |
| type: string | |
| example: '460000000044019' | |
| - $ref: '#/components/parameters/organization_id' | |
| /projects/{project_id}/users/{user_id}: | |
| put: | |
| tags: | |
| - projects | |
| operationId: update_project_user | |
| summary: Update user | |
| description: Update details of a user. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-user-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-user-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.UPDATE | |
| get: | |
| tags: | |
| - projects | |
| operationId: get_project_user | |
| summary: Get a Project User | |
| description: Get details of a user in project. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-user-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.READ | |
| delete: | |
| tags: | |
| - projects | |
| operationId: delete_project_user | |
| summary: Delete user | |
| description: Remove user from a project. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-user-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.projects.DELETE | |
| parameters: | |
| - name: project_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the project. | |
| schema: | |
| type: string | |
| example: '460000000044019' | |
| - name: user_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the user. | |
| schema: | |
| type: string | |
| example: '460000000024003' | |
| - $ref: '#/components/parameters/organization_id' | |
| /purchaseorder/{purchaseorder_id}/customfields: | |
| put: | |
| tags: | |
| - purchase-order | |
| operationId: update_custom_fields_in_purchase_order | |
| summary: Update custom field in existing purchaseorders | |
| description: Update the value of the custom field in existing purchaseorders. | |
| parameters: | |
| - name: purchaseorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the purchase order. | |
| schema: | |
| type: string | |
| example: '460000000062001' | |
| - $ref: '#/components/parameters/organization_id' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/custom_fields' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-purchaseorder-customfield-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.UPDATE | |
| /purchaseorders: | |
| post: | |
| tags: | |
| - purchase-order | |
| operationId: create_purchase_order | |
| summary: Create a purchase order | |
| description: Create a purchase order for your vendor. | |
| parameters: | |
| - name: attachment | |
| in: query | |
| description: 'Allowed Extensions: <code>gif</code>, <code>png</code>, <code>jpeg</code>, | |
| <code>jpg</code>, <code>bmp</code>, <code>pdf</code>, <code>xls</code>, | |
| <code>xlsx</code>, <code>doc</code> and <code>docx</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| - name: ignore_auto_number_generation | |
| in: query | |
| description: Ignore auto purchase order number generation for this purchase | |
| order. This mandates the purchase order number. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-purchase-order-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-purchase-order-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.CREATE | |
| get: | |
| tags: | |
| - purchase-order | |
| operationId: list_purchase_orders | |
| summary: List purchase orders | |
| description: List all purchase orders. | |
| parameters: | |
| - name: purchaseorder_number | |
| in: query | |
| description: 'Search purchase order by purchase order number. Variants: <code>purchaseorder_number_startswith</code> | |
| and <code>purchaseorder_number_contains</code>. Example: Locate specific | |
| PO by number or partial match.' | |
| required: false | |
| schema: | |
| type: string | |
| example: PO-00001 | |
| - name: reference_number | |
| in: query | |
| description: 'Search purchase order by reference number. Variants: <code>reference_number_startswith</code> | |
| and <code>reference_number_contains</code>. Example: Monitor external vendor | |
| order numbers.' | |
| required: false | |
| schema: | |
| type: string | |
| example: ER/0034 | |
| - name: date | |
| in: query | |
| description: 'Search purchase order by creation date. Use YYYY-MM-DD format | |
| for exact date matching. Example: Retrieve POs created on specific date.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '2014-02-10' | |
| - name: status | |
| in: query | |
| description: 'Search purchase order by status. Allowed values: <code>draft</code>, | |
| <code>open</code>, <code>billed</code>, <code>cancelled</code>. Example: | |
| Filter POs by current workflow state.' | |
| required: false | |
| schema: | |
| type: string | |
| example: draft | |
| - name: item_description | |
| in: query | |
| description: 'Search purchase order by item description. Variants: <code>item_description_startswith</code> | |
| and <code>item_description_contains</code>. Example: Discover POs containing | |
| specific items.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: vendor_name | |
| in: query | |
| description: 'Search purchase order by vendor name. Variants: <code>vendor_name_startswith</code> | |
| and <code>vendor_name_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: total | |
| in: query | |
| description: 'Search purchase order by total amount. Variants: <code>total_start</code>, | |
| <code>total_end</code>, <code>total_less_than</code>, <code>total_less_equals</code>, | |
| <code>total_greater_than</code>, <code>total_greater_equals</code>. Example: | |
| Identify POs within price range.' | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| example: 40 | |
| - name: vendor_id | |
| in: query | |
| description: 'Search purchase order by vendor ID. Use the unique identifier | |
| of the vendor to filter purchase orders. Example: Group POs by specific | |
| vendor.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000026049' | |
| - name: last_modified_time | |
| in: query | |
| description: 'Search purchase order by last modified time. Use ISO 8601 format | |
| (YYYY-MM-DDTHH:MM:SS+/-HH:MM). Example: Identify recently updated POs.' | |
| required: false | |
| schema: | |
| type: string | |
| example: 2014-02-10T15:26:26+0530 | |
| - name: item_id | |
| in: query | |
| description: 'Search purchase order by item ID. Use the unique identifier | |
| of the specific item. Example: Locate all POs containing particular item.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000027009' | |
| - name: filter_by | |
| in: query | |
| description: 'Filter purchase order by status. Allowed values: <code>Status.All</code>, | |
| <code>Status.Draft</code>, <code>Status.Open</code>, <code>Status.Billed</code>, | |
| <code>Status.Cancelled</code>. Example: Bulk status filtering for reporting.' | |
| required: false | |
| schema: | |
| type: string | |
| example: Status.All | |
| - name: search_text | |
| in: query | |
| description: 'Search purchase order by number, reference, or vendor name. | |
| General search across multiple fields. Example: Quick PO lookup without | |
| specific field.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sort_column | |
| in: query | |
| description: 'Sort purchase orders by column. Allowed values: <code>vendor_name</code>, | |
| <code>purchaseorder_number</code>, <code>date</code>, <code>delivery_date</code>, | |
| <code>total</code>, <code>created_time</code>. Example: Organize results | |
| for analysis.' | |
| required: false | |
| schema: | |
| type: string | |
| example: created_time | |
| - name: custom_field | |
| in: query | |
| description: 'Search purchase order by purchase order''s custom field. Variants: | |
| <code>custom_field_startswith</code>, <code>custom_field_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-purchase-orders-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.READ | |
| put: | |
| tags: | |
| - purchase-order | |
| operationId: update_purchase_order_using_custom_field | |
| summary: Update a purchase order using a custom field's unique value | |
| description: A custom field will have unique values if it's configured to not | |
| accept duplicate values. Now, you can use that custom field's value to update | |
| a purchase order by providing its API name in the X-Unique-Identifier-Key | |
| header and its value in the X-Unique-Identifier-Value header. Based on this | |
| value, the corresponding purchase order will be retrieved and updated. Additionally, | |
| there is an optional X-Upsert header. If the X-Upsert header is true and the | |
| custom field's unique value is not found in any of the existing purchase orders, | |
| a new purchase order will be created if the necessary payload details are | |
| available | |
| parameters: | |
| - name: X-Unique-Identifier-Key | |
| in: header | |
| description: Unique CustomField Api Name | |
| required: true | |
| schema: | |
| type: string | |
| example: cf_unique_cf | |
| - name: X-Unique-Identifier-Value | |
| in: header | |
| description: Unique CustomField Value | |
| required: true | |
| schema: | |
| type: string | |
| example: unique Value | |
| - name: X-Upsert | |
| in: header | |
| description: If there is no record is found unique custom field value , will | |
| create new invoice | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-purchase-order-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-purchase-order-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /purchaseorders/templates: | |
| get: | |
| tags: | |
| - purchase-order | |
| operationId: list_purchase_order_templates | |
| summary: List purchase order templates | |
| description: Get all purchase order pdf templates. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-purchase-order-templates-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /purchaseorders/{purchase_order_id}: | |
| put: | |
| tags: | |
| - purchase-order | |
| operationId: update_purchase_order | |
| summary: Update a purchase order | |
| description: Update an existing purchase order. | |
| parameters: | |
| - name: attachment | |
| in: query | |
| description: 'Allowed Extensions: <code>gif</code>, <code>png</code>, <code>jpeg</code>, | |
| <code>jpg</code>, <code>bmp</code>, <code>pdf</code>, <code>xls</code>, | |
| <code>xlsx</code>, <code>doc</code> and <code>docx</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| - name: ignore_auto_number_generation | |
| in: query | |
| description: Ignore auto purchase order number generation for this purchase | |
| order. This mandates the purchase order number. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-purchase-order-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-purchase-order-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.UPDATE | |
| get: | |
| tags: | |
| - purchase-order | |
| operationId: get_purchase_order | |
| summary: Get a purchase order | |
| description: Get the details of a purchase order. | |
| parameters: | |
| - name: print | |
| in: query | |
| description: Print the exported pdf. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| - name: accept | |
| in: query | |
| description: 'Get the details of a particular purchase order in formats such | |
| as json/ pdf/ html. Default format is json. Allowed Values: <code>json</code>, | |
| <code>pdf</code> and <code>html</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: json | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-purchase-order-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.READ | |
| delete: | |
| tags: | |
| - purchase-order | |
| operationId: delete_purchase_order | |
| summary: Delete purchase order | |
| description: Delete an existing purchase order. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-purchase-order-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.DELETE | |
| parameters: | |
| - name: purchase_order_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the purchase order. | |
| schema: | |
| type: string | |
| example: '460000000062001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /purchaseorders/{purchaseorder_id}/address/billing: | |
| put: | |
| tags: | |
| - purchase-order | |
| operationId: update_purchase_order_billing_address | |
| summary: Update billing address | |
| description: Updates the billing address for this purchase order alone. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-billing-address-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-billing-address-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.UPDATE | |
| parameters: | |
| - name: purchaseorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the purchase order. | |
| schema: | |
| type: string | |
| example: '460000000062001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /purchaseorders/{purchaseorder_id}/approve: | |
| post: | |
| tags: | |
| - purchase-order | |
| operationId: approve_purchase_order | |
| summary: Approve a purchase order | |
| description: Approve a purchase order. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/approve-a-purchase-order-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.CREATE | |
| parameters: | |
| - name: purchaseorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the purchase order. | |
| schema: | |
| type: string | |
| example: '460000000062001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /purchaseorders/{purchaseorder_id}/attachment: | |
| get: | |
| tags: | |
| - purchase-order | |
| operationId: get_purchase_order_attachment | |
| summary: Get a purchase order attachment | |
| description: Returns the file attached to the purchase order. | |
| parameters: | |
| - name: preview | |
| in: query | |
| description: Get the thumbnail of the attachment. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-purchase-order-attachment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.READ | |
| post: | |
| tags: | |
| - purchase-order | |
| operationId: add_purchase_order_attachment | |
| summary: Add attachment to a purchase order | |
| description: Attach a file to a purchase order. | |
| parameters: | |
| - name: attachment | |
| in: query | |
| description: 'Allowed Extensions: <code>gif</code>, <code>png</code>, <code>jpeg</code>, | |
| <code>jpg</code>, <code>bmp</code>, <code>pdf</code>, <code>xls</code>, | |
| <code>xlsx</code>, <code>doc</code> and <code>docx</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-attachment-to-a-purchase-order-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.CREATE | |
| put: | |
| tags: | |
| - purchase-order | |
| operationId: update_purchase_order_attachment | |
| summary: Update attachment preference | |
| description: Set whether you want to send the attached file while emailing the | |
| purchase order. | |
| parameters: | |
| - name: can_send_in_mail | |
| in: query | |
| description: Boolean to send the attachment with the purchase order when emailed. | |
| required: true | |
| schema: | |
| type: boolean | |
| example: false | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-attachment-preference-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.UPDATE | |
| delete: | |
| tags: | |
| - purchase-order | |
| operationId: delete_purchase_order_attachment | |
| summary: Delete an attachment | |
| description: Delete the file attached to the purchase order. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-an-attachment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.DELETE | |
| parameters: | |
| - name: purchaseorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the purchase order. | |
| schema: | |
| type: string | |
| example: '460000000062001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /purchaseorders/{purchaseorder_id}/comments: | |
| get: | |
| tags: | |
| - purchase-order | |
| operationId: list_purchase_order_comments | |
| summary: List purchase order comments & history | |
| description: Get the complete history and comments of purchase order. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-purchase-order-comments-and-history-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.READ | |
| post: | |
| tags: | |
| - purchase-order | |
| operationId: add_purchase_order_comment | |
| summary: Add comment | |
| description: Add a comment for a purchase order. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-comment-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.CREATE | |
| parameters: | |
| - name: purchaseorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the purchase order. | |
| schema: | |
| type: string | |
| example: '460000000062001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /purchaseorders/{purchaseorder_id}/comments/{comment_id}: | |
| put: | |
| tags: | |
| - purchase-order | |
| operationId: update_purchase_order_comment | |
| summary: Update comment | |
| description: Update an existing comment of a purchase order. | |
| parameters: | |
| - name: comment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the comment. | |
| schema: | |
| type: string | |
| example: '460000000012345' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-comment-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.UPDATE | |
| delete: | |
| tags: | |
| - purchase-order | |
| operationId: delete_purchase_order_comment | |
| summary: Delete a comment | |
| description: Delete a purchase order comment. | |
| parameters: | |
| - name: comment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the comment. | |
| schema: | |
| type: string | |
| example: '460000000012345' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.DELETE | |
| parameters: | |
| - name: purchaseorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the purchase order. | |
| schema: | |
| type: string | |
| example: '460000000062001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /purchaseorders/{purchaseorder_id}/email: | |
| post: | |
| tags: | |
| - purchase-order | |
| operationId: email_purchase_order | |
| summary: Email a purchase order | |
| description: Email a purchase order to the vendor. Input json string is not | |
| mandatory. If input json string is empty, mail will be send with default mail | |
| content. | |
| parameters: | |
| - name: attachments | |
| in: query | |
| description: The files to be attached with the email. | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| - name: send_attachment | |
| in: query | |
| description: Send the purchase order attachment a with the email. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| - name: file_name | |
| in: query | |
| description: Name of the file | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-a-purchase-order-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-a-purchase-order-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.CREATE | |
| get: | |
| tags: | |
| - purchase-order | |
| operationId: get_purchase_order_email | |
| summary: Get purchase order email content | |
| description: Get the email content of a purchase order. | |
| parameters: | |
| - name: email_template_id | |
| in: query | |
| description: Get the email content based on a specific email template. If | |
| this param is not inputted, then the content will be based on the email | |
| template associated with the customer. If no template is associated with | |
| the customer, then default template will be used. | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000011023' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-purchase-order-email-content-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.READ | |
| parameters: | |
| - name: purchaseorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the purchase order. | |
| schema: | |
| type: string | |
| example: '460000000062001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /purchaseorders/{purchaseorder_id}/reject: | |
| post: | |
| tags: | |
| - purchase-order | |
| operationId: reject_purchase_orders | |
| summary: Reject Purchase Order | |
| description: Reject a purchase order. | |
| parameters: | |
| - name: purchaseorder_id | |
| in: path | |
| required: true | |
| schema: | |
| type: string | |
| example: '460000000012345' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/reject_purchase_order' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /purchaseorders/{purchaseorder_id}/status/billed: | |
| post: | |
| tags: | |
| - purchase-order | |
| operationId: mark_purchase_order_billed | |
| summary: Mark as billed | |
| description: Mark a purchase order as billed. | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-as-billed-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.CREATE | |
| parameters: | |
| - name: purchaseorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the purchase order. | |
| schema: | |
| type: string | |
| example: '460000000062001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /purchaseorders/{purchaseorder_id}/status/cancelled: | |
| post: | |
| tags: | |
| - purchase-order | |
| operationId: mark_purchase_order_cancelled | |
| summary: Cancel a purchase order | |
| description: Mark a purchase order as cancelled. | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/cancel-a-purchase-order-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.CREATE | |
| parameters: | |
| - name: purchaseorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the purchase order. | |
| schema: | |
| type: string | |
| example: '460000000062001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /purchaseorders/{purchaseorder_id}/status/open: | |
| post: | |
| tags: | |
| - purchase-order | |
| operationId: mark_purchase_order_open | |
| summary: Mark a purchase order as open | |
| description: Mark a draft purchase order as open. | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-a-purchase-order-as-open-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.CREATE | |
| parameters: | |
| - name: purchaseorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the purchase order. | |
| schema: | |
| type: string | |
| example: '460000000062001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /purchaseorders/{purchaseorder_id}/submit: | |
| post: | |
| tags: | |
| - purchase-order | |
| operationId: submit_purchase_order | |
| summary: Submit a purchase order for approval | |
| description: Submit a purchase order for approval. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/submit-a-purchase-order-for-approval-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.CREATE | |
| parameters: | |
| - name: purchaseorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the purchase order. | |
| schema: | |
| type: string | |
| example: '460000000062001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /purchaseorders/{purchaseorder_id}/templates/{template_id}: | |
| put: | |
| tags: | |
| - purchase-order | |
| operationId: update_purchase_order_template | |
| summary: Update purchase order template | |
| description: Update the pdf template associated with the purchase order. | |
| parameters: | |
| - name: template_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the purchase order template. | |
| schema: | |
| type: string | |
| example: '460000000011003' | |
| - name: templates | |
| in: query | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| template_name: | |
| $ref: '#/components/schemas/template_name' | |
| template_id: | |
| $ref: '#/components/schemas/template_id' | |
| template_type: | |
| $ref: '#/components/schemas/template_type' | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-purchase-order-template-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.purchaseorders.UPDATE | |
| parameters: | |
| - name: purchaseorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the purchase order. | |
| schema: | |
| type: string | |
| example: '460000000062001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /recurring_bills/{recurring_bill_id}: | |
| get: | |
| tags: | |
| - recurring-bills | |
| operationId: get_recurring_bill | |
| summary: Get a recurring bill | |
| description: Get the details of a recurring bill. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-recurring-bill-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.READ | |
| delete: | |
| tags: | |
| - recurring-bills | |
| operationId: delete_recurring_bill | |
| summary: Delete a recurring bill | |
| description: Delete an existing recurring bill. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-recurring-bill-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.DELETE | |
| parameters: | |
| - name: recurring_bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the recurring bill. | |
| schema: | |
| type: string | |
| example: 982000000567240 | |
| - $ref: '#/components/parameters/organization_id' | |
| /recurringbills: | |
| post: | |
| tags: | |
| - recurring-bills | |
| operationId: create_recurring_bill | |
| summary: Create a recurring bill | |
| description: Create a recurring bill. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-recurring-bill-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-recurring-bill-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.CREATE | |
| get: | |
| tags: | |
| - recurring-bills | |
| operationId: list_recurring_bills | |
| summary: List recurring bills | |
| description: List all recurring bills with pagination. | |
| parameters: | |
| - name: recurring_bill_id | |
| in: query | |
| required: false | |
| schema: | |
| type: string | |
| example: 982000000567240 | |
| - name: vendor_id | |
| in: query | |
| description: Search recurring bills by Vendor ID | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| example: '460000000038029' | |
| - name: vendor_name | |
| in: query | |
| description: 'Search recurring bills by vendor name. Variants: <code>vendor_name_startswith</code> | |
| and <code>vendor_name_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: status | |
| in: query | |
| description: 'Search recurring bills by recurring bill status. Allowed Values: | |
| <code>active</code>, <code>stopped</code>, <code>expired</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: active | |
| - name: recurrence_name | |
| in: query | |
| description: 'Search recurring bills by recurrence number. Variants: <code>recurrence_name_startswith</code> | |
| and <code>recurrence_name_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: Monthly Rental | |
| - name: currency_id | |
| in: query | |
| description: ID of the Currency | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000000099' | |
| - name: currency_code | |
| in: query | |
| description: Code of the Currency | |
| required: false | |
| schema: | |
| type: string | |
| example: INR | |
| - name: currency_symbol | |
| in: query | |
| description: Symbol of the Currency | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: start_date | |
| in: query | |
| description: 'Search recurring bills by recurring bill start date. Variants: | |
| <code>start_date_start</code>, <code>start_date_end</code>, <code>start_date_before</code> | |
| and <code>start_date_after</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '2013-11-18' | |
| - name: end_date | |
| in: query | |
| description: Date on which recurring bill has to expire. Can be left as empty | |
| to run forever. Format [yyyy-mm-dd]. | |
| required: false | |
| schema: | |
| type: string | |
| example: '2013-12-18' | |
| - name: source_of_supply | |
| in: query | |
| description: Place from where the goods/services are supplied. (If not given, | |
| <code>place of contact</code> given for the contact will be taken) | |
| required: false | |
| schema: | |
| type: string | |
| example: AP | |
| x-node_available_in: | |
| - in | |
| x-node_unavailable_in: [] | |
| - name: place_of_supply | |
| in: query | |
| description: 'The place of supply is where a transaction is considered to | |
| have occurred for VAT purposes. For the supply of goods, the place of supply | |
| is the location of the goods when the supply occurs. For the supply of services, | |
| the place of supply should be where the supplier is established. (If not | |
| given, <code>place of contact</code> given for the contact will be taken)<br/>Supported | |
| codes for UAE emirates are : </br>Abu Dhabi - <code>AB</code>,</br>Ajman | |
| - <code>AJ</code>,</br>Dubai - <code>DU</code>,</br>Fujairah - <code>FU</code>,</br>Ras | |
| al-Khaimah - <code>RA</code>,</br>Sharjah - <code>SH</code>,</br>Umm al-Quwain | |
| - <code>UM</code>.<br/>Supported codes for the GCC countries are : </br>United | |
| Arab Emirates - <code>AE</code>,</br>Saudi Arabia - <code>SA</code>,</br>Bahrain | |
| - <code>BH</code>,</br>Kuwait - <code>KW</code>,</br>Oman - <code>OM</code>,</br>Qatar | |
| - <code>QA</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: DU | |
| x-node_available_in: | |
| - gcc | |
| x-node_unavailable_in: [] | |
| - name: destination_of_supply | |
| in: query | |
| description: Place where the goods/services are supplied to. (If not given, | |
| organisation's home state will be taken) | |
| required: false | |
| schema: | |
| type: string | |
| example: TN | |
| x-node_available_in: | |
| - in | |
| x-node_unavailable_in: [] | |
| - name: gst_treatment | |
| in: query | |
| description: Choose whether the contact is GST registered/unregistered/consumer/overseas. | |
| Allowed values are <code> business_gst </code> , <code> business_none </code> | |
| , <code> overseas </code> , <code> consumer </code>. | |
| required: false | |
| schema: | |
| type: string | |
| example: business_gst | |
| x-node_available_in: | |
| - in | |
| x-node_unavailable_in: [] | |
| - name: gst_no | |
| in: query | |
| description: 15 digit GST identification number of the vendor. | |
| required: false | |
| schema: | |
| type: string | |
| example: 22AAAAA0000A1Z5 | |
| x-node_available_in: | |
| - in | |
| x-node_unavailable_in: [] | |
| - name: tax_treatment | |
| in: query | |
| description: 'VAT treatment for the bill. Choose whether the vendor falls | |
| under: <code>vat_registered</code>,<code>vat_not_registered</code>,<code>gcc_vat_not_registered</code>,<code>gcc_vat_registered</code>,<code>non_gcc</code>.</br><code>dz_vat_registered</code> | |
| and <code>dz_vat_not_registered</code> are supported only for <b>UAE</b>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: vat_registered | |
| x-node_available_in: | |
| - gcc | |
| - mx | |
| x-node_unavailable_in: [] | |
| - name: vat_treatment | |
| in: query | |
| description: (Optional) VAT treatment for the bill. VAT treatment denotes | |
| the location of the vendor, if the vendor resides in UK then the VAT treatment | |
| is <code>uk</code>. If the vendor is in an EU country & VAT registered, | |
| you are resides in Northen Ireland and purchasing Goods then his VAT treatment | |
| is <code>eu_vat_registered</code> and if he resides outside the UK then | |
| his VAT treatment is <code>overseas</code>(For Pre Brexit, this can be split | |
| as <code>eu_vat_registered</code>, <code>eu_vat_not_registered</code> and | |
| <code>non_eu</code>). | |
| required: false | |
| schema: | |
| type: string | |
| x-node_available_in: | |
| - uk | |
| x-node_unavailable_in: [] | |
| example: '' | |
| - name: vat_reg_no | |
| in: query | |
| description: <b>For UK Edition:</b> VAT Registration number of a contact with | |
| length should be between 2 and 12 characters.<br/> <b>For Avalara:</b> If | |
| you are doing sales in the European Union (EU) then provide VAT Registration | |
| Number of your customers here. This is used to calculate VAT for B2B sales, | |
| from Avalara. | |
| required: false | |
| schema: | |
| type: string | |
| x-node_available_in: | |
| - uk | |
| - Avalara Integration | |
| x-node_unavailable_in: [] | |
| example: '' | |
| - name: is_abn_quoted | |
| in: query | |
| required: false | |
| schema: | |
| type: string | |
| x-node_available_in: | |
| - au | |
| x-node_unavailable_in: [] | |
| example: '' | |
| - name: abn | |
| in: query | |
| required: false | |
| schema: | |
| type: string | |
| x-node_available_in: | |
| - au | |
| x-node_unavailable_in: [] | |
| example: '' | |
| - name: is_reverse_charge_applied | |
| in: query | |
| description: Applicable for transactions where you pay reverse charge | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| x-node_available_in: | |
| - in | |
| x-node_unavailable_in: [] | |
| - name: pricebook_id | |
| in: query | |
| description: Enter ID of the price book. | |
| required: false | |
| schema: | |
| type: string | |
| example: 460000000038090 | |
| - name: pricebook_name | |
| in: query | |
| description: Name of the price book | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: is_inclusive_tax | |
| in: query | |
| description: Used to specify whether the line item rates are inclusive or | |
| exclusive of tax. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| x-node_available_in: [] | |
| x-node_unavailable_in: | |
| - us | |
| - name: line_items | |
| in: query | |
| description: Line items of a recurrence bill. | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| description: | |
| $ref: '#/components/schemas/description' | |
| sku: | |
| $ref: '#/components/schemas/sku' | |
| name: | |
| $ref: '#/components/schemas/name' | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| account_name: | |
| $ref: '#/components/schemas/account_name' | |
| image_document_id: | |
| $ref: '#/components/schemas/image_document_id' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| location_name: | |
| $ref: '#/components/schemas/location_name' | |
| reverse_charge_tax_id: | |
| $ref: '#/components/schemas/reverse_charge_tax_id' | |
| reverse_charge_tax_name: | |
| $ref: '#/components/schemas/reverse_charge_tax_name' | |
| reverse_charge_tax_percentage: | |
| $ref: '#/components/schemas/reverse_charge_tax_percentage' | |
| reverse_charge_tax_amount: | |
| $ref: '#/components/schemas/reverse_charge_tax_amount' | |
| bcy_rate: | |
| $ref: '#/components/schemas/bcy_rate' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| quantity: | |
| $ref: '#/components/schemas/quantity' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tax_treatment_code: | |
| $ref: '#/components/schemas/tax_treatment_code' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| tax_exemption_code: | |
| $ref: '#/components/schemas/tax_exemption_code' | |
| tax_name: | |
| $ref: '#/components/schemas/tax_name' | |
| tax_type: | |
| $ref: '#/components/schemas/tax_type' | |
| tax_percentage: | |
| $ref: '#/components/schemas/tax_percentage' | |
| item_total: | |
| $ref: '#/components/schemas/item_total' | |
| item_total_inclusive_of_tax: | |
| $ref: '#/components/schemas/item_total_inclusive_of_tax' | |
| item_order: | |
| $ref: '#/components/schemas/item_order' | |
| unit: | |
| $ref: '#/components/schemas/unit' | |
| product_type: | |
| $ref: '#/components/schemas/product_type' | |
| hsn_or_sac: | |
| $ref: '#/components/schemas/hsn_or_sac' | |
| acquisition_vat_id: | |
| $ref: '#/components/schemas/acquisition_vat_id' | |
| acquisition_vat_name: | |
| $ref: '#/components/schemas/acquisition_vat_name' | |
| acquisition_vat_percentage: | |
| $ref: '#/components/schemas/acquisition_vat_percentage' | |
| acquisition_vat_amount: | |
| $ref: '#/components/schemas/acquisition_vat_amount' | |
| reverse_charge_vat_id: | |
| $ref: '#/components/schemas/reverse_charge_vat_id' | |
| reverse_charge_vat_name: | |
| $ref: '#/components/schemas/reverse_charge_vat_name' | |
| reverse_charge_vat_percentage: | |
| $ref: '#/components/schemas/reverse_charge_vat_percentage' | |
| reverse_charge_vat_amount: | |
| $ref: '#/components/schemas/reverse_charge_vat_amount' | |
| is_billable: | |
| $ref: '#/components/schemas/is_billable' | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| customer_name: | |
| $ref: '#/components/schemas/customer_name' | |
| project_id: | |
| $ref: '#/components/schemas/project_id' | |
| project_name: | |
| $ref: '#/components/schemas/project_name' | |
| item_custom_fields: | |
| $ref: '#/components/schemas/item_custom_fields' | |
| example: '' | |
| - name: is_tds_applied | |
| in: query | |
| description: Check if TDS is applied | |
| required: false | |
| schema: | |
| type: boolean | |
| x-node_available_in: | |
| - in | |
| - global | |
| - au | |
| x-node_unavailable_in: [] | |
| - name: notes | |
| in: query | |
| description: Notes for the Bill | |
| required: false | |
| schema: | |
| type: string | |
| example: Thanks for your business. | |
| - name: terms | |
| in: query | |
| description: Terms and Conditions for the Bill | |
| required: false | |
| schema: | |
| type: string | |
| example: Terms and conditions apply. | |
| - name: payment_terms | |
| in: query | |
| description: Number Referring to Payment Terms | |
| required: false | |
| schema: | |
| type: integer | |
| example: 0 | |
| - name: payment_terms_label | |
| in: query | |
| description: Label of the Payment Terms | |
| required: false | |
| schema: | |
| type: string | |
| example: Due on Receipt | |
| - name: custom_fields | |
| in: query | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| custom_field_id: | |
| $ref: '#/components/schemas/custom_field_id' | |
| index: | |
| $ref: '#/components/schemas/index' | |
| label: | |
| $ref: '#/components/schemas/label' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| example: '' | |
| - name: acquisition_vat_summary | |
| in: query | |
| description: Summary of the VAT Acquistion | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| tax_name: | |
| $ref: '#/components/schemas/tax_name' | |
| tax_amount: | |
| $ref: '#/components/schemas/tax_amount' | |
| x-node_available_in: | |
| - uk | |
| - eu | |
| x-node_unavailable_in: [] | |
| example: '' | |
| - name: reverse_charge_vat_summary | |
| in: query | |
| description: Summary of the Reverse Charge | |
| required: false | |
| schema: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| tax_name: | |
| $ref: '#/components/schemas/tax_name' | |
| tax_amount: | |
| $ref: '#/components/schemas/tax_amount' | |
| x-node_available_in: | |
| - uk | |
| - eu | |
| x-node_unavailable_in: [] | |
| example: '' | |
| - name: acquisition_vat_total | |
| in: query | |
| description: Total of the VAT Acquistion | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| x-node_available_in: | |
| - uk | |
| - eu | |
| x-node_unavailable_in: [] | |
| example: '' | |
| - name: reverse_charge_vat_total | |
| in: query | |
| description: Total of the Reverse Charge | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| x-node_available_in: | |
| - uk | |
| - eu | |
| x-node_unavailable_in: [] | |
| example: '' | |
| - name: created_time | |
| in: query | |
| description: Created time of the bill | |
| required: false | |
| schema: | |
| type: string | |
| example: 2013-09-11T17:18:32+0530 | |
| - name: created_by_id | |
| in: query | |
| description: Name of User who created the Bill | |
| required: false | |
| schema: | |
| type: string | |
| example: '4600000053001' | |
| - name: last_modified_time | |
| in: query | |
| description: Last Modified Time of the Bill | |
| required: false | |
| schema: | |
| type: string | |
| example: 2013-09-11T17:18:32+0530 | |
| - name: discount | |
| in: query | |
| description: 'Discount applied to the recurrence. It can be either in % or | |
| in amount. E.g: 12.5% or 190.' | |
| required: false | |
| schema: | |
| type: string | |
| example: 30% | |
| - name: discount_account_id | |
| in: query | |
| description: ID of the account associated with the discount account. | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000000403' | |
| - name: is_discount_before_tax | |
| in: query | |
| description: To specify discount applied in before /after tax. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-recurring-bills-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.READ | |
| put: | |
| tags: | |
| - recurring-bills | |
| operationId: update_recurring_bill_using_custom_field | |
| summary: Update a recurring bill using a custom field's unique value | |
| description: A custom field will have unique values if it's configured to not | |
| accept duplicate values. Now, you can use that custom field's value to update | |
| a recurring bill by providing its API name in the X-Unique-Identifier-Key | |
| header and its value in the X-Unique-Identifier-Value header. Based on this | |
| value, the corresponding recurring bill will be retrieved and updated. Additionally, | |
| there is an optional X-Upsert header. If the X-Upsert header is true and the | |
| custom field's unique value is not found in any of the existing recurring | |
| bills, a new recurring bill will be created if the necessary payload details | |
| are available | |
| parameters: | |
| - name: X-Unique-Identifier-Key | |
| in: header | |
| description: Unique CustomField Api Name | |
| required: true | |
| schema: | |
| type: string | |
| example: cf_unique_cf | |
| - name: X-Unique-Identifier-Value | |
| in: header | |
| description: Unique CustomField Value | |
| required: true | |
| schema: | |
| type: string | |
| example: unique Value | |
| - name: X-Upsert | |
| in: header | |
| description: If there is no record is found unique custom field value , will | |
| create new invoice | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-recurring-bill-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-recurring-bill-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /recurringbills/{recurring_bill_id}: | |
| put: | |
| tags: | |
| - recurring-bills | |
| operationId: update_recurring_bill | |
| summary: Update a recurring bill | |
| description: Update a recurring bill. To delete a line item just remove it from | |
| the line_items list. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-recurring-bill-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-recurring-bill-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.UPDATE | |
| parameters: | |
| - name: recurring_bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the recurring bill. | |
| schema: | |
| type: string | |
| example: 982000000567240 | |
| - $ref: '#/components/parameters/organization_id' | |
| /recurringbills/{recurring_bill_id}/comments: | |
| get: | |
| tags: | |
| - recurring-bills | |
| operationId: list_recurring_bill_history | |
| summary: List recurring bill history | |
| description: Get history and comments of a recurring bill. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-recurring-bill-history-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.READ | |
| parameters: | |
| - name: recurring_bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the recurring bill. | |
| schema: | |
| type: string | |
| example: 982000000567240 | |
| - $ref: '#/components/parameters/organization_id' | |
| /recurringbills/{recurring_bill_id}/status/resume: | |
| post: | |
| tags: | |
| - recurring-bills | |
| operationId: resume_recurring_bill | |
| summary: Resume a recurring Bill | |
| description: Resume a stopped recurring bill. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/resume-a-recurring-bill-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.CREATE | |
| parameters: | |
| - name: recurring_bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the recurring bill. | |
| schema: | |
| type: string | |
| example: 982000000567240 | |
| - $ref: '#/components/parameters/organization_id' | |
| /recurringbills/{recurring_bill_id}/status/stop: | |
| post: | |
| tags: | |
| - recurring-bills | |
| operationId: stop_recurring_bill | |
| summary: Stop a recurring bill | |
| description: Stop an active recurring bill. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/stop-a-recurring-bill-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.bills.CREATE | |
| parameters: | |
| - name: recurring_bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the recurring bill. | |
| schema: | |
| type: string | |
| example: 982000000567240 | |
| - $ref: '#/components/parameters/organization_id' | |
| /recurringexpenses: | |
| post: | |
| tags: | |
| - recurring-expenses | |
| operationId: create_recurring_expense | |
| summary: Create a recurring expense | |
| description: Create a recurring expense. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-recurring-expense-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-recurring-expense-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.CREATE | |
| get: | |
| tags: | |
| - recurring-expenses | |
| operationId: list_recurring_expenses | |
| summary: List recurring expenses | |
| description: List all the Expenses with pagination. | |
| parameters: | |
| - name: recurrence_name | |
| in: query | |
| description: 'Search recurring expenses by recurring expense name. Variants: | |
| <code>recurrence_name_startswith</code> and <code>recurrence_name_contains</code>. | |
| Max-length [100]' | |
| required: false | |
| schema: | |
| type: string | |
| example: Monthly Rental | |
| - name: last_created_date | |
| in: query | |
| description: 'Search recurring expenses by date on when last expense was generated. | |
| Variants: <code>last_created_date_start</code>, <code>last_created_date_end</code>, | |
| <code>last_created_date_before</code> and <code>last_created_date_after</code> | |
| . Format [yyyy-mm-dd]' | |
| required: false | |
| schema: | |
| type: string | |
| example: '2013-11-18T00:00:00+00:00' | |
| - name: next_expense_date | |
| in: query | |
| description: 'Search recurring expenses by date on which next expense will | |
| be generated. Variants: <code>next_expense_date_start</code>, <code>next_expense_date_end</code>, | |
| <code>next_expense_date_before</code> and <code>next_expense_date_after</code> | |
| . Format [yyyy-mm-dd]' | |
| required: false | |
| schema: | |
| type: string | |
| example: '2013-12-18T00:00:00+00:00' | |
| - name: status | |
| in: query | |
| description: Search expenses by expense status. Allowed Values <code>active</code>, | |
| <code>stopped</code> and <code>expired</code> | |
| required: false | |
| schema: | |
| type: string | |
| example: active | |
| - name: account_id | |
| in: query | |
| required: false | |
| schema: | |
| type: string | |
| example: 982000000561057 | |
| - name: account_name | |
| in: query | |
| description: Search expenses by expense account name. Variants <code>account_name_startswith</code> | |
| and <code>account_name_contains</code> . Max-length [100] | |
| required: false | |
| schema: | |
| type: string | |
| example: Rent | |
| - name: amount | |
| in: query | |
| description: 'Search expenses by amount. Variants: <code>amount_less_than</code>, | |
| <code>amount_less_equals</code>, <code>amount_greater_than</code> and <code>amount_greater_than</code>' | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| example: 112.5 | |
| - name: customer_name | |
| in: query | |
| description: 'Search expenses by customer name. Variants: <code>customer_name_startswith</code> | |
| and <code>customer_name_contains</code> . Max-length [100]' | |
| required: false | |
| schema: | |
| type: string | |
| example: Bowman & Co | |
| - name: customer_id | |
| in: query | |
| description: Search expenses by customer id. | |
| required: false | |
| schema: | |
| type: string | |
| example: 982000000567001 | |
| - name: paid_through_account_id | |
| in: query | |
| description: Search expenses by paid through account id. | |
| required: false | |
| schema: | |
| type: string | |
| example: 982000000567250 | |
| - name: filter_by | |
| in: query | |
| description: Filter expenses by expense status. Allowed Values <code>Status.All</code>, | |
| <code>Status.Active</code>, <code>Status.Expired</code> and <code>Status.Stopped</code> | |
| required: false | |
| schema: | |
| type: string | |
| example: Status.Billable | |
| - name: search_text | |
| in: query | |
| description: Search expenses by account name or description or <code>customer | |
| name</code> or <code>vendor name</code>. Max-length [100] . | |
| required: false | |
| schema: | |
| type: string | |
| example: Rent | |
| - name: sort_column | |
| in: query | |
| description: Sort expenses.Allowed Values <code>next_expense_date</code>, | |
| <code>account_name</code>, <code>total</code>, <code>last_created_date</code>, | |
| <code>recurrence_name</code>, <code>customer_name</code> and <code>created_time</code> | |
| required: false | |
| schema: | |
| type: string | |
| example: account_name | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-recurring-expenses-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.READ | |
| put: | |
| tags: | |
| - recurring-expenses | |
| operationId: update_recurring_expense_using_custom_field | |
| summary: Update an recurring expense using a custom field's unique value | |
| description: A custom field will have unique values if it's configured to not | |
| accept duplicate values. Now, you can use that custom field's value to update | |
| a recurring expense by providing its API name in the X-Unique-Identifier-Key | |
| header and its value in the X-Unique-Identifier-Value header. Based on this | |
| value, the corresponding recurring expense will be retrieved and updated. | |
| Additionally, there is an optional X-Upsert header. If the X-Upsert header | |
| is true and the custom field's unique value is not found in any of the existing | |
| recurring expenses, a new recurring expense will be created if the necessary | |
| payload details are available | |
| parameters: | |
| - name: X-Unique-Identifier-Key | |
| in: header | |
| description: Unique CustomField Api Name | |
| required: true | |
| schema: | |
| type: string | |
| example: cf_unique_cf | |
| - name: X-Unique-Identifier-Value | |
| in: header | |
| description: Unique CustomField Value | |
| required: true | |
| schema: | |
| type: string | |
| example: unique Value | |
| - name: X-Upsert | |
| in: header | |
| description: If there is no record is found unique custom field value , will | |
| create new invoice | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-recurring-expense-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-recurring-expense-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /recurringexpenses/{recurring_expense_id}: | |
| put: | |
| tags: | |
| - recurring-expenses | |
| operationId: update_recurring_expense | |
| summary: Update a recurring expense | |
| description: Update a recurring expense. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-recurring-expense-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-recurring-expense-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.UPDATE | |
| get: | |
| tags: | |
| - recurring-expenses | |
| operationId: get_recurring_expense | |
| summary: Get a recurring expense | |
| description: Get the details of the recurring expense. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-recurring-expense-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.READ | |
| delete: | |
| tags: | |
| - recurring-expenses | |
| operationId: delete_recurring_expense | |
| summary: Delete a recurring expense | |
| description: Deleting an existing recurring expense. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-recurring-expense-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.DELETE | |
| parameters: | |
| - name: recurring_expense_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the recurring expense. | |
| schema: | |
| type: string | |
| example: 982000000567240 | |
| - $ref: '#/components/parameters/organization_id' | |
| /recurringexpenses/{recurring_expense_id}/comments: | |
| get: | |
| tags: | |
| - recurring-expenses | |
| operationId: list_recurring_expense_history | |
| summary: List recurring expense history | |
| description: Get history and comments of a recurring expense. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-recurring-expense-history-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.READ | |
| parameters: | |
| - name: recurring_expense_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the recurring expense. | |
| schema: | |
| type: string | |
| example: 982000000567240 | |
| - $ref: '#/components/parameters/organization_id' | |
| /recurringexpenses/{recurring_expense_id}/expenses: | |
| get: | |
| tags: | |
| - recurring-expenses | |
| operationId: list_child_expenses_of_recurring_expense | |
| summary: List child expenses created | |
| description: List child expenses created from recurring expense. | |
| parameters: | |
| - name: sort_column | |
| in: query | |
| description: Sort expenses.Allowed Values <code>next_expense_date</code>, | |
| <code>account_name</code>, <code>total</code>, <code>last_created_date</code>, | |
| <code>recurrence_name</code>, <code>customer_name</code> and <code>created_time</code> | |
| required: false | |
| schema: | |
| type: string | |
| example: account_name | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-child-expenses-created-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.READ | |
| parameters: | |
| - name: recurring_expense_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the recurring expense. | |
| schema: | |
| type: string | |
| example: 982000000567240 | |
| - $ref: '#/components/parameters/organization_id' | |
| /recurringexpenses/{recurring_expense_id}/status/resume: | |
| post: | |
| tags: | |
| - recurring-expenses | |
| operationId: resume_recurring_expense | |
| summary: Resume a recurring Expense | |
| description: Resume a stopped recurring expense. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/resume-a-recurring-expense-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.CREATE | |
| parameters: | |
| - name: recurring_expense_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the recurring expense. | |
| schema: | |
| type: string | |
| example: 982000000567240 | |
| - $ref: '#/components/parameters/organization_id' | |
| /recurringexpenses/{recurring_expense_id}/status/stop: | |
| post: | |
| tags: | |
| - recurring-expenses | |
| operationId: stop_recurring_expense | |
| summary: Stop a recurring expense | |
| description: Stop an active recurring expense. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/stop-a-recurring-expense-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.expenses.CREATE | |
| parameters: | |
| - name: recurring_expense_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the recurring expense. | |
| schema: | |
| type: string | |
| example: 982000000567240 | |
| - $ref: '#/components/parameters/organization_id' | |
| /recurringinvoices: | |
| post: | |
| tags: | |
| - recurring-invoices | |
| operationId: create_recurring_invoice | |
| summary: Create a Recurring Invoice | |
| description: Creating a new recurring invoice. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-recurring-invoice-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-recurring-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| get: | |
| tags: | |
| - recurring-invoices | |
| operationId: list_recurring_invoices | |
| summary: List all Recurring Invoice | |
| description: List the details of all recurring invoice. | |
| parameters: | |
| - name: recurrence_name | |
| in: query | |
| description: Unique name for the recurring profile given by the user. Max-length | |
| [100] | |
| required: false | |
| schema: | |
| type: string | |
| example: MonthlyInvoice | |
| - name: item_name | |
| in: query | |
| description: 'Search recurring invoices by item name. Variants: <code>item_name_startswith</code> | |
| and <code>profileitemname_contains</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: item_description | |
| in: query | |
| description: 'Search recurring invoices by item description. Variants: <code>item_description_startswith</code> | |
| and <code>item_description_contains</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: customer_name | |
| in: query | |
| description: Name of the customer to whom the recurring invoice is raised. | |
| required: false | |
| schema: | |
| type: string | |
| example: Sujin Kumar | |
| - name: line_item_id | |
| in: query | |
| description: The line item id | |
| required: false | |
| schema: | |
| type: string | |
| example: '982000000567021' | |
| - name: item_id | |
| in: query | |
| description: Unique string generated for the item for which invoice is to | |
| be sent. | |
| required: false | |
| schema: | |
| type: string | |
| example: '90300000081501' | |
| - name: tax_id | |
| in: query | |
| description: ID of the tax or tax group associated to the recurring invoice. | |
| required: false | |
| schema: | |
| type: string | |
| example: '903000000000356' | |
| - name: notes | |
| in: query | |
| description: A short note for the recurring invoice. | |
| required: false | |
| schema: | |
| type: string | |
| example: Offer for the referral | |
| - name: start_date | |
| in: query | |
| description: The date on which the recurring invoice starts. | |
| required: false | |
| schema: | |
| type: string | |
| example: '2016-06-12' | |
| - name: end_date | |
| in: query | |
| description: The date on which the recurring invoice expires. | |
| required: false | |
| schema: | |
| type: string | |
| example: '2017-06-12' | |
| - name: customer_id | |
| in: query | |
| description: Customer ID of the customer for whom the recurring invoice is | |
| raised. | |
| required: false | |
| schema: | |
| type: string | |
| example: '903000000000099' | |
| - name: status | |
| in: query | |
| description: Status of the recurring invoice. This can be <code>active</code>, | |
| <code>stopped</code> or <code>expired</code>. | |
| required: false | |
| schema: | |
| type: string | |
| example: active | |
| - name: filter_by | |
| in: query | |
| description: 'Filter Recurring invoices by any status or payment expected | |
| date.Allowed Values: <code> Status.All</code>, <code>Status.Active</code>, | |
| <code> Status.Stopped</code>, <code>Status.Expired</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: search_text | |
| in: query | |
| description: Search invoices by invoice number or purchase order or customer | |
| name. Max-length [100] | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sort_column | |
| in: query | |
| required: false | |
| schema: | |
| type: string | |
| example: created_time | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-all-recurring-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| put: | |
| tags: | |
| - recurring-invoices | |
| operationId: update_recurring_invoice_using_custom_field | |
| summary: Update a recurring invoice using a custom field's unique value | |
| description: A custom field will have unique values if it's configured to not | |
| accept duplicate values. Now, you can use that custom field's value to update | |
| a recurring invoice by providing its API name in the X-Unique-Identifier-Key | |
| header and its value in the X-Unique-Identifier-Value header. Based on this | |
| value, the corresponding recurring invoice will be retrieved and updated. | |
| Additionally, there is an optional X-Upsert header. If the X-Upsert header | |
| is true and the custom field's unique value is not found in any of the existing | |
| recurring invoices, a new recurring invoice will be created if the necessary | |
| payload details are available | |
| parameters: | |
| - name: X-Unique-Identifier-Key | |
| in: header | |
| description: Unique CustomField Api Name | |
| required: true | |
| schema: | |
| type: string | |
| example: cf_unique_cf | |
| - name: X-Unique-Identifier-Value | |
| in: header | |
| description: Unique CustomField Value | |
| required: true | |
| schema: | |
| type: string | |
| example: unique Value | |
| - name: X-Upsert | |
| in: header | |
| description: If there is no record is found unique custom field value , will | |
| create new invoice | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-recurring-invoice-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-recurring-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /recurringinvoices/{recurring_invoice_id}: | |
| put: | |
| tags: | |
| - recurring-invoices | |
| operationId: update_recurring_invoice | |
| summary: Update Recurring Invoice | |
| description: Update the recurring invoice. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-recurring-invoice-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-recurring-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| get: | |
| tags: | |
| - recurring-invoices | |
| operationId: get_recurring_invoice | |
| summary: Get a Recurring Invoice | |
| description: Get the details of a recurring invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-recurring-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| delete: | |
| tags: | |
| - recurring-invoices | |
| operationId: delete_recurring_invoice | |
| summary: Delete a Recurring Invoice | |
| description: Delete an existing recurring invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-recurring-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.DELETE | |
| parameters: | |
| - name: recurring_invoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the recurring invoice. | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /recurringinvoices/{recurring_invoice_id}/comments: | |
| get: | |
| tags: | |
| - recurring-invoices | |
| operationId: list_recurring_invoice_history | |
| summary: List Recurring Invoice History | |
| description: Get the complete history and comments of a recurring invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-recurring-invoice-history-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| parameters: | |
| - name: recurring_invoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the recurring invoice. | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /recurringinvoices/{recurring_invoice_id}/status/resume: | |
| post: | |
| tags: | |
| - recurring-invoices | |
| operationId: resume_recurring_invoice | |
| summary: Resume a Recurring Invoice | |
| description: Resume a stopped recurring invoice. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/resume-a-recurring-invoice-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/resume-a-recurring-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: recurring_invoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the recurring invoice. | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /recurringinvoices/{recurring_invoice_id}/status/stop: | |
| post: | |
| tags: | |
| - recurring-invoices | |
| operationId: stop_recurring_invoice | |
| summary: Stop a Recurring Invoice | |
| description: Stop an active recurring invoice. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/stop-a-recurring-invoice-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/stop-a-recurring-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: recurring_invoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the recurring invoice. | |
| example: '90300000072369' | |
| - $ref: '#/components/parameters/organization_id' | |
| /recurringinvoices/{recurring_invoice_id}/templates/{template_id}: | |
| put: | |
| tags: | |
| - recurring-invoices | |
| operationId: update_recurring_invoice_template | |
| summary: Update Recurring Invoice template | |
| description: Update the pdf template associated with the recurring invoice. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-recurring-invoice-template-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-recurring-invoice-template-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| parameters: | |
| - name: recurring_invoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the recurring invoice. | |
| example: '90300000072369' | |
| - name: template_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the recurring invoice template. | |
| example: '90300000001336' | |
| - $ref: '#/components/parameters/organization_id' | |
| /reportingtags: | |
| get: | |
| tags: | |
| - reporting-tags | |
| operationId: get_tags | |
| summary: List of all Reporting Tags | |
| description: Get a list of all reporting tags in the preferred order that you | |
| can set. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| type: object | |
| properties: | |
| reporting_tags: | |
| $ref: '#/components/schemas/list-reporting-tags-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| post: | |
| tags: | |
| - reporting-tags | |
| operationId: create_tag | |
| summary: Create Reporting Tag | |
| description: Create a reporting tag | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-reporting-tag-request' | |
| responses: | |
| '201': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/reporting-tags-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /reportingtags/(\d+)/options/all: | |
| get: | |
| tags: | |
| - reporting-tags | |
| operationId: all_tag_options | |
| summary: Get all Options | |
| description: Get all options for a reporting tag. | |
| parameters: | |
| - name: show_untagged | |
| in: query | |
| description: '''untagged'' will be included in the response if this parameter | |
| is set to true.' | |
| required: false | |
| schema: | |
| type: boolean | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/all_options_response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| - $ref: '#/components/parameters/query_tag_id' | |
| /reportingtags/options: | |
| get: | |
| tags: | |
| - reporting-tags | |
| operationId: get_all_tag_options | |
| summary: Get Reporting Tags Options Detail Page | |
| description: Get the options and its criteria details of a reporting tag. For | |
| each page, you can retrieve only 200 options. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/options_detail_page_response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| - $ref: '#/components/parameters/query_tag_id' | |
| /reportingtags/reorder: | |
| put: | |
| tags: | |
| - reporting-tags | |
| operationId: reorder_tags | |
| summary: Reorder Reporting Tags | |
| description: Reorder the reporting tags in your organization. The order of tags | |
| will be followed in transactions and reports. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| type: object | |
| properties: | |
| tag_ids: | |
| description: List of reporting tag IDs in the desired order | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/tag_id' | |
| example: | |
| - '460000000038080' | |
| - '460000000038081' | |
| - '460000000038082' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| message: | |
| type: string | |
| example: The reporting tags have been reordered successfully. | |
| tags: | |
| $ref: '#/components/schemas/list-reporting-tags-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /reportingtags/{tag_id}: | |
| post: | |
| tags: | |
| - reporting-tags | |
| operationId: mark_default_option | |
| summary: Mark an option as default for a reporting tag | |
| description: Mark an option as the default option or clear default option for | |
| a reporting tag. | |
| parameters: | |
| - name: default_option_id | |
| in: query | |
| description: ID of the option to be marked as default. If this parameter is | |
| not sent or sent empty, the current default option of the tag will be removed. | |
| required: true | |
| schema: | |
| $ref: '#/components/schemas/option_id' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-default_option-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| put: | |
| tags: | |
| - reporting-tags | |
| operationId: update_tag | |
| summary: Update Reporting Tag | |
| description: Update a reporting tag | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-reporting-tag-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/reporting-tags-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| delete: | |
| tags: | |
| - reporting-tags | |
| operationId: delete_tag | |
| summary: Delete a reporting tag | |
| description: Delete a reporting tag. If there are any usages of the reporting | |
| tag in transactions, custom views or workflows, you will not be able to delete | |
| the tag. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| type: object | |
| properties: | |
| message: | |
| type: string | |
| example: The reporting tag has been deleted successfully. | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.DELETE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| - $ref: '#/components/parameters/path_tag_id' | |
| /reportingtags/{tag_id}/active: | |
| post: | |
| tags: | |
| - reporting-tags | |
| operationId: active_tag | |
| summary: Mark Reporting Tag as active | |
| description: Mark a reporting tag as active so that you can use it on entities | |
| which you allowed. A newly created tag will be in draft state. Use this to | |
| mark that tag as ready. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| type: object | |
| properties: | |
| message: | |
| type: string | |
| example: The reporting tag has been activated. | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| - $ref: '#/components/parameters/path_tag_id' | |
| /reportingtags/{tag_id}/criteria: | |
| put: | |
| tags: | |
| - reporting-tags | |
| operationId: update_tag_criteria | |
| summary: Update Reporting Tag - Visibility Conditions | |
| description: Update the visibility conditions (or filter in some places) of | |
| a reporting tag. You can set other tags or location as filters for a tag. | |
| Check our help document to know about the requirements of a tag to be associated | |
| as a filter to another tag. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-criteria-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-criteria-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| - $ref: '#/components/parameters/path_tag_id' | |
| /reportingtags/{tag_id}/inactive: | |
| post: | |
| tags: | |
| - reporting-tags | |
| operationId: inactive_tag | |
| summary: Mark Reporting Tag as inactive | |
| description: Mark a reporting tag as inactive. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| type: object | |
| properties: | |
| message: | |
| type: string | |
| example: The reporting tag has been deactivated. | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| - $ref: '#/components/parameters/path_tag_id' | |
| /reportingtags/{tag_id}/option/(\d+)/active: | |
| post: | |
| tags: | |
| - reporting-tags | |
| operationId: active_tag_option | |
| summary: Mark an option as active | |
| description: Mark a reporting tag's option as active. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| type: object | |
| properties: | |
| message: | |
| type: string | |
| example: The reporting tag option has been activated. | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| - $ref: '#/components/parameters/path_tag_id' | |
| - $ref: '#/components/parameters/path_option_id' | |
| /reportingtags/{tag_id}/option/(\d+)/inactive: | |
| post: | |
| tags: | |
| - reporting-tags | |
| operationId: inactive_tag_option | |
| summary: Mark an option as inactive | |
| description: Mark a reporting tag's option as inactive. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| type: object | |
| properties: | |
| message: | |
| type: string | |
| example: The reporting tag option has been deactivated. | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| - $ref: '#/components/parameters/path_tag_id' | |
| - $ref: '#/components/parameters/path_option_id' | |
| /reportingtags/{tag_id}/options: | |
| put: | |
| tags: | |
| - reporting-tags | |
| operationId: update_tag_options | |
| summary: Update Reporting Tag Options | |
| description: Create, update or delete the options of a reporting tag. Reorder | |
| and arrange them in an hierarchical structure as per your organization requirements. | |
| <br><b>NOTE:</b> <br><ol> <li>An option cannot be a child option beyond five | |
| hierarchical level.</li> <li>The overall children of an option cannot exceed | |
| 500 options.</li></ol> | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-options-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-options-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| - $ref: '#/components/parameters/path_tag_id' | |
| /retainerinvoices: | |
| post: | |
| tags: | |
| - retainer-invoices | |
| operationId: create_retainer_invoice | |
| summary: Create a retainerinvoice | |
| description: Create a retainer invoice for your customer. | |
| parameters: | |
| - name: ignore_auto_number_generation | |
| in: query | |
| description: Ignore auto invoice number generation for this invoice. This | |
| mandates the invoice number. Allowed values <code>true</code> and <code>false</code> | |
| required: false | |
| schema: | |
| type: boolean | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-retainerinvoice-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-retainerinvoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| get: | |
| tags: | |
| - retainer-invoices | |
| operationId: list_retainer_invoices | |
| summary: List a retainer invoices | |
| description: List all retainer invoices with pagination. | |
| parameters: | |
| - name: print | |
| in: query | |
| description: Print the exported pdf. | |
| required: false | |
| schema: | |
| type: boolean | |
| - name: sort_column | |
| in: query | |
| description: 'Sort retainer invoices.Allowed Values: <code>customer_name</code>, | |
| <code>retainer invoice_number</code>, <code>date</code>, <code> due_date</code>, | |
| <code>total</code>, <code>balance</code> and <code>created_time</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: created_time | |
| - name: filter_by | |
| in: query | |
| description: 'Filter invoices by any status or payment expected date.Allowed | |
| Values: <code> Status.All</code>, <code>Status.Sent</code>, <code> Status.Draft</code>, | |
| <code>Status.OverDue</code>, <code>Status.Paid</code>, <code>Status.Void</code>, | |
| <code>Status.Unpaid</code>, <code>Status.PartiallyPaid</code>,<code> Status.Viewed</code> | |
| and <code>Date.PaymentExpectedDate</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sort_order | |
| in: query | |
| description: The order for sorting | |
| required: false | |
| schema: | |
| type: string | |
| example: D | |
| - name: page | |
| in: query | |
| description: Number of pages | |
| required: false | |
| schema: | |
| type: integer | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-a-retainer-invoices-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /retainerinvoices/templates: | |
| get: | |
| tags: | |
| - retainer-invoices | |
| operationId: list_retainer_invoice_templates | |
| summary: List retainer invoice templates | |
| description: Get all retainer invoice pdf templates. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-retainer-invoice-templates-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /retainerinvoices/{reatinerinvoice_id}/approve: | |
| post: | |
| tags: | |
| - retainer-invoices | |
| operationId: approve_retainer_invoice | |
| summary: Approve a retainer invoice. | |
| description: Approve a retainer invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/approve-a-retainer-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: reatinerinvoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the retainer invoice. | |
| example: '982000000567114' | |
| - $ref: '#/components/parameters/organization_id' | |
| /retainerinvoices/{reatinerinvoice_id}/status/draft: | |
| post: | |
| tags: | |
| - retainer-invoices | |
| operationId: mark_retainer_invoice_draft | |
| summary: Mark as draft | |
| description: 'Mark a voided retainer invoice as draft. ' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-as-draft-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: reatinerinvoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the retainer invoice. | |
| example: '982000000567114' | |
| - $ref: '#/components/parameters/organization_id' | |
| /retainerinvoices/{reatinerinvoice_id}/submit: | |
| post: | |
| tags: | |
| - retainer-invoices | |
| operationId: submit_retainer_invoice | |
| summary: Submit a retainer invoice for approval | |
| description: Submit a retainer invoice for approval. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/submit-a-retainer-invoice-for-approval-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: reatinerinvoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the retainer invoice. | |
| example: '982000000567114' | |
| - $ref: '#/components/parameters/organization_id' | |
| /retainerinvoices/{retainerinvoice_id}: | |
| put: | |
| tags: | |
| - retainer-invoices | |
| operationId: update_retainer_invoice | |
| summary: update a retainerinvoice | |
| description: Update an existing invoice. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-retainerinvoice-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-retainerinvoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| get: | |
| tags: | |
| - retainer-invoices | |
| operationId: get_retainer_invoice | |
| summary: Get a retainer invoice | |
| description: Get the details of a retainer invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-retainer-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| delete: | |
| tags: | |
| - retainer-invoices | |
| operationId: delete_retainer_invoice | |
| summary: Delete a retainer invoice | |
| description: Delete an existing retainer invoice. Invoices which have payment | |
| or credits note applied cannot be deleted. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-retainer-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.DELETE | |
| parameters: | |
| - name: retainerinvoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the retainer invoice. | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /retainerinvoices/{retainerinvoice_id}/address/billing: | |
| put: | |
| tags: | |
| - retainer-invoices | |
| operationId: update_retainer_invoice_billing_address | |
| summary: Update billing address | |
| description: Updates the billing address for this retainer invoice alone. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-billing-address-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-billing-address-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| parameters: | |
| - name: retainerinvoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the retainer invoice. | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /retainerinvoices/{retainerinvoice_id}/attachment: | |
| get: | |
| tags: | |
| - retainer-invoices | |
| operationId: get_retainer_invoice_attachment | |
| summary: Get a retainer invoice attachment | |
| description: Returns the file attached to the retainer invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-retainer-invoice-attachment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| post: | |
| tags: | |
| - retainer-invoices | |
| operationId: add_retainer_invoice_attachment | |
| summary: Add attachment to a retainer invoice | |
| description: Attach a file to an invoice. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-attachment-to-a-retainer-invoice-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-attachment-to-a-retainer-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: retainerinvoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the retainer invoice. | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /retainerinvoices/{retainerinvoice_id}/comments: | |
| get: | |
| tags: | |
| - retainer-invoices | |
| operationId: list_retainer_invoice | |
| summary: List retainer invoice comments & history | |
| description: Get the complete history and comments of a retainer invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-retainer-invoice-comments-and-history-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| post: | |
| tags: | |
| - retainer-invoices | |
| operationId: add_retainer_invoice_comment | |
| summary: Add comment | |
| description: Add a comment for a retainer invoice. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-comment-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: retainerinvoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the retainer invoice. | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /retainerinvoices/{retainerinvoice_id}/comments/{comment_id}: | |
| delete: | |
| tags: | |
| - retainer-invoices | |
| operationId: delete_retainer_invoice_comment | |
| summary: Delete a comment | |
| description: Delete a retainer invoice comment. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.DELETE | |
| put: | |
| tags: | |
| - retainer-invoices | |
| operationId: update_retainer_invoice_comment | |
| summary: Update comment | |
| description: Update an existing comment of a retainer invoice. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-comment-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| parameters: | |
| - name: retainerinvoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the retainer invoice. | |
| example: 982000000567114 | |
| - name: comment_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the comment. | |
| example: 982000000567019 | |
| - $ref: '#/components/parameters/organization_id' | |
| /retainerinvoices/{retainerinvoice_id}/documents/{document_id}: | |
| delete: | |
| tags: | |
| - retainer-invoices | |
| operationId: delete_retainer_invoice_attachment | |
| summary: Delete an attachment | |
| description: Delete the file attached to the retainer invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-an-attachment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.DELETE | |
| parameters: | |
| - name: retainerinvoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the retainer invoice. | |
| example: 982000000567114 | |
| - name: document_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the retainer invoice document. | |
| example: 982000000567115 | |
| - $ref: '#/components/parameters/organization_id' | |
| /retainerinvoices/{retainerinvoice_id}/email: | |
| post: | |
| tags: | |
| - retainer-invoices | |
| operationId: email_retainer_invoice | |
| summary: Email a retainer invoice | |
| description: Email a retainer invoice to the customer. Input json string is | |
| not mandatory. If input json string is empty, mail will be send with default | |
| mail content. | |
| parameters: | |
| - name: send_customer_statement | |
| in: query | |
| description: Send customer statement pdf a with email. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: ' ' | |
| - name: send_attachment | |
| in: query | |
| description: Send the retainer invoice attachment a with the email. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: ' ' | |
| - name: attachments | |
| in: query | |
| description: Files to be attached to the email | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-a-retainer-invoice-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-a-retainer-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| get: | |
| tags: | |
| - retainer-invoices | |
| operationId: get_retainer_invoice_email | |
| summary: Get retainer invoice email content | |
| description: Get the email content of a retainer invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-retainer-invoice-email-content-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| parameters: | |
| - name: retainerinvoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the retainer invoice. | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /retainerinvoices/{retainerinvoice_id}/status/sent: | |
| post: | |
| tags: | |
| - retainer-invoices | |
| operationId: mark_retainer_invoice_sent | |
| summary: Mark a retainer invoice as sent | |
| description: Mark a draft retainer invoice as sent. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-a-retainer-invoice-as-sent-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: retainerinvoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the retainer invoice. | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /retainerinvoices/{retainerinvoice_id}/status/void: | |
| post: | |
| tags: | |
| - retainer-invoices | |
| operationId: mark_retainer_invoice_void | |
| summary: Void a retainer invoice | |
| description: Mark an invoice status as void. Upon voiding, the payments and | |
| credits associated with the retainer invoices will be unassociated and will | |
| be under customer credits. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/void-a-retainer-invoice-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| parameters: | |
| - name: retainerinvoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the retainer invoice. | |
| example: 982000000567114 | |
| - $ref: '#/components/parameters/organization_id' | |
| /retainerinvoices/{retainerinvoice_id}/templates/{template_id}: | |
| put: | |
| tags: | |
| - retainer-invoices | |
| operationId: update_retainer_invoice_template | |
| summary: Update retainer invoice template | |
| description: Update the pdf template associated with the retainer invoice. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-retainer-invoice-template-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| parameters: | |
| - name: retainerinvoice_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the retainer invoice. | |
| example: 982000000567114 | |
| - name: template_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the retainer invoice template. | |
| example: 982000000000143 | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesorder/{salesorder_id}/customfields: | |
| put: | |
| tags: | |
| - sales-order | |
| operationId: update_salesorder_customfields | |
| summary: Update custom field in existing salesorders | |
| description: Update the value of the custom field in existing salesorders. | |
| parameters: | |
| - name: salesorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the sales order. | |
| schema: | |
| type: string | |
| example: '460000000039129' | |
| - $ref: '#/components/parameters/organization_id' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/custom_fields' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-salesorder-customfield-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.UPDATE | |
| /salesorders: | |
| post: | |
| tags: | |
| - sales-order | |
| operationId: create_sales_order | |
| summary: Create a sales order | |
| description: Create a sales order for your customer. | |
| parameters: | |
| - name: ignore_auto_number_generation | |
| in: query | |
| description: Ignore auto sales order number generation for this sales order. | |
| This mandates the sales order number. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| - name: can_send_in_mail | |
| in: query | |
| description: Can the file be sent in mail. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| - name: totalFiles | |
| in: query | |
| description: Total number of files. | |
| required: false | |
| schema: | |
| type: integer | |
| example: 0 | |
| - name: doc | |
| in: query | |
| description: Document that is to be attached | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-sales-order-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-sales-order-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.CREATE | |
| get: | |
| tags: | |
| - sales-order | |
| operationId: list_sales_orders | |
| summary: List sales orders | |
| description: List all sales orders. | |
| parameters: | |
| - name: sort_column | |
| in: query | |
| description: Specify the column field for sorting sales order results. Available | |
| options include <code>customer_name</code>, <code>salesorder_number</code>, | |
| <code>shipment_date</code>, <code>last_modified_time</code>, <code>reference_number</code>, | |
| <code>total</code>, <code>date</code>, and <code>created_time</code>. | |
| required: false | |
| schema: | |
| type: string | |
| example: created_time | |
| - name: search_text | |
| in: query | |
| description: General search parameter for cross-field text matching across | |
| sales order number, reference number, and customer name fields. Enables | |
| unified search functionality for quick order identification and customer | |
| order lookup operations. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: filter_by | |
| in: query | |
| description: 'Filter sales order by status. Allowed Values: <code>Status.All</code>, | |
| <code>Status.Open</code>, <code>Status.Draft</code>, <code>Status.OverDue</code>, | |
| <code>Status.PartiallyInvoiced</code>, <code>Status.Invoiced</code>, <code>Status.Void</code> | |
| and <code>Status.Closed</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: salesorder_number | |
| in: query | |
| description: 'Filter sales orders by sales order number using various matching | |
| operators. Available variants include <code>salesorder_number_startswith</code>, | |
| <code>salesorder_number_not_in</code>, <code>salesorder_number_in</code>, | |
| and <code>salesorder_number_contains</code>. Maximum search length: 100 | |
| characters.' | |
| required: false | |
| schema: | |
| type: string | |
| example: SO-001 | |
| - name: item_name | |
| in: query | |
| description: 'Filter sales orders by line item name using various matching | |
| operators. Available variants include <code>item_name_startswith</code>, | |
| <code>item_name_not_in</code>, <code>item_name_in</code>, and <code>item_name_contains</code>. | |
| Maximum search length: 100 characters.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: item_id | |
| in: query | |
| description: Filter sales orders by specific line item identifier. Retrieves | |
| all sales orders containing a particular product or service item based on | |
| its unique identifier for inventory tracking and item-based reporting purposes. | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000017088' | |
| - name: item_description | |
| in: query | |
| description: 'Filter sales orders by line item description text using various | |
| matching operators. Available variants include <code>item_description_startswith</code>, | |
| <code>item_description_not_in</code>, <code>item_description_in</code>, | |
| and <code>item_description_contains</code>. Maximum search length: 100 characters.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: reference_number | |
| in: query | |
| description: Filter sales orders by external reference number using various | |
| matching operators. Available variants include <code>reference_number_startswith</code>, | |
| <code>reference_number_not_in</code>, <code>reference_number_in</code>, | |
| and <code>reference_number_contains</code>. | |
| required: false | |
| schema: | |
| type: string | |
| example: REF-001 | |
| - name: customer_name | |
| in: query | |
| description: 'Filter sales orders by customer name using various matching | |
| operators. Available variants include <code>customer_name_startswith</code>, | |
| <code>customer_name_not_in</code>, <code>customer_name_in</code>, and <code>customer_name_contains</code>. | |
| Maximum search length: 100 characters.' | |
| required: false | |
| schema: | |
| type: string | |
| example: SAF Instruments Inc | |
| - name: total | |
| in: query | |
| description: Filter sales orders by total amount using various range operators. | |
| Available variants include <code>total_start</code>, <code>total_end</code>, | |
| <code>total_less_than</code>, <code>total_less_equals</code>, <code>total_greater_than</code>, | |
| and <code>total_greater_equals</code>. | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| example: 12400 | |
| - name: date | |
| in: query | |
| description: 'Filter sales orders by creation date using various date range | |
| operators. Available variants include <code>date_start</code>, <code>date_end</code>, | |
| <code>date_before</code>, and <code>date_after</code>. Default date format: | |
| <code>yyyy-mm-dd</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '2014-07-28' | |
| - name: shipment_date | |
| in: query | |
| description: 'Search sales order by sales order shipment date. Variants: <code>shipment_date_start</code>, | |
| <code>shipment_date_end</code>, <code>shipment_date_before</code> and <code>shipment_date_after</code>. | |
| Default date format : <code>yyyy-mm-dd</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: status | |
| in: query | |
| description: 'Search sales order by sales order status. Allowed Values: <code>draft</code>, | |
| <code>open</code>, <code>invoiced</code>, <code>partially_invoiced</code>, | |
| <code>void</code> and <code>overdue</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: open | |
| - name: customer_id | |
| in: query | |
| description: Filter sales orders by specific customer identifier. Retrieves | |
| all sales orders associated with a particular customer account for customer | |
| relationship management, order history tracking, and customer-specific reporting | |
| and analysis purposes. | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000017138' | |
| - name: salesperson_id | |
| in: query | |
| description: Filter sales orders by specific sales representative identifier. | |
| Retrieves all sales orders assigned to a particular salesperson for performance | |
| tracking, commission calculations, sales territory management, and individual | |
| sales reporting purposes. | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000000097' | |
| - name: salesorder_ids | |
| in: query | |
| description: 'ID''s of the salesorder [Comma seperated values] . <code>Maximum | |
| Length : 200</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: 460108000000072000 | |
| - name: zcrm_potential_id | |
| in: query | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000033001' | |
| - name: last_modified_time | |
| in: query | |
| description: Last Modified time of the Sales Order | |
| required: false | |
| schema: | |
| type: string | |
| example: 2014-08-25T11:23:26+0530 | |
| - name: accept | |
| in: query | |
| description: 'Get the details of a particular sales order in formats such | |
| as json/ pdf/ html. Default format is json. Allowed Values: <code>json</code>, | |
| <code>csv</code> , <code>xml</code>, <code>xls</code>, <code>xlsx</code>, | |
| <code>pdf</code>, <code>jhtml</code> and <code>html</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: print | |
| in: query | |
| description: Print the exported pdf. <code> It will be used when accept = | |
| pdf and atleast one value in salesorder_ids </code> | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| - name: customview_id | |
| in: query | |
| description: ID of the customview | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000004000597' | |
| - name: zcrm_potential_id | |
| in: query | |
| description: Potential ID of a Deal in CRM. | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| example: 460000000026049 | |
| - name: page | |
| in: query | |
| description: Specify the page number for paginated results retrieval. Controls | |
| which subset of sales order records to return, enabling efficient data handling | |
| for large result sets. Default value is 1 for the first page. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Specify the maximum number of sales order records to return per | |
| page. Controls result set size for optimal performance, memory usage, and | |
| user experience. Default value is 200 records per page. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-sales-orders-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.READ | |
| put: | |
| tags: | |
| - sales-order | |
| operationId: update_sales_order_using_custom_field | |
| summary: Update a sales order using a custom field's unique value | |
| description: A custom field will have unique values if it's configured to not | |
| accept duplicate values. Now, you can use that custom field's value to update | |
| a sales order by providing its API name in the X-Unique-Identifier-Key header | |
| and its value in the X-Unique-Identifier-Value header. Based on this value, | |
| the corresponding sales order will be retrieved and updated. Additionally, | |
| there is an optional X-Upsert header. If the X-Upsert header is true and the | |
| custom field's unique value is not found in any of the existing sales orders, | |
| a new sales order will be created if the necessary payload details are available | |
| parameters: | |
| - name: X-Unique-Identifier-Key | |
| in: header | |
| description: Unique CustomField Api Name | |
| required: true | |
| schema: | |
| type: string | |
| example: cf_unique_cf | |
| - name: X-Unique-Identifier-Value | |
| in: header | |
| description: Unique CustomField Value | |
| required: true | |
| schema: | |
| type: string | |
| example: unique Value | |
| - name: X-Upsert | |
| in: header | |
| description: If there is no record is found unique custom field value , will | |
| create new invoice | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-sales-order-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-sales-order-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.UPDATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesorders/pdf: | |
| get: | |
| tags: | |
| - sales-order | |
| operationId: bulk_export_sales_orders_as_pdf | |
| summary: Bulk export sales orders | |
| description: Maximum of 25 sales orders can be exported in a single pdf. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/bulk-export-sales-orders-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesorders/print: | |
| get: | |
| tags: | |
| - sales-order | |
| operationId: bulk_print_sales_orders | |
| summary: Bulk print sales orders | |
| description: Export sales orders as pdf and print them. Maximum of 25 sales | |
| orders can be printed. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/bulk-print-sales-orders-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesorders/templates: | |
| get: | |
| tags: | |
| - sales-order | |
| operationId: list_sales_order_templates | |
| summary: List sales order templates | |
| description: Get all sales order pdf templates. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-sales-order-templates-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesorders/{salesorder_id}: | |
| put: | |
| tags: | |
| - sales-order | |
| operationId: update_sales_order | |
| summary: Update a sales order | |
| description: Update an existing sales order. To delete a line item just remove | |
| it from the line_items list. | |
| parameters: | |
| - name: ignore_auto_number_generation | |
| in: query | |
| description: Ignore auto sales order number generation for this sales order. | |
| This mandates the sales order number. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| - name: can_send_in_mail | |
| in: query | |
| description: Can the file be sent in mail. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| - name: totalFiles | |
| in: query | |
| description: Total number of files. | |
| required: false | |
| schema: | |
| type: integer | |
| example: 0 | |
| - name: doc | |
| in: query | |
| description: Document that is to be attached | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-sales-order-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-sales-order-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.UPDATE | |
| get: | |
| tags: | |
| - sales-order | |
| operationId: get_sales_order | |
| summary: Get a sales order | |
| description: Get the details of a sales order. | |
| parameters: | |
| - name: print | |
| in: query | |
| description: Print the exported pdf. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| - name: accept | |
| in: query | |
| description: 'Get the details of a particular sales order in formats such | |
| as json/ pdf/ html. Default format is json. Allowed Values: <code>json</code>, | |
| <code>csv</code> , <code>xml</code>, <code>xls</code>, <code>xlsx</code>, | |
| <code>pdf</code>, <code>jhtml</code> and <code>html</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-sales-order-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.READ | |
| delete: | |
| tags: | |
| - sales-order | |
| operationId: delete_sales_order | |
| summary: Delete a sales order | |
| description: Delete an existing sales order. Invoiced sales order cannot be | |
| deleted. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-sales-order-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.DELETE | |
| parameters: | |
| - name: salesorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the sales order. | |
| schema: | |
| type: string | |
| example: '460000000039129' | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesorders/{salesorder_id}/address/billing: | |
| put: | |
| tags: | |
| - sales-order | |
| operationId: update_sales_order_billing_address | |
| summary: Update billing address | |
| description: Updates the billing address for this sales order alone. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-billing-address-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-billing-address-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.UPDATE | |
| parameters: | |
| - name: salesorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the sales order. | |
| schema: | |
| type: string | |
| example: '460000000039129' | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesorders/{salesorder_id}/address/shipping: | |
| put: | |
| tags: | |
| - sales-order | |
| operationId: update_sales_order_shipping_address | |
| summary: Update shipping address | |
| description: Updates the shipping address for this sales order alone. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-shipping-address-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-shipping-address-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.UPDATE | |
| parameters: | |
| - name: salesorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the sales order. | |
| schema: | |
| type: string | |
| example: '460000000039129' | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesorders/{salesorder_id}/approve: | |
| post: | |
| tags: | |
| - sales-order | |
| operationId: approve_sales_order | |
| summary: Approve a sales order. | |
| description: Approve a sales order. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/approve-a-sales-order-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.CREATE | |
| parameters: | |
| - name: salesorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the sales order. | |
| schema: | |
| type: string | |
| example: '460000000039129' | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesorders/{salesorder_id}/attachment: | |
| get: | |
| tags: | |
| - sales-order | |
| operationId: get_sales_order_attachment | |
| summary: Get a sales order attachment | |
| description: Returns the file attached to the sales order. | |
| parameters: | |
| - name: preview | |
| in: query | |
| description: Check if preview of the Sales Order is required | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| - name: inline | |
| in: query | |
| description: Check if inline response is required | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-sales-order-attachment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.READ | |
| post: | |
| tags: | |
| - sales-order | |
| operationId: add_sales_order_attachment | |
| summary: Add attachment to a sales order | |
| description: Attach a file to a sales order. | |
| parameters: | |
| - name: attachment | |
| in: query | |
| description: The file that is to be added as an Attachment in the Sales Order | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| - name: can_send_in_mail | |
| in: query | |
| description: Can the file be sent in mail. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| - name: doc | |
| in: query | |
| description: Document that is to be attached | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| - name: totalFiles | |
| in: query | |
| description: Total number of files. | |
| required: false | |
| schema: | |
| type: integer | |
| example: 0 | |
| - name: document_ids | |
| in: query | |
| description: ID's of the document | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-attachment-to-a-sales-order-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.CREATE | |
| put: | |
| tags: | |
| - sales-order | |
| operationId: update_sales_order_attachment_preference | |
| summary: Update attachment preference | |
| description: Set whether you want to send the attached file while emailing the | |
| sales order. | |
| parameters: | |
| - name: can_send_in_mail | |
| in: query | |
| description: Can the file be sent in mail. | |
| required: true | |
| schema: | |
| type: boolean | |
| example: true | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-attachment-preference-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.UPDATE | |
| delete: | |
| tags: | |
| - sales-order | |
| operationId: delete_sales_order_attachment | |
| summary: Delete an attachment | |
| description: Delete the file attached to the sales order. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-an-attachment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.DELETE | |
| parameters: | |
| - name: salesorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the sales order. | |
| schema: | |
| type: string | |
| example: '460000000039129' | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesorders/{salesorder_id}/comments: | |
| get: | |
| tags: | |
| - sales-order | |
| operationId: list_sales_order_comments | |
| summary: List sales order comments & history | |
| description: Get the complete history and comments of sales order. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-sales-order-comments-and-history-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.READ | |
| post: | |
| tags: | |
| - sales-order | |
| operationId: add_sales_order_comment | |
| summary: Add comment | |
| description: Add a comment for a sales order. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-comment-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.CREATE | |
| parameters: | |
| - name: salesorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the sales order. | |
| schema: | |
| type: string | |
| example: '460000000039129' | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesorders/{salesorder_id}/comments/{comment_id}: | |
| put: | |
| tags: | |
| - sales-order | |
| operationId: update_sales_order_comment | |
| summary: Update comment | |
| description: Update existing comment of a sales order. | |
| parameters: | |
| - name: comment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the comment. | |
| schema: | |
| type: string | |
| example: '460000000048023' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-comment-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.UPDATE | |
| delete: | |
| tags: | |
| - sales-order | |
| operationId: delete_sales_order_comment | |
| summary: Delete a comment | |
| description: Delete a sales order comment. | |
| parameters: | |
| - name: comment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the comment. | |
| schema: | |
| type: string | |
| example: '460000000048023' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.DELETE | |
| parameters: | |
| - name: salesorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the sales order. | |
| schema: | |
| type: string | |
| example: '460000000039129' | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesorders/{salesorder_id}/email: | |
| post: | |
| tags: | |
| - sales-order | |
| operationId: email_sales_order | |
| summary: Email a sales order | |
| description: Email a sales order to the customer. Input json string is not mandatory. | |
| If input json string is empty, mail will be send with default mail content. | |
| parameters: | |
| - name: salesorder_id | |
| in: query | |
| description: ID of the Sales Order | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000039129' | |
| - name: attachments | |
| in: query | |
| description: Attachments of the Sales Order | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| - name: send_attachment | |
| in: query | |
| description: Send the sales order attachment a with the email. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| - name: file_name | |
| in: query | |
| description: Name of the file. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-a-sales-order-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-a-sales-order-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.CREATE | |
| get: | |
| tags: | |
| - sales-order | |
| operationId: get_sales_order_email | |
| summary: Get sales order email content | |
| description: Get the email content of a sales order. | |
| parameters: | |
| - name: email_template_id | |
| in: query | |
| description: Get the email content based on a specific email template. If | |
| this param is not inputted, then the content will be based on the email | |
| template associated with the customer. If no template is associated with | |
| the customer, then default template will be used. | |
| required: false | |
| schema: | |
| type: string | |
| example: 460000000001287 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-sales-order-email-content-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.READ | |
| parameters: | |
| - name: salesorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the sales order. | |
| schema: | |
| type: string | |
| example: '460000000039129' | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesorders/{salesorder_id}/status/open: | |
| post: | |
| tags: | |
| - sales-order | |
| operationId: mark_sales_order_as_open | |
| summary: Mark a sales order as open | |
| description: Mark a draft sales order as open. | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-a-sales-order-as-open-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.CREATE | |
| parameters: | |
| - name: salesorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the sales order. | |
| schema: | |
| type: string | |
| example: '460000000039129' | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesorders/{salesorder_id}/status/void: | |
| post: | |
| tags: | |
| - sales-order | |
| operationId: mark_sales_order_as_void | |
| summary: Mark a sales order as void | |
| description: Mark a sales order as void. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-a-sales-order-as-void-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-a-sales-order-as-void-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.CREATE | |
| parameters: | |
| - name: salesorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the sales order. | |
| schema: | |
| type: string | |
| example: '460000000039129' | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesorders/{salesorder_id}/submit: | |
| post: | |
| tags: | |
| - sales-order | |
| operationId: submit_sales_order | |
| summary: Submit a sales order for approval | |
| description: Submit a sales order for approval. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/submit-a-sales-order-for-approval-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.CREATE | |
| parameters: | |
| - name: salesorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the sales order. | |
| schema: | |
| type: string | |
| example: '460000000039129' | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesorders/{salesorder_id}/substatus/{status_code}: | |
| post: | |
| tags: | |
| - sales-order | |
| operationId: update_sales_order_sub_status | |
| summary: Update a sales order sub status | |
| description: Update a sales order sub status. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Sales Order status updated successfully. | |
| readOnly: true | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.CREATE | |
| parameters: | |
| - name: salesorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the sales order. | |
| schema: | |
| type: string | |
| example: '460000000039129' | |
| - name: status_code | |
| in: path | |
| required: true | |
| description: Unique code of the status of a sales order. | |
| schema: | |
| type: string | |
| example: cs_openshi | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesorders/{salesorder_id}/templates/{template_id}: | |
| put: | |
| tags: | |
| - sales-order | |
| operationId: update_sales_order_template | |
| summary: Update sales order template | |
| description: Update the pdf template associated with the sales order. | |
| parameters: | |
| - name: template_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the sales order template. | |
| schema: | |
| type: string | |
| example: '460000000021001' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-sales-order-template-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.salesorders.UPDATE | |
| parameters: | |
| - name: salesorder_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the sales order. | |
| schema: | |
| type: string | |
| example: '460000000039129' | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesreceipts: | |
| post: | |
| tags: | |
| - sales-receipt | |
| operationId: create_sales_receipt | |
| summary: Create a sales receipt | |
| description: Create a sales receipt for immediate payment transactions. | |
| parameters: | |
| - name: ignore_auto_number_generation | |
| in: query | |
| description: Ignore auto sales receipt number generation for this sales receipt. | |
| This mandates the sales receipt number. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| - name: can_send_in_mail | |
| in: query | |
| description: Send the sales receipt to customer via email. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-sales-receipt-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-sales-receipt-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| get: | |
| tags: | |
| - sales-receipt | |
| operationId: list_sales_receipts | |
| summary: List sales receipts | |
| description: List all sales receipts. | |
| parameters: | |
| - name: receipt_number | |
| in: query | |
| description: Search receipt by receipt number. Filters receipts based on their | |
| unique identifier. Supports <code>receipt_number_startswith</code> and <code>receipt_number_contains</code> | |
| variants. Maximum length is 100 characters. Useful for finding specific | |
| receipts or receipts with similar numbering patterns. | |
| required: false | |
| schema: | |
| type: string | |
| example: INV-00003 | |
| - name: item_name | |
| in: query | |
| description: Search receipt by item name. Supports <code>item_name_startswith</code> | |
| and <code>item_name_contains</code> variants. Maximum length is 100 characters. | |
| required: false | |
| schema: | |
| type: string | |
| example: Hard Drive | |
| - name: sort_column | |
| in: query | |
| description: Specify the column field for sorting sales receipt results. Available | |
| options include <code>customer_name</code>, <code>receipt_number</code>, | |
| <code>date</code>, <code>total</code>, and <code>created_time</code>. | |
| required: false | |
| schema: | |
| type: string | |
| example: created_time | |
| - name: filter_by | |
| in: query | |
| description: 'Filter sales receipts by status. Allowed Values: <code>ThisWeek</code>, | |
| <code>ThisMonth</code>, <code>ThisQuarter</code>, <code>ThisYear</code>,<code>PreviousDay</code>, | |
| <code>PreviousWeek</code>, <code>PreviousMonth</code>, <code>PreviousQuarter</code>, | |
| <code>PreviousYear</code>, <code>Status.All</code>, <code>Status.Draft</code>, | |
| <code>Status.Sent</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: customer_id | |
| in: query | |
| description: Filter sales receipts by specific customer identifier. | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000017138' | |
| - name: date | |
| in: query | |
| description: 'Filter sales receipts by date. Available variants include <code>date_start</code>, | |
| <code>date_end</code>, <code>date_before</code>, and <code>date_after</code>. | |
| Default date format: <code>yyyy-mm-dd</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '2014-07-28' | |
| - name: total | |
| in: query | |
| description: Filter sales receipts by total amount using various range operators. | |
| Available variants include <code>total_start</code>, <code>total_end</code>, | |
| <code>total_less_than</code>, <code>total_greater_than</code>. | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| example: 1000 | |
| - name: page | |
| in: query | |
| description: Specify the page number for paginated results retrieval. Default | |
| value is 1 for the first page. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Specify the maximum number of sales receipt records to return | |
| per page. Default value is 200 records per page. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-sales-receipts-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesreceipts/{sales_receipt_id}: | |
| put: | |
| tags: | |
| - sales-receipt | |
| operationId: update_sales_receipt | |
| summary: Update a sales receipt | |
| description: Update an existing sales receipt. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-sales-receipt-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-sales-receipt-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.UPDATE | |
| get: | |
| tags: | |
| - sales-receipt | |
| operationId: get_sales_receipt | |
| summary: Get a sales receipt | |
| description: Get the details of a sales receipt. | |
| parameters: | |
| - name: accept | |
| in: query | |
| description: 'Get the details of a particular sales receipt in formats such | |
| as json/ pdf/ html. Default format is json. Allowed Values: <code>json</code>, | |
| <code>pdf</code>, <code>html</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-sales-receipt-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.READ | |
| delete: | |
| tags: | |
| - sales-receipt | |
| operationId: delete_sales_receipt | |
| summary: Delete a sales receipt | |
| description: Delete an existing sales receipt. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-sales-receipt-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.DELETE | |
| parameters: | |
| - name: sales_receipt_id | |
| in: path | |
| required: true | |
| schema: | |
| type: string | |
| example: '460000000039129' | |
| - $ref: '#/components/parameters/organization_id' | |
| /salesreceipts/{sales_receipt_id}/email: | |
| post: | |
| tags: | |
| - sales-receipt | |
| operationId: email_sales_receipt | |
| summary: Email a sales receipt | |
| description: Email a sales receipt to the customer. | |
| parameters: | |
| - name: attach_pdf | |
| in: query | |
| description: Send the sales receipt pdf with the email. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-a-sales-receipt-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-a-sales-receipt-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.invoices.CREATE | |
| /settings/currencies: | |
| post: | |
| tags: | |
| - currency | |
| operationId: create_currency | |
| summary: Create a Currency | |
| description: Create a currency for transaction. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-currency-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-currency-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| get: | |
| tags: | |
| - currency | |
| operationId: list_currencies | |
| summary: List Currencies | |
| description: Get list of currencies configured. | |
| parameters: | |
| - name: filter_by | |
| in: query | |
| description: 'Filter currencies excluding base currency. Allowed Values: <code>Currencies.ExcludeBaseCurrency</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-currencies-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /settings/currencies/{currency_id}: | |
| put: | |
| tags: | |
| - currency | |
| operationId: update_currency | |
| summary: Update a Currency | |
| description: Update the details of a currency. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-currency-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-currency-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| get: | |
| tags: | |
| - currency | |
| operationId: get_currency | |
| summary: Get a Currency | |
| description: Get the details of a currency. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-currency-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| delete: | |
| tags: | |
| - currency | |
| operationId: delete_currency | |
| summary: Delete a currency | |
| description: Delete a currency. Currency that is associated to transactions | |
| cannot be deleted. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-currency-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.DELETE | |
| parameters: | |
| - name: currency_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the currency. | |
| example: '982000000004012' | |
| - $ref: '#/components/parameters/organization_id' | |
| /settings/currencies/{currency_id}/exchangerates: | |
| get: | |
| tags: | |
| - currency | |
| operationId: list_exchange_rates | |
| summary: List exchange rates | |
| description: List of exchange rates configured for the currency. | |
| parameters: | |
| - name: from_date | |
| in: query | |
| description: Returns the exchange rate details from the given date or from | |
| previous closest match in the absence of the exchange rate on the given | |
| date. | |
| required: false | |
| schema: | |
| type: string | |
| example: '2017-01-02' | |
| - name: is_current_date | |
| in: query | |
| description: To return the exchange rate only if available for current date. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| - name: sort_column | |
| in: query | |
| description: 'Sorts the exchange rate according to this column. Allowed Values | |
| : <code>effective_date</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-exchange-rates-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| post: | |
| tags: | |
| - currency | |
| operationId: create_exchange_rate | |
| summary: Create an exchange rate | |
| description: Create an exchange rate for the specified currency. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-an-exchange-rate-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-an-exchange-rate-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| parameters: | |
| - name: currency_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the currency. | |
| schema: | |
| type: string | |
| example: '982000000004012' | |
| - $ref: '#/components/parameters/organization_id' | |
| /settings/currencies/{currency_id}/exchangerates/{exchange_rate_id}: | |
| get: | |
| tags: | |
| - currency | |
| operationId: get_exchange_rate | |
| summary: Get an exchange rate. | |
| description: Get the details of an exchange rate that has been asscoiated to | |
| the currency. | |
| parameters: | |
| - name: exchange_rate_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the exchange rate. | |
| schema: | |
| type: string | |
| example: '460000000038035' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-an-exchange-rate-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| put: | |
| tags: | |
| - currency | |
| operationId: update_exchange_rate | |
| summary: Update an exchange rate | |
| description: Update the details of exchange rate for a currency. | |
| parameters: | |
| - name: exchange_rate_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the exchange rate. | |
| schema: | |
| type: string | |
| example: '460000000038035' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-exchange-rate-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-an-exchange-rate-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| delete: | |
| tags: | |
| - currency | |
| operationId: delete_exchange_rate | |
| summary: Delete an exchage rate | |
| description: Delete an exchange rate for the specified currency. | |
| parameters: | |
| - name: exchange_rate_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the exchange rate. | |
| schema: | |
| type: string | |
| example: '460000000038035' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-an-exchage-rate-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.DELETE | |
| parameters: | |
| - name: currency_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the currency. | |
| schema: | |
| type: string | |
| example: '982000000004012' | |
| - $ref: '#/components/parameters/organization_id' | |
| /settings/locations/enable: | |
| post: | |
| tags: | |
| - locations | |
| operationId: enable_locations | |
| summary: Enable Locations | |
| description: Enable Locations for an organisation. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/enable-location-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /settings/openingbalances: | |
| post: | |
| tags: | |
| - opening-balance | |
| operationId: create_opening_balance | |
| summary: Create opening balance | |
| description: Creates opening balance with the given information. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-opening-balance-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-opening-balance-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| put: | |
| tags: | |
| - opening-balance | |
| operationId: update_opening_balance | |
| summary: Update opening balance | |
| description: Updates the existing opening balance information. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-opening-balance-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-opening-balance-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| get: | |
| tags: | |
| - opening-balance | |
| operationId: get_opening_balance | |
| summary: Get opening balance | |
| description: Get opening balance. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-opening-balance-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| delete: | |
| tags: | |
| - opening-balance | |
| operationId: delete_opening_balance | |
| summary: Delete opening balance | |
| description: Delete the entered opening balance. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-opening-balance-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.DELETE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /settings/taxauthorities: | |
| post: | |
| tags: | |
| - taxes | |
| operationId: create_tax_authority | |
| summary: Create a tax authority [US and CA Edition only] | |
| description: Create a tax authority. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-tax-authority-us-and-ca-edition-only-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-tax-authority-us-and-ca-edition-only-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| get: | |
| tags: | |
| - taxes | |
| operationId: list_tax_authorities | |
| summary: List tax authorities [US Edition only] | |
| description: List of tax authorities. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-tax-authorities-us-edition-only-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /settings/taxauthorities/{tax_authority_id}: | |
| put: | |
| tags: | |
| - taxes | |
| operationId: update_tax_authority | |
| summary: Update a tax authority [US and CA Edition only] | |
| description: Update the details of a tax authority. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-tax-authority-us-and-ca-edition-only-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-tax-authority-us-and-ca-edition-only-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| get: | |
| tags: | |
| - taxes | |
| operationId: get_tax_authority | |
| summary: Get a tax authority [US and CA Edition only] | |
| description: Get the details of a tax authority. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-tax-authority-us-and-ca-edition-only-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| delete: | |
| tags: | |
| - taxes | |
| operationId: delete_tax_authority | |
| summary: Delete a tax authority [US and CA Edition only] | |
| description: Delete a tax authority. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-tax-authority-us-and-ca-edition-only-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.DELETE | |
| parameters: | |
| - name: tax_authority_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the tax authority. | |
| schema: | |
| type: string | |
| example: '460000000066001' | |
| - $ref: '#/components/parameters/organization_id' | |
| /settings/taxes: | |
| post: | |
| tags: | |
| - taxes | |
| operationId: create_tax | |
| summary: Create a tax | |
| description: Create a tax which can be associated with an item. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-tax-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-tax-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| get: | |
| tags: | |
| - taxes | |
| operationId: list_taxes | |
| summary: List taxes | |
| description: List of simple and compound taxes with pagination. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-taxes-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /settings/taxes/{tax_id}: | |
| put: | |
| tags: | |
| - taxes | |
| operationId: update_tax | |
| summary: Update a tax | |
| description: Update the details of a simple or compound tax. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-tax-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-tax-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| get: | |
| tags: | |
| - taxes | |
| operationId: get_tax | |
| summary: Get a tax | |
| description: Get the details of a simple or compound tax. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-tax-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| delete: | |
| tags: | |
| - taxes | |
| operationId: delete_tax | |
| summary: Delete a tax | |
| description: Delete a simple or compound tax. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-tax-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.DELETE | |
| parameters: | |
| - name: tax_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the tax. | |
| schema: | |
| type: string | |
| example: '982000000566009' | |
| - $ref: '#/components/parameters/organization_id' | |
| /settings/taxexemptions: | |
| post: | |
| tags: | |
| - taxes | |
| operationId: create_tax_exemption | |
| summary: Create a tax exemption [US Edition only] | |
| description: Create a tax exemption. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-tax-exemption-us-edition-only-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-tax-exemption-us-edition-only-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| get: | |
| tags: | |
| - taxes | |
| operationId: list_tax_exemptions | |
| summary: List tax exemptions [US Edition only] | |
| description: List of tax exemptions. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-tax-exemptions-us-edition-only-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /settings/taxexemptions/{tax_exemption_id}: | |
| put: | |
| tags: | |
| - taxes | |
| operationId: update_tax_exemption | |
| summary: Update a tax exemption [US Edition only] | |
| description: Update the details of a tax exemption. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-tax-exemption-us-edition-only-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-tax-exemption-us-edition-only-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| get: | |
| tags: | |
| - taxes | |
| operationId: get_tax_exemption | |
| summary: Get a tax exemption [US Edition only] | |
| description: Get the details of a tax exemption. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-tax-exemption-us-edition-only-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| delete: | |
| tags: | |
| - taxes | |
| operationId: delete_tax_exemption | |
| summary: Delete a tax exemption [US Edition only] | |
| description: Delete a tax exemption. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-tax-exemption-us-edition-only-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.DELETE | |
| parameters: | |
| - name: tax_exemption_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the tax exemption. | |
| schema: | |
| type: string | |
| example: '460000000076002' | |
| - $ref: '#/components/parameters/organization_id' | |
| /settings/taxgroups: | |
| post: | |
| tags: | |
| - taxes | |
| operationId: create_tax_group | |
| summary: Create a tax group | |
| description: Create a tax group associating multiple taxes. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-tax-group-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-tax-group-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /settings/taxgroups/{tax_group_id}: | |
| get: | |
| tags: | |
| - taxes | |
| operationId: get_tax_group | |
| summary: Get a tax group | |
| description: Get the details of a tax group. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-tax-group-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| put: | |
| tags: | |
| - taxes | |
| operationId: update_tax_group | |
| summary: Update a tax group | |
| description: Update the details of the tax group. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-tax-group-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-tax-group-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| delete: | |
| tags: | |
| - taxes | |
| operationId: delete_tax_group | |
| summary: Delete a tax group | |
| description: Delete a tax group. Tax group that is associated to transactions | |
| cannot be deleted. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-tax-group-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.DELETE | |
| parameters: | |
| - name: tax_group_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the tax group. | |
| example: '982000000566009' | |
| - $ref: '#/components/parameters/organization_id' | |
| /share/paymentlink: | |
| get: | |
| tags: | |
| - invoices | |
| operationId: generate_invoice_payment_link | |
| summary: Generate payment link | |
| description: This API generates a payment link for the invoice with an expiry | |
| date. | |
| parameters: | |
| - $ref: '#/components/parameters/transaction_id' | |
| - $ref: '#/components/parameters/transaction_type' | |
| - $ref: '#/components/parameters/link_type' | |
| - $ref: '#/components/parameters/expiry_time' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/payment-link-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.ALL | |
| parameters: | |
| - $ref: '#/components/parameters/transaction_id' | |
| - $ref: '#/components/parameters/transaction_type' | |
| - $ref: '#/components/parameters/link_type' | |
| - $ref: '#/components/parameters/expiry_time' | |
| - $ref: '#/components/parameters/organization_id' | |
| /users: | |
| post: | |
| tags: | |
| - users | |
| operationId: create_user | |
| summary: Create a user | |
| description: Create a user for your organization. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-user-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-user-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| get: | |
| tags: | |
| - users | |
| operationId: list_users | |
| summary: List Users | |
| description: Get the list of all users in the organization. | |
| parameters: | |
| - name: filter_by | |
| in: query | |
| description: 'Allowed Values: <code>Status.All, Status.Active, Status.Inactive, | |
| Status.Invited and Status.Deleted</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sort_column | |
| in: query | |
| description: 'Sort users. Allowed Values: <code>name, email, user_role and | |
| status</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: name | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-users-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /users/me: | |
| get: | |
| tags: | |
| - users | |
| operationId: get_current_user | |
| summary: Get current user | |
| description: Get the details of the current user. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-current-user-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /users/{user_id}: | |
| put: | |
| tags: | |
| - users | |
| operationId: update_user | |
| summary: Update a user | |
| description: Update the details of a user. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-user-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-user-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.UPDATE | |
| get: | |
| tags: | |
| - users | |
| operationId: get_user | |
| summary: Get an user details | |
| description: Get the details of a user. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-user-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.READ | |
| delete: | |
| tags: | |
| - users | |
| operationId: delete_user | |
| summary: Delete a user | |
| description: Delete a user associated to the organization. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-user-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.DELETE | |
| parameters: | |
| - name: user_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the user. | |
| example: '982000000554041' | |
| - $ref: '#/components/parameters/organization_id' | |
| /users/{user_id}/active: | |
| post: | |
| tags: | |
| - users | |
| operationId: mark_user_active | |
| summary: Mark user as active | |
| description: Mark an inactive user as active. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-user-as-active-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| parameters: | |
| - name: user_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the user. | |
| example: '982000000554041' | |
| - $ref: '#/components/parameters/organization_id' | |
| /users/{user_id}/inactive: | |
| post: | |
| tags: | |
| - users | |
| operationId: mark_user_inactive | |
| summary: Mark user as inactive | |
| description: Mark an active user as inactive. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/mark-user-as-inactive-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| parameters: | |
| - name: user_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the user. | |
| example: '982000000554041' | |
| - $ref: '#/components/parameters/organization_id' | |
| /users/{user_id}/invite: | |
| post: | |
| tags: | |
| - users | |
| operationId: invite_user | |
| summary: Invite a user | |
| description: Send invitation email to a user. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/invite-a-user-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.settings.CREATE | |
| parameters: | |
| - name: user_id | |
| in: path | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique identifier of the user. | |
| example: '982000000554041' | |
| - $ref: '#/components/parameters/organization_id' | |
| /vendorcredits: | |
| post: | |
| tags: | |
| - vendor-credits | |
| operationId: create_vendor_credit | |
| summary: Create a vendor credit | |
| description: Create a new vendor credit to record credits issued by vendors | |
| for returned items, overpayments, or adjustments. Supports multi-currency | |
| transactions, custom line items, tax calculations, and workflows. | |
| parameters: | |
| - name: ignore_auto_number_generation | |
| in: query | |
| description: Ignore auto number generation for this vendor credit only. On | |
| enabling this option vendor credit number is mandatory. | |
| required: false | |
| schema: | |
| type: boolean | |
| - name: bill_id | |
| in: query | |
| description: Bill Associated with the Vendor Credit | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000057075' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-vendor-credit-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-vendor-credit-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.CREATE | |
| get: | |
| tags: | |
| - vendor-credits | |
| operationId: list_vendor_credits | |
| summary: List vendor credits | |
| description: Retrieve a paginated list of vendor credits with comprehensive | |
| filtering, sorting, and search capabilities. Use query parameters to filter | |
| by date, status, amount, vendor details, items, taxes, and custom fields. | |
| parameters: | |
| - name: vendor_credit_number | |
| in: query | |
| description: Filter vendor credits by specific vendor credit number. Supports | |
| variants <code>vendor_credit_number_startswith</code> and <code>vendor_credit_number_contains</code> | |
| for partial matching. | |
| required: false | |
| schema: | |
| type: string | |
| example: DN-00002 | |
| - name: date | |
| in: query | |
| description: 'Filter vendor credits by creation date. Use yyyy-mm-dd format. | |
| Supports variants: <code>date_start</code>, <code>date_end</code>, <code>date_before</code> | |
| and <code>date_after</code> for range-based filtering.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '2014-08-28' | |
| - name: status | |
| in: query | |
| description: 'Filter vendor credits by their current status. Allowed values: | |
| <code>open</code>, <code>closed</code>, <code>void</code>, or <code>draft</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: open | |
| - name: total | |
| in: query | |
| description: 'Filter vendor credits by their total amount. Supports variants: | |
| <code>total_start</code>, <code>total_end</code>, <code>total_less_than</code>, | |
| <code>total_less_equals</code>, <code>total_greater_than</code> and <code>total_greater_equals</code> | |
| for comparison-based filtering.' | |
| required: false | |
| schema: | |
| type: string | |
| example: 30 | |
| - name: reference_number | |
| in: query | |
| description: 'Filter vendor credits by their reference number. Supports variants: | |
| <code>reference_number_startswith</code> and <code>reference_number_contains</code> | |
| for partial matching.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: customer_name | |
| in: query | |
| description: 'Filter vendor credits by vendor name. Supports variants: <code>customer_name_startswith</code> | |
| and <code>customer_name_contains</code> for partial matching.' | |
| required: false | |
| schema: | |
| type: string | |
| example: Bowman and Co | |
| - name: item_name | |
| in: query | |
| description: 'Filter vendor credits by item name. Supports variants: <code>item_name_startswith</code> | |
| and <code>item_name_contains</code> for partial matching.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: item_description | |
| in: query | |
| description: 'Filter vendor credits by item description. Supports variants: | |
| <code>item_description_startswith</code> and <code>item_description_contains</code> | |
| for partial matching.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: notes | |
| in: query | |
| description: 'Filter vendor credits by notes content. Supports variants: <code>notes_startswith</code> | |
| and <code>notes_contains</code> for partial matching.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: custom_field | |
| in: query | |
| description: 'Filter vendor credits by custom field values. Supports variants: | |
| <code>custom_field_startswith</code> and <code>custom_field_contains</code> | |
| for partial matching.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: last_modified_time | |
| in: query | |
| description: Filter vendor credits by last modified time. Use ISO 8601 format | |
| (yyyy-mm-ddThh:mm:ss-hh:mm) to search for vendor credits modified at specific | |
| times. | |
| required: false | |
| schema: | |
| type: string | |
| example: 2014-08-28T22:53:31-0700 | |
| - name: customer_id | |
| in: query | |
| description: Filter vendor credits by customer ID. Use this parameter to search | |
| for vendor credits associated with a specific customer. Retrieve customer | |
| IDs from the contacts API. | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| example: '' | |
| - name: line_item_id | |
| in: query | |
| description: Filter vendor credits by line item ID. Use this parameter to | |
| search for vendor credits containing a specific line item within the vendor | |
| credit. | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| example: '460000000020077' | |
| - name: item_id | |
| in: query | |
| description: Filter vendor credits by item ID. Use this parameter to search | |
| for vendor credits containing a specific item. Retrieve item IDs from the | |
| items API. | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| example: '460000000020071' | |
| - name: tax_id | |
| in: query | |
| description: Filter vendor credits by tax ID. Use this parameter to search | |
| for vendor credits with a specific tax applied. Retrieve tax IDs from the | |
| taxes API. | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| example: '' | |
| - name: filter_by | |
| in: query | |
| description: 'Filter vendor credits by status using predefined status values. | |
| Allowed values: <code>Status.All</code>, <code>Status.Open</code>, <code>Status.Draft</code>, | |
| <code>Status.Closed</code>, and <code>Status.Void</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: search_text | |
| in: query | |
| description: Search vendor credits using text search across multiple fields. | |
| Searches vendor credit number, vendor name, and reference number. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sort_column | |
| in: query | |
| description: 'Sort vendor credits by specified column. Allowed values: <code>vendor_name</code>, | |
| <code>vendor_credit_number</code>, <code>balance</code>, <code>total</code>, | |
| <code>date</code>, <code>created_time</code>, <code>last_modified_time</code>, | |
| and <code>reference_number</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: created_time | |
| - name: page | |
| in: query | |
| description: Page number for pagination. Specify which page of results to | |
| retrieve. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records per page for pagination. Controls how many | |
| vendor credits are returned in each page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-vendor-credits-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /vendorcredits/refunds: | |
| get: | |
| tags: | |
| - vendor-credits | |
| operationId: list_vendor_credit_refunds | |
| summary: List vendor credit refunds | |
| description: List all refunds with pagination. | |
| parameters: | |
| - name: customer_id | |
| in: query | |
| description: Search vendor credits by vendor credit customer ID | |
| required: false | |
| schema: | |
| type: integer | |
| format: int64 | |
| example: '' | |
| - name: last_modified_time | |
| in: query | |
| description: Search vendor credits by vendor credit last modfified time | |
| required: false | |
| schema: | |
| type: string | |
| example: 2014-08-28T22:53:31-0700 | |
| - name: sort_column | |
| in: query | |
| description: 'Sort vendor credits by following columns vendor_name, vendorcredit_number, | |
| balance, total, date and created_time. Allowed Values: <code>vendor_name</code>, | |
| <code>vendor_credit_number</code>, <code>balance</code>, <code>total</code>, | |
| <code>date</code>, <code>created_time</code>, <code>last_modified_time</code> | |
| and <code>reference_number</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: created_time | |
| - name: page | |
| in: query | |
| description: Page number for pagination. Specify which page of results to | |
| retrieve. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records per page for pagination. Controls how many | |
| vendor credits are returned in each page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-vendor-credit-refunds-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.READ | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /vendorcredits/{vendor_credit_id}: | |
| put: | |
| tags: | |
| - vendor-credits | |
| operationId: update_vendor_credit | |
| summary: Update vendor credit | |
| description: Update an existing vendor credit. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-vendor-credit-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-vendor-credit-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.UPDATE | |
| get: | |
| tags: | |
| - vendor-credits | |
| operationId: get_vendor_credit | |
| summary: Get vendor credit | |
| description: Get details of a vendor credit. | |
| parameters: | |
| - name: print | |
| in: query | |
| description: 'Export vendor credit pdf with default print option. Allowed | |
| Values: <code>true</code>, <code>false</code>, <code>on</code> and <code>off</code>.' | |
| required: false | |
| schema: | |
| type: boolean | |
| - name: accept | |
| in: query | |
| description: 'You can get vendor credit details as json/pdf/html. Default | |
| format is html. Allowed Values: <code>json</code>, <code>xml</code>, <code>csv</code>, | |
| <code>xls</code>, <code>pdf</code>, <code>html</code> and <code>jhtml</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-vendor-credit-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.READ | |
| delete: | |
| tags: | |
| - vendor-credits | |
| operationId: delete_vendor_credit | |
| summary: Delete vendor credit | |
| description: Delete a vendor credit. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-vendor-credit-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.DELETE | |
| parameters: | |
| - name: vendor_credit_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the vendor credit. | |
| schema: | |
| type: string | |
| example: '3000000002075' | |
| - $ref: '#/components/parameters/organization_id' | |
| /vendorcredits/{vendor_credit_id}/approve: | |
| post: | |
| tags: | |
| - vendor-credits | |
| operationId: approve_vendor_credit | |
| summary: Approve a Vendor credit | |
| description: Approve a Vendor credit. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/approve-a-vendor-credit-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.CREATE | |
| parameters: | |
| - name: vendor_credit_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the vendor credit. | |
| schema: | |
| type: string | |
| example: '3000000002075' | |
| - $ref: '#/components/parameters/organization_id' | |
| /vendorcredits/{vendor_credit_id}/bills: | |
| get: | |
| tags: | |
| - vendor-credits | |
| operationId: list_bills_credited | |
| summary: List bills credited | |
| description: List bills to which the vendor credit is applied. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-bills-credited-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.READ | |
| post: | |
| tags: | |
| - vendor-credits | |
| operationId: apply_credits_to_a_bill | |
| summary: Apply credits to a bill | |
| description: Apply vendor credit to existing bills. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/apply-credits-to-a-bill-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/apply-credits-to-a-bill-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.CREATE | |
| parameters: | |
| - name: vendor_credit_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the vendor credit. | |
| schema: | |
| type: string | |
| example: '3000000002075' | |
| - $ref: '#/components/parameters/organization_id' | |
| /vendorcredits/{vendor_credit_id}/bills/{vendor_credit_bill_id}: | |
| delete: | |
| tags: | |
| - vendor-credits | |
| operationId: delete_vendor_credit_bill | |
| summary: Delete bills credited | |
| description: 'Delete the credits applied to a bill. <code>Note: </code>You should | |
| pass the vendor_credit_bill_id from "Get vendor credits > bills credited > | |
| vendor_credit_bill_id" section' | |
| parameters: | |
| - name: vendor_credit_bill_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the vendor credit bill. | |
| schema: | |
| type: string | |
| example: '460000000057075' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-bills-credited-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.DELETE | |
| parameters: | |
| - name: vendor_credit_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the vendor credit. | |
| schema: | |
| type: string | |
| example: '3000000002075' | |
| - $ref: '#/components/parameters/organization_id' | |
| /vendorcredits/{vendor_credit_id}/comments: | |
| post: | |
| tags: | |
| - vendor-credits | |
| operationId: add_vendor_credit_comment | |
| summary: Add a comment | |
| description: Add a comment to an existing vendor credit. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-a-comment-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/add-a-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.CREATE | |
| get: | |
| tags: | |
| - vendor-credits | |
| operationId: list_vendor_credit_comments | |
| summary: List vendor credit comments & history | |
| description: Get history and comments of a vendor credit. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-vendor-credit-comments-and-history-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.READ | |
| parameters: | |
| - name: vendor_credit_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the vendor credit. | |
| schema: | |
| type: string | |
| example: '3000000002075' | |
| - $ref: '#/components/parameters/organization_id' | |
| /vendorcredits/{vendor_credit_id}/comments/{comment_id}: | |
| delete: | |
| tags: | |
| - vendor-credits | |
| operationId: delete_vendor_credit_comment | |
| summary: Delete a comment | |
| description: Delete a vendor credit comment. | |
| parameters: | |
| - name: comment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the comment. | |
| schema: | |
| type: string | |
| example: '3000000002089' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-comment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.DELETE | |
| parameters: | |
| - name: vendor_credit_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the vendor credit. | |
| schema: | |
| type: string | |
| example: '3000000002075' | |
| - $ref: '#/components/parameters/organization_id' | |
| /vendorcredits/{vendor_credit_id}/refunds: | |
| post: | |
| tags: | |
| - vendor-credits | |
| operationId: refund_vendor_credit | |
| summary: Refund a vendor credit | |
| description: Refund vendor credit amount. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/refund-a-vendor-credit-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/refund-a-vendor-credit-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.CREATE | |
| get: | |
| tags: | |
| - vendor-credits | |
| operationId: list_vendor_credit_refunds | |
| summary: List refunds of a vendor credit | |
| description: List all refunds of an existing vendor credit. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number for pagination. Specify which page of results to | |
| retrieve. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records per page for pagination. Controls how many | |
| vendor credits are returned in each page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-refunds-of-a-vendor-credit-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.READ | |
| parameters: | |
| - name: vendor_credit_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the vendor credit. | |
| schema: | |
| type: string | |
| example: '3000000002075' | |
| - $ref: '#/components/parameters/organization_id' | |
| /vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id}: | |
| put: | |
| tags: | |
| - vendor-credits | |
| operationId: update_vendor_credit_refund | |
| summary: Update vendor credit refund | |
| description: Update the refunded transaction. | |
| parameters: | |
| - name: vendor_credit_refund_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the vendor credit refund. | |
| schema: | |
| type: string | |
| example: '3000000003151' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-vendor-credit-refund-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-vendor-credit-refund-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.UPDATE | |
| get: | |
| tags: | |
| - vendor-credits | |
| operationId: get_vendor_credit_refund | |
| summary: Get vendor credit refund | |
| description: Get refund of a particular vendor credit. | |
| parameters: | |
| - name: vendor_credit_refund_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the vendor credit refund. | |
| schema: | |
| type: string | |
| example: '3000000003151' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-vendor-credit-refund-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.READ | |
| delete: | |
| tags: | |
| - vendor-credits | |
| operationId: delete_vendor_credit_refund | |
| summary: Delete vendor credit refund | |
| description: Delete a vendor credit refund. | |
| parameters: | |
| - name: vendor_credit_refund_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the vendor credit refund. | |
| schema: | |
| type: string | |
| example: '3000000003151' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-vendor-credit-refund-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.DELETE | |
| parameters: | |
| - name: vendor_credit_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the vendor credit. | |
| schema: | |
| type: string | |
| example: '3000000002075' | |
| - $ref: '#/components/parameters/organization_id' | |
| /vendorcredits/{vendor_credit_id}/status/open: | |
| post: | |
| tags: | |
| - vendor-credits | |
| operationId: mark_vendor_credit_open | |
| summary: Convert to open | |
| description: Change an existing vendor credit status to open. | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/convert-to-open-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.CREATE | |
| parameters: | |
| - name: vendor_credit_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the vendor credit. | |
| schema: | |
| type: string | |
| example: '3000000002075' | |
| - $ref: '#/components/parameters/organization_id' | |
| /vendorcredits/{vendor_credit_id}/status/void: | |
| post: | |
| tags: | |
| - vendor-credits | |
| operationId: mark_vendor_credit_void | |
| summary: Void vendor credit | |
| description: Mark an existing vendor credit as void. | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/void-vendor-credit-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.CREATE | |
| parameters: | |
| - name: vendor_credit_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the vendor credit. | |
| schema: | |
| type: string | |
| example: '3000000002075' | |
| - $ref: '#/components/parameters/organization_id' | |
| /vendorcredits/{vendor_credit_id}/submit: | |
| post: | |
| tags: | |
| - vendor-credits | |
| operationId: submit_vendor_credit | |
| summary: Submit a Vendor credit for approval | |
| description: Submit a Vendor credit for approval. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/submit-a-vendor-credit-for-approval-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.debitnotes.CREATE | |
| parameters: | |
| - name: vendor_credit_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the vendor credit. | |
| schema: | |
| type: string | |
| example: '3000000002075' | |
| - $ref: '#/components/parameters/organization_id' | |
| /vendorpayments: | |
| post: | |
| tags: | |
| - vendor-payments | |
| operationId: create_vendor_payment | |
| summary: Create a vendor payment | |
| description: Create a payment made to your vendor and you can also apply them | |
| to bills either partially or fully. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-vendor-payment-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-a-vendor-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.vendorpayments.CREATE | |
| get: | |
| tags: | |
| - vendor-payments | |
| operationId: list_vendor_payments | |
| summary: List vendor payments | |
| description: List all the payments made to your vendor. | |
| parameters: | |
| - name: vendor_name | |
| in: query | |
| description: 'Search payments by vendor name. Variants: <code>vendor_name_startswith</code> | |
| and <code>vendor_name_contains</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: Bowman and Co | |
| - name: reference_number | |
| in: query | |
| description: 'Search payments by reference number. Variants: <code>reference_number_startswith</code> | |
| and <code>reference_number_contains</code>. In refunds, reference number | |
| for the refund recorded.' | |
| required: false | |
| schema: | |
| type: string | |
| example: REF#912300 | |
| - name: payment_number | |
| in: query | |
| description: 'Search with Payment Number. Variant: <code>payment_number_startswith</code>, | |
| <code>payment_number_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: '1' | |
| - name: date | |
| in: query | |
| description: 'Date the payment is made. Search payments by payment made date. | |
| Variants: <code>date_start</code>, <code>date_end</code>, <code>date_before</code> | |
| and <code>date_after</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: '2013-10-07' | |
| - name: amount | |
| in: query | |
| description: 'Payment amount made to the vendor. Search payments by payment | |
| amount. Variants: <code>amount_less_than</code>, <code>amount_less_equals</code>, | |
| <code>amount_greater_than</code> and <code>amount_greater_equals</code>. | |
| In refunds, Amount refunded from the vendor payment.' | |
| required: false | |
| schema: | |
| type: number | |
| format: double | |
| example: 500 | |
| - name: payment_mode | |
| in: query | |
| description: 'Search payments by payment mode. Variants: <code>payment_mode_startswith</code> | |
| and <code>payment_mode_contains</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: Stripe | |
| - name: notes | |
| in: query | |
| description: 'Search with Payment Notes. Variant: <code>notes_startswith</code>, | |
| <code>notes_contains</code>' | |
| required: false | |
| schema: | |
| type: string | |
| example: Payment | |
| - name: vendor_id | |
| in: query | |
| description: ID of the vendor. Search payments by vendor id. | |
| required: false | |
| schema: | |
| type: string | |
| example: '460000000026049' | |
| - name: last_modified_time | |
| in: query | |
| description: Search with the Last Modified Time of the Vendor Payment | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: bill_id | |
| in: query | |
| description: Search payments by Bill ID. | |
| required: false | |
| schema: | |
| type: string | |
| example: B-01 | |
| - name: description | |
| in: query | |
| description: 'Search payments by description. Variants: <code>description_startswith</code> | |
| and <code>description_contains</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: Payment | |
| - name: filter_by | |
| in: query | |
| description: 'Filter payments by mode. Allowed Values: <code>PaymentMode.All</code>, | |
| <code>PaymentMode.Check</code>, <code>PaymentMode.Cash</code>, <code>PaymentMode.BankTransfer</code>, | |
| <code>PaymentMode.Paypal</code>, <code>PaymentMode.CreditCard</code>, <code>PaymentMode.GoogleCheckout</code>, | |
| <code>PaymentMode.Credit</code>, <code>PaymentMode.Authorizenet</code>, | |
| <code>PaymentMode.BankRemittance</code>, <code>PaymentMode.Payflowpro</code> | |
| and <code>PaymentMode.Others</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: PaymentMode.All | |
| - name: search_text | |
| in: query | |
| description: Search payments by reference number or vendor name or payment | |
| description. | |
| required: false | |
| schema: | |
| type: string | |
| example: '' | |
| - name: sort_column | |
| in: query | |
| description: 'Sort the payment list. Allowed Values: <code>vendor_name</code>, | |
| <code>date</code>, <code>reference_number</code>, <code>amount</code> and | |
| <code>balance</code>.' | |
| required: false | |
| schema: | |
| type: string | |
| example: vendor_name | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-vendor-payments-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.vendorpayments.READ | |
| put: | |
| tags: | |
| - vendor-payments | |
| operationId: update_vendor_payment_using_custom_field | |
| summary: Update an vendor payment using a custom field's unique value | |
| description: A custom field will have unique values if it's configured to not | |
| accept duplicate values. Now, you can use that custom field's value to update | |
| a vendor payment by providing its API name in the X-Unique-Identifier-Key | |
| header and its value in the X-Unique-Identifier-Value header. Based on this | |
| value, the corresponding vendor payment will be retrieved and updated. Additionally, | |
| there is an optional X-Upsert header. If the X-Upsert header is true and the | |
| custom field's unique value is not found in any of the existing vendor payments, | |
| a new vendor payment will be created if the necessary payload details are | |
| available | |
| parameters: | |
| - name: X-Unique-Identifier-Key | |
| in: header | |
| description: Unique CustomField Api Name | |
| required: true | |
| schema: | |
| type: string | |
| example: cf_unique_cf | |
| - name: X-Unique-Identifier-Value | |
| in: header | |
| description: Unique CustomField Value | |
| required: true | |
| schema: | |
| type: string | |
| example: unique Value | |
| - name: X-Upsert | |
| in: header | |
| description: If there is no record is found unique custom field value , will | |
| create new invoice | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-vendor-payment-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-vendor-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.vendorpayments.UPDATE | |
| delete: | |
| tags: | |
| - vendor-payments | |
| operationId: bulk_delete_vendor_payments | |
| summary: Bulk delete vendor payments | |
| description: Delete multiple vendor payments. | |
| parameters: | |
| - name: vendorpayment_id | |
| in: query | |
| description: Comma-separated list of vendor payment IDs to be deleted | |
| required: true | |
| schema: | |
| type: string | |
| example: 460000000053219,460000000053220,460000000053221 | |
| - name: bulk_delete | |
| in: query | |
| description: Flag to indicate bulk delete operation | |
| required: true | |
| schema: | |
| type: boolean | |
| example: true | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/bulk-delete-vendor-payments-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.vendorpayments.DELETE | |
| parameters: | |
| - $ref: '#/components/parameters/organization_id' | |
| /vendorpayments/{payment_id}: | |
| put: | |
| tags: | |
| - vendor-payments | |
| operationId: update_vendor_payment | |
| summary: Update a vendor payment | |
| description: Update an existing vendor payment. You can also modify the amount | |
| applied to the bills. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-vendor-payment-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-vendor-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.vendorpayments.UPDATE | |
| get: | |
| tags: | |
| - vendor-payments | |
| operationId: get_vendor_payment | |
| summary: Get a vendor payment | |
| description: Get the details of a vendor payment. | |
| parameters: | |
| - name: fetchTaxInfo | |
| in: query | |
| description: Check if tax information should be fetched | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| - name: fetchstatementlineinfo | |
| in: query | |
| description: Check is Statement Line Information for Vendor Payment be fetched | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| - name: print | |
| in: query | |
| description: Check if Vendor Payment must be printed. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| - name: is_bill_payment_id | |
| in: query | |
| description: Check if the ID is Bill Payment or Vendor Payment | |
| required: false | |
| schema: | |
| type: boolean | |
| example: true | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-a-vendor-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.vendorpayments.READ | |
| delete: | |
| tags: | |
| - vendor-payments | |
| operationId: delete_vendor_payment | |
| summary: Delete a vendor payment | |
| description: Delete an existing vendor payment. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-vendor-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.vendorpayments.DELETE | |
| parameters: | |
| - name: payment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the payment. | |
| schema: | |
| type: string | |
| example: '460000000053219' | |
| - $ref: '#/components/parameters/organization_id' | |
| /vendorpayments/{payment_id}/email: | |
| post: | |
| tags: | |
| - vendor-payments | |
| operationId: email_vendor_payment | |
| summary: Email a vendor payment | |
| description: Send a vendor payment receipt to the vendor via email. You can | |
| customize the email content, attach files, and control sender preferences. | |
| If the request body is empty, the email will be sent with default content | |
| based on the email template associated with the vendor or the default template. | |
| parameters: | |
| - name: send_attachment | |
| in: query | |
| description: Send the vendor payment attachment with the email. | |
| required: false | |
| schema: | |
| type: boolean | |
| example: false | |
| - name: attachments | |
| in: query | |
| description: Files to be attached to the email | |
| required: false | |
| schema: | |
| type: string | |
| format: binary | |
| example: '' | |
| - name: file_name | |
| in: query | |
| description: Name of the file to be attached | |
| required: false | |
| schema: | |
| type: string | |
| example: payment_receipt.pdf | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-a-vendor-payment-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/email-a-vendor-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.vendorpayments.CREATE | |
| get: | |
| tags: | |
| - vendor-payments | |
| operationId: get_vendor_payment_email_content | |
| summary: Get vendor payment email content | |
| description: Retrieve the pre-populated email content for a vendor payment, | |
| including subject, body, recipient contacts, sender options, and attachment | |
| details. This endpoint provides all the necessary information to compose and | |
| send a vendor payment receipt email. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-vendor-payment-email-content-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.vendorpayments.READ | |
| parameters: | |
| - name: payment_id | |
| in: path | |
| required: true | |
| schema: | |
| type: string | |
| example: '460000000053219' | |
| - $ref: '#/components/parameters/organization_id' | |
| /vendorpayments/{payment_id}/refunds: | |
| get: | |
| tags: | |
| - vendor-payments | |
| operationId: list_vendor_payment_refunds | |
| summary: List refunds of a vendor payment | |
| description: List all the refunds pertaining to an existing vendor payment. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: Page number to be fetched. Default value is 1. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 1 | |
| example: 1 | |
| - name: per_page | |
| in: query | |
| description: Number of records to be fetched per page. Default value is 200. | |
| required: false | |
| schema: | |
| type: integer | |
| default: 200 | |
| example: 200 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/list-refunds-of-a-vendor-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.vendorpayments.READ | |
| post: | |
| tags: | |
| - vendor-payments | |
| operationId: refund_excess_vendor_payment | |
| summary: Refund an excess vendor payment | |
| description: Refund the excess amount paid to the vendor. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/refund-an-excess-vendor-payment-request' | |
| responses: | |
| '201': | |
| description: Created | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/refund-an-excess-vendor-payment-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.vendorpayments.CREATE | |
| parameters: | |
| - name: payment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the payment. | |
| schema: | |
| type: string | |
| example: '460000000053219' | |
| - $ref: '#/components/parameters/organization_id' | |
| /vendorpayments/{payment_id}/refunds/{vendorpayment_refund_id}: | |
| get: | |
| tags: | |
| - vendor-payments | |
| operationId: get_vendor_payment_refund | |
| summary: Details of a refund | |
| description: Obtain details of a particular refund of a vendor payment. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/details-of-a-refund-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.vendorpayments.READ | |
| put: | |
| tags: | |
| - vendor-payments | |
| operationId: update_vendor_payment_refund | |
| summary: Update a refund | |
| description: Update the refunded transaction. | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-refund-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-a-refund-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.vendorpayments.UPDATE | |
| delete: | |
| tags: | |
| - vendor-payments | |
| operationId: delete_vendor_payment_refund | |
| summary: Delete a refund | |
| description: Delete refund pertaining to an existing vendor payment. | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-a-refund-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.vendorpayments.DELETE | |
| parameters: | |
| - name: payment_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the payment. | |
| schema: | |
| type: string | |
| example: '460000000053219' | |
| - name: vendorpayment_refund_id | |
| in: path | |
| required: true | |
| description: Unique identifier of the vendor payment refund. | |
| schema: | |
| type: string | |
| example: '460000000003017' | |
| - $ref: '#/components/parameters/organization_id' | |
| /{module_name}: | |
| get: | |
| tags: | |
| - custom-modules | |
| operationId: list_records_of_custom_module | |
| summary: Get Record List of a Custom Module | |
| description: To get the list of records of a custom module, you can use the | |
| argument below | |
| parameters: | |
| - $ref: '#/components/parameters/module_name' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-record-list-of-a-custom-module-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.custommodules.ALL | |
| put: | |
| tags: | |
| - custom-modules | |
| operationId: bulk_update_custom_module_records | |
| summary: Bulk Update Custom Module | |
| description: To update existing custom module records in bulk, use the argument | |
| below | |
| parameters: | |
| - $ref: '#/components/parameters/module_name' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/bulk-update-custom-module-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/bulk-update-custom-module-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.custommodules.ALL | |
| post: | |
| tags: | |
| - custom-modules | |
| operationId: create_custom_module | |
| summary: Create Custom Modules | |
| description: To create a custom module, you can use the argument below | |
| parameters: | |
| - $ref: '#/components/parameters/module_name' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-custom-modules-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/create-custom-modules-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.custommodules.ALL | |
| delete: | |
| tags: | |
| - custom-modules | |
| operationId: delete_custom_module | |
| summary: ' Delete Custom Modules' | |
| description: To delete a custom module, you can use the argument below | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-custom-modules-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.custommodules.ALL | |
| parameters: | |
| - name: module_name | |
| in: path | |
| description: Module Name | |
| required: true | |
| schema: | |
| type: string | |
| example: cm_debtor | |
| - $ref: '#/components/parameters/organization_id' | |
| /{module_name}/{module_id}: | |
| get: | |
| tags: | |
| - custom-modules | |
| operationId: get_custom_module_record_details | |
| summary: Get Individual Record Details | |
| description: To get the details of an individual organisation, use the argument | |
| below. | |
| parameters: | |
| - $ref: '#/components/parameters/module_name' | |
| - $ref: '#/components/parameters/module_id' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/get-individual-record-details-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.custommodules.ALL | |
| put: | |
| tags: | |
| - custom-modules | |
| operationId: update_custom_module_record | |
| summary: Update Custom Module | |
| description: To update an existing custom module, use the argument below | |
| parameters: | |
| - $ref: '#/components/parameters/module_name' | |
| - $ref: '#/components/parameters/module_id' | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-custom-module-request' | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/update-custom-module-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.custommodules.ALL | |
| delete: | |
| tags: | |
| - custom-modules | |
| operationId: delete_custom_module_record | |
| summary: 'Delete individual records ' | |
| description: to delete individual records of a custom module, use the argument | |
| below | |
| parameters: | |
| - name: module_id | |
| in: path | |
| description: Custom Module ID | |
| required: true | |
| schema: | |
| type: integer | |
| example: 2112155000000652000 | |
| responses: | |
| '200': | |
| description: OK | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/delete-individual-records-response' | |
| deprecated: false | |
| security: | |
| - Zoho_Auth: | |
| - ZohoBooks.custommodules.ALL | |
| parameters: | |
| - name: module_name | |
| in: path | |
| description: Module Name | |
| required: true | |
| schema: | |
| type: string | |
| example: cm_debtor | |
| - $ref: '#/components/parameters/organization_id' | |
| components: | |
| schemas: | |
| abn: | |
| type: string | |
| x-node_available_in: | |
| - au | |
| x-node_unavailable_in: [] | |
| accept: | |
| description: 'You can get credit note details as json/pdf/html. Default format | |
| is html. Allowed Values: <code>json</code>, <code>pdf</code> and <code>html</code>' | |
| type: string | |
| accept_retainer: | |
| description: 'Boolean flag indicating whether a retainer invoice should be automatically | |
| created if the customer accepts this estimate. When set to <code>true</code>, | |
| a retainer invoice is generated upon acceptance, streamlining the process | |
| for upfront payments or deposits. Allowed values: <code>true</code> and <code>false</code>.' | |
| type: boolean | |
| example: true | |
| accepted_date: | |
| description: The date of acceptance of the estimates | |
| type: string | |
| example: ' ' | |
| account_code: | |
| description: Code of the Account | |
| type: string | |
| account_created_date: | |
| description: Date of creation of the account | |
| type: string | |
| example: '2012-02-15' | |
| account_created_date_formatted: | |
| type: string | |
| example: 15 Feb 2012 | |
| account_id: | |
| description: ID of the Bank/Credit Card account | |
| type: string | |
| example: '460000000050127' | |
| account_ids: | |
| description: ID of the accounts for which base currency adjustments need to | |
| be posted. | |
| type: string | |
| example: 460000000000364 | |
| account_name: | |
| description: Name of the account | |
| type: string | |
| example: Corporate Account | |
| account_number: | |
| description: Number associated with the Bank Account | |
| type: string | |
| example: '80000009823' | |
| account_type: | |
| description: Type of the account | |
| type: string | |
| example: bank | |
| accounts: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| account_name: | |
| $ref: '#/components/schemas/account_name' | |
| bcy_balance: | |
| $ref: '#/components/schemas/bcy_balance' | |
| fcy_balance: | |
| $ref: '#/components/schemas/fcy_balance' | |
| adjusted_balance: | |
| $ref: '#/components/schemas/adjusted_balance' | |
| gain_or_loss: | |
| $ref: '#/components/schemas/gain_or_loss' | |
| gl_specific_type: | |
| $ref: '#/components/schemas/gl_specific_type' | |
| accumulated_dep_value: | |
| description: Accumulated depreciation value of the fixed asset | |
| type: number | |
| example: 0 | |
| accumulated_value: | |
| description: Accumulated value of the fixed asset | |
| type: number | |
| example: 175.22 | |
| ach_gw_transaction_id: | |
| description: ID of the ACH Payment Transaction | |
| type: string | |
| ach_payment_initiated: | |
| type: boolean | |
| example: false | |
| ach_payment_status: | |
| description: Status of the ACH Payment | |
| type: string | |
| acount_split_id: | |
| description: ID of split account that you want to update. | |
| type: string | |
| example: '460000000050045' | |
| acquisition_vat_amount: | |
| description: Amount of the VAT Acquistion | |
| type: string | |
| x-node_available_in: | |
| - uk | |
| - eu | |
| x-node_unavailable_in: [] | |
| acquisition_vat_id: | |
| description: (Optional) This is the ID of the tax applied in case this is an | |
| EU - goods purchase or expense and acquisition VAT needs to be reported. | |
| type: string | |
| x-node_available_in: | |
| - uk | |
| - eu | |
| x-node_unavailable_in: [] | |
| acquisition_vat_name: | |
| description: Name of the VAT Acquistion | |
| type: string | |
| x-node_available_in: | |
| - uk | |
| - eu | |
| x-node_unavailable_in: [] | |
| acquisition_vat_percentage: | |
| description: Percentage of the VAT Acquistion | |
| type: string | |
| x-node_available_in: | |
| - uk | |
| - eu | |
| x-node_unavailable_in: [] | |
| acquisition_vat_summary: | |
| description: Summary of the VAT Acquistion | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| tax_name: | |
| $ref: '#/components/schemas/tax_name' | |
| tax_amount: | |
| $ref: '#/components/schemas/tax_amount' | |
| x-node_available_in: | |
| - uk | |
| - eu | |
| x-node_unavailable_in: [] | |
| acquisition_vat_total: | |
| description: Total of the VAT Acquistion | |
| type: number | |
| format: double | |
| x-node_available_in: | |
| - uk | |
| - eu | |
| x-node_unavailable_in: [] | |
| activate-account-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The account has been marked as active. | |
| readOnly: true | |
| activate-project-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The selected Projects have been marked as active. | |
| readOnly: true | |
| add-a-comment-request: | |
| type: object | |
| properties: | |
| description: | |
| description: A small description about the item. | |
| type: string | |
| example: Credits applied to invoice INV-00004 | |
| add-a-comment-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Comments added. | |
| readOnly: true | |
| add-a-task-request: | |
| required: | |
| - task_name | |
| type: object | |
| properties: | |
| task_name: | |
| $ref: '#/components/schemas/task_name' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| budget_hours: | |
| $ref: '#/components/schemas/budget_hours' | |
| add-a-task-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The project information has been updated. | |
| readOnly: true | |
| task: | |
| $ref: '#/components/schemas/task-response' | |
| add-additional-address-request: | |
| type: object | |
| properties: | |
| attention: | |
| $ref: '#/components/schemas/attention' | |
| address: | |
| $ref: '#/components/schemas/address' | |
| street2: | |
| $ref: '#/components/schemas/street2' | |
| city: | |
| $ref: '#/components/schemas/city' | |
| state: | |
| $ref: '#/components/schemas/state' | |
| zip: | |
| $ref: '#/components/schemas/zip' | |
| country: | |
| $ref: '#/components/schemas/country' | |
| fax: | |
| $ref: '#/components/schemas/fax' | |
| phone: | |
| description: The contact phone number associated with the address. Max-length | |
| [50] | |
| type: string | |
| example: +1-925-921-9201 | |
| add-additional-address-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The address has been created. | |
| readOnly: true | |
| address_info: | |
| $ref: '#/components/schemas/address_info' | |
| add-attachment-to-a-bill-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The document has been attached. | |
| readOnly: true | |
| add-attachment-to-a-journal-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Your file has been successfully attached to the journal. | |
| readOnly: true | |
| add-attachment-to-a-purchase-order-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The document has been attached. | |
| readOnly: true | |
| add-attachment-to-a-retainer-invoice-request: | |
| type: object | |
| properties: | |
| can_send_in_mail: | |
| $ref: '#/components/schemas/can_send_in_mail' | |
| attachment: | |
| $ref: '#/components/schemas/attachment' | |
| add-attachment-to-a-retainer-invoice-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Your file has been attached. | |
| readOnly: true | |
| add-attachment-to-a-sales-order-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Your file has been successfully attached to the sales order. | |
| readOnly: true | |
| add-attachment-to-an-expense-request: | |
| type: object | |
| required: | |
| - attachment | |
| properties: | |
| attachment: | |
| type: string | |
| format: binary | |
| description: 'Expense attachment file to attach. Allowed Extensions: <code>gif</code>, | |
| <code>png</code>, <code>jpeg</code>, <code>jpg</code>, <code>bmp</code>, | |
| <code>pdf</code>, <code>xls</code>, <code>xlsx</code>, <code>doc</code>, | |
| <code>docx</code>, <code>txt</code> and <code>csv</code>' | |
| example: '@/attachment.pdf' | |
| totalFiles: | |
| type: integer | |
| description: Total number of files being uploaded. | |
| example: 1 | |
| document_ids: | |
| type: array | |
| items: | |
| type: string | |
| description: Array of document IDs for batch processing. | |
| example: [] | |
| add-attachment-to-an-expense-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The expense attachment has been attached. | |
| readOnly: true | |
| documents: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| document_id: | |
| type: string | |
| example: '982000000567123' | |
| description: ID of the uploaded document | |
| file_name: | |
| type: string | |
| example: attachment.pdf | |
| description: Name of the uploaded file | |
| file_size: | |
| type: integer | |
| example: 1024 | |
| description: Size of the uploaded file in bytes | |
| document_type: | |
| type: string | |
| example: attachment | |
| description: Type of the document | |
| add-attachment-to-an-invoice-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Your file has been successfully attached to the invoice. | |
| readOnly: true | |
| add-comment-request: | |
| required: | |
| - description | |
| type: object | |
| properties: | |
| description: | |
| $ref: '#/components/schemas/description' | |
| add-comment-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Comments added. | |
| readOnly: true | |
| comment: | |
| $ref: '#/components/schemas/comment' | |
| add-comments-request: | |
| type: object | |
| properties: | |
| description: | |
| description: The description of the line items | |
| type: string | |
| example: Estimate marked as sent | |
| show_comment_to_clients: | |
| $ref: '#/components/schemas/show_comment_to_clients' | |
| add-comments-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Comments added | |
| readOnly: true | |
| add-receipt-to-an-expense-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The expense receipt has been attached. | |
| readOnly: true | |
| additional_field1: | |
| description: 'Paypal payment method. Allowed Values: <code>standard</code> and | |
| <code>adaptive</code>' | |
| type: string | |
| example: standard | |
| address: | |
| description: Address Involved in the Transaction | |
| type: string | |
| address1: | |
| type: string | |
| address2: | |
| type: string | |
| address_id: | |
| description: Address id of the address | |
| type: string | |
| example: 1053791000000186000 | |
| address_info: | |
| description: Additional address information for the contact. | |
| type: object | |
| properties: | |
| address_id: | |
| $ref: '#/components/schemas/address_id' | |
| attention: | |
| $ref: '#/components/schemas/attention' | |
| address: | |
| $ref: '#/components/schemas/address' | |
| street2: | |
| $ref: '#/components/schemas/street2' | |
| city: | |
| $ref: '#/components/schemas/city' | |
| state: | |
| $ref: '#/components/schemas/state' | |
| zip: | |
| $ref: '#/components/schemas/zip' | |
| country: | |
| $ref: '#/components/schemas/country' | |
| fax: | |
| $ref: '#/components/schemas/fax' | |
| phone: | |
| description: The contact phone number associated with the address. Max-length | |
| [50] | |
| type: string | |
| example: +1-925-921-9201 | |
| adjusted_balance: | |
| description: Adjusted Balance | |
| type: number | |
| format: double | |
| example: 209.12 | |
| adjustment: | |
| description: Additional amount added to or subtracted from bill total. Positive | |
| values increase total, negative values decrease total. Used for discounts, | |
| surcharges, rounding adjustments, or other modifications. Affects final bill | |
| amount, tax calculations, and payment processing. | |
| type: number | |
| format: double | |
| example: 0 | |
| adjustment_date: | |
| description: Date of adjustment. | |
| type: string | |
| example: '2013-09-05' | |
| adjustment_description: | |
| description: 'Text description explaining the reason for bill adjustment. Examples: | |
| "Early payment discount", "Volume discount", "Rounding adjustment", "Handling | |
| fee". Helps in audit trails and reporting. Required when adjustment amount | |
| is non-zero. Used in financial reports, tax returns, and vendor communications. | |
| Should be clear and specific for compliance purposes.' | |
| type: string | |
| example: ' ' | |
| all_options_response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| message: | |
| type: string | |
| example: success | |
| results: | |
| type: array | |
| description: List of all options under a reporting tag | |
| items: | |
| type: object | |
| properties: | |
| option_id: | |
| type: string | |
| description: Option ID or <code>untagged</code> for untagged option | |
| if the show_untagged is true | |
| example: '460000000038082' | |
| option_name: | |
| type: string | |
| description: Option's name or 'Untagged' for untagged option if the | |
| show_untagged is true | |
| example: Sales | |
| depth: | |
| $ref: '#/components/schemas/depth' | |
| example: | |
| - option_id: '460000000038081' | |
| option_name: Sales | |
| depth: 0 | |
| - option_id: '460000000038083' | |
| option_name: Sales - Central | |
| depth: 1 | |
| - option_id: untagged | |
| option_name: Untagged | |
| depth: 0 | |
| allow_partial_payments: | |
| description: Boolean flag that determines whether customers can make partial | |
| payments against this invoice. When <code>true</code>, customers can pay less | |
| than the full invoice amount, and the invoice will remain open with a remaining | |
| balance. When <code>false</code>, customers must pay the full amount to complete | |
| the invoice. This setting affects payment processing and invoice status tracking. | |
| type: boolean | |
| example: true | |
| amount: | |
| description: Amount involved in the transaction | |
| type: number | |
| format: double | |
| example: 7500 | |
| amount_applied: | |
| description: Amount applied to the Entity | |
| type: number | |
| format: double | |
| example: 150 | |
| amount_bcy: | |
| type: string | |
| example: 57.15 | |
| amount_end: | |
| description: Starting amout with which transactions are to be filtered | |
| type: number | |
| format: double | |
| amount_fcy: | |
| type: string | |
| example: 57.15 | |
| amount_in_words: | |
| description: Amount in Words | |
| type: string | |
| amount_refunded: | |
| description: Amount that is refund. Refunds are applicable only for payments | |
| whose payment_mode is <code>autotransaction</code>. Refunds would be made | |
| to the respective card provided by the customer. | |
| type: number | |
| format: double | |
| example: 50 | |
| amount_start: | |
| description: Starting amout with which transactions are to be filtered | |
| type: number | |
| format: double | |
| api_name: | |
| description: API name of the field | |
| type: string | |
| example: record_name | |
| applied_filter: | |
| type: string | |
| example: Status.All | |
| apply-credits-request: | |
| type: object | |
| properties: | |
| bill_payments: | |
| $ref: '#/components/schemas/bill_payments' | |
| apply_vendor_credits: | |
| $ref: '#/components/schemas/apply_vendor_credits' | |
| apply-credits-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Credits have been applied to the bill(s)." | |
| readOnly: true | |
| apply-credits-to-a-bill-request: | |
| required: | |
| - bills | |
| type: object | |
| properties: | |
| bills: | |
| description: Amount applied from vendor credits to specified bills. | |
| type: array | |
| items: | |
| type: object | |
| required: | |
| - bill_id | |
| - amount_applied | |
| properties: | |
| bill_id: | |
| description: Bill Associated with the Vendor Credit | |
| type: string | |
| example: '460000000057075' | |
| amount_applied: | |
| description: Amount applied to the bill. | |
| type: number | |
| format: double | |
| example: 10 | |
| apply-credits-to-a-bill-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Credits have been applied to the bill(s). | |
| readOnly: true | |
| bills: | |
| description: Amount applied from vendor credits to specified bills. | |
| apply_creditnotes: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| creditnote_id: | |
| $ref: '#/components/schemas/creditnote_id' | |
| amount_applied: | |
| $ref: '#/components/schemas/amount_applied' | |
| apply_to: | |
| description: Entities to which Rule must be applied | |
| type: string | |
| example: deposits | |
| apply_to_bills: | |
| type: object | |
| properties: | |
| bills: | |
| $ref: '#/components/schemas/bills' | |
| apply_vendor_credits: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| vendor_credit_id: | |
| $ref: '#/components/schemas/vendor_credit_id' | |
| amount_applied: | |
| $ref: '#/components/schemas/amount_applied' | |
| approve-a-bill-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| approve-a-credit-note-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: You have approved the Credit Note. | |
| readOnly: true | |
| approve-a-purchase-order-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: You have approved the Purchase Order. | |
| readOnly: true | |
| approve-a-retainer-invoice-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: You have approved the Retainer Invoice. | |
| readOnly: true | |
| approve-a-sales-order-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: You have approved the Sales Order. | |
| readOnly: true | |
| approve-a-vendor-credit-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: You have approved the vendor credit. | |
| readOnly: true | |
| approve-an-estimate-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: You have approved the estimate. | |
| readOnly: true | |
| approve-an-invoice-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: You have approved the invoice. | |
| readOnly: true | |
| approver_id: | |
| description: ID of the Approver | |
| type: integer | |
| format: int64 | |
| approvers: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| approver_id: | |
| $ref: '#/components/schemas/approver_id' | |
| order: | |
| $ref: '#/components/schemas/order' | |
| approvers_list: | |
| description: List of approvers | |
| type: string | |
| example: '' | |
| as_of_date: | |
| type: string | |
| example: '2014-08-30' | |
| asset_account_id: | |
| description: Enter the account id to track the fixed asset. | |
| type: string | |
| example: '3640355000000000367' | |
| asset_account_name: | |
| description: Name of the asset account | |
| type: string | |
| example: Furniture and Equipment | |
| asset_cost: | |
| description: Enter the purchase cost of the asset | |
| type: number | |
| format: double | |
| example: 1000 | |
| asset_forcast: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| valuation_date: | |
| $ref: '#/components/schemas/valuation_date' | |
| depreciated_value: | |
| $ref: '#/components/schemas/depreciated_value' | |
| current_value: | |
| $ref: '#/components/schemas/current_value' | |
| accumulated_value: | |
| $ref: '#/components/schemas/accumulated_value' | |
| asset_history: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| valuation_id: | |
| $ref: '#/components/schemas/valuation_id' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| valuation_date: | |
| $ref: '#/components/schemas/valuation_date' | |
| depreciated_value: | |
| $ref: '#/components/schemas/depreciated_value' | |
| current_value: | |
| $ref: '#/components/schemas/current_value' | |
| accumulated_value: | |
| $ref: '#/components/schemas/accumulated_value' | |
| type: | |
| $ref: '#/components/schemas/type' | |
| is_journal_posted: | |
| $ref: '#/components/schemas/is_journal_posted' | |
| asset_name: | |
| description: Enter the name of the fixed asset. | |
| type: string | |
| example: Laptop | |
| asset_number: | |
| description: Number of the fixed asset | |
| type: string | |
| example: FA-00013 | |
| asset_number_prefix: | |
| description: Prefix of the asset number | |
| type: string | |
| example: FA- | |
| asset_number_suffix: | |
| description: Suffix of the asset number | |
| type: integer | |
| example: 13 | |
| asset_purchase_date: | |
| description: Enter the Purchase date of the asset | |
| type: string | |
| example: '2024-12-17' | |
| assign-users-request: | |
| required: | |
| - cost_rate | |
| type: object | |
| properties: | |
| users: | |
| $ref: '#/components/schemas/users' | |
| cost_rate: | |
| type: number | |
| format: double | |
| example: '10.00' | |
| assign-users-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Users added | |
| readOnly: true | |
| users: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| user_id: | |
| $ref: '#/components/schemas/user_id' | |
| is_current_user: | |
| $ref: '#/components/schemas/is_current_user' | |
| user_name: | |
| $ref: '#/components/schemas/user_name' | |
| email: | |
| $ref: '#/components/schemas/email' | |
| user_role: | |
| $ref: '#/components/schemas/user_role' | |
| status: | |
| $ref: '#/components/schemas/status' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| budget_hours: | |
| $ref: '#/components/schemas/budget_hours' | |
| cost_rate: | |
| $ref: '#/components/schemas/cost_rate' | |
| associated_series_ids: | |
| type: array | |
| items: | |
| type: string | |
| example: | |
| - '982000000870911' | |
| - '982000000870915' | |
| associated_transactions: | |
| description: Associated transactions of the fixed asset | |
| type: array | |
| items: | |
| type: object | |
| attach_pdf: | |
| type: boolean | |
| example: true | |
| attachment: | |
| description: 'File to attach. Allowed Extensions: <code>gif</code>, <code>png</code>, | |
| <code>jpeg</code>, <code>jpg</code>, <code>bmp</code> and <code>pdf</code>.' | |
| type: string | |
| format: binary | |
| attachment_name: | |
| description: Name of the Attachment | |
| type: string | |
| attachments: | |
| description: Files to be attached to the email. It has to be sent in multipart/formdata | |
| type: string | |
| format: binary | |
| attention: | |
| type: string | |
| autocomplete_response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| message: | |
| type: string | |
| example: success | |
| results: | |
| type: array | |
| description: List of reporting tags matching the search criteria | |
| items: | |
| type: object | |
| properties: | |
| id: | |
| $ref: '#/components/schemas/option_id' | |
| text: | |
| $ref: '#/components/schemas/option_name' | |
| depth: | |
| $ref: '#/components/schemas/depth' | |
| autonumbergenerationgroup_id: | |
| description: Autonumber generation group ID | |
| type: string | |
| example: '982000000870911' | |
| autotransaction: | |
| description: If the payment mode is <code>autotransaction</code>, autotransaction | |
| information will be displayed in the autotransaction object. It contains <code>autotransaction_id</code>, | |
| <code>payment_gateway</code>, <code>gateway_transaction_id</code>, <code>card_id</code>, | |
| <code>last_four_digits</code>, <code>expiry_month</code> and <code>expiry_year</code>. | |
| type: object | |
| properties: | |
| autotransaction_id: | |
| $ref: '#/components/schemas/autotransaction_id' | |
| payment_gateway: | |
| $ref: '#/components/schemas/payment_gateway' | |
| gateway_transaction_id: | |
| $ref: '#/components/schemas/gateway_transaction_id' | |
| gateway_error_message: | |
| $ref: '#/components/schemas/gateway_error_message' | |
| card_id: | |
| $ref: '#/components/schemas/card_id' | |
| last_four_digits: | |
| $ref: '#/components/schemas/last_four_digits' | |
| expiry_month: | |
| $ref: '#/components/schemas/expiry_month' | |
| expiry_year: | |
| $ref: '#/components/schemas/expiry_year' | |
| autotransaction_id: | |
| description: Auto-transaction ID generated for the payment made. | |
| type: string | |
| example: '90300000079465' | |
| avatax_exempt_no: | |
| description: Exemption certificate number of the customer. | |
| type: string | |
| x-node_available_in: | |
| - Avalara Integration | |
| x-node_unavailable_in: [] | |
| avatax_tax_code: | |
| description: A tax code is a unique label used to group Items (products, services, | |
| or charges) together. Refer the [link][2] for more deails. Max-length [25] | |
| type: string | |
| x-node_available_in: | |
| - Avalara Integration | |
| x-node_unavailable_in: [] | |
| avatax_tax_code_desc: | |
| description: Description of the Ava Tax Code Used | |
| type: string | |
| x-node_available_in: | |
| - Avalara Integration | |
| x-node_unavailable_in: [] | |
| avatax_tax_code_id: | |
| description: ID of the Ava Tax Code Used | |
| type: string | |
| x-node_available_in: | |
| - Avalara Integration | |
| x-node_unavailable_in: [] | |
| avatax_use_code: | |
| description: Used to group like customers for exemption purposes. It is a custom | |
| value that links customers to a tax rule. Select from Avalara [standard codes][1] | |
| or enter a custom code. | |
| type: string | |
| x-node_available_in: | |
| - Avalara Integration | |
| x-node_unavailable_in: [] | |
| avatax_use_code_desc: | |
| description: Description of the Avalra Use Code Used. | |
| type: string | |
| x-node_available_in: | |
| - Avalara Integration | |
| x-node_unavailable_in: [] | |
| avatax_use_code_id: | |
| description: ID of Avalara Tax Code Used. | |
| type: string | |
| x-node_available_in: | |
| - Avalara Integration | |
| x-node_unavailable_in: [] | |
| balance: | |
| description: Balance present in the account | |
| type: number | |
| format: double | |
| example: 0 | |
| balance_amount: | |
| description: Unpaid amount of the invoice. | |
| type: number | |
| format: double | |
| example: 0 | |
| bank_account_number: | |
| description: Number of the Bank Account | |
| type: string | |
| bank_balance: | |
| description: Balance present in the Bank | |
| type: integer | |
| example: 0 | |
| bank_charges: | |
| description: Bank Charges applied to the transaction | |
| type: number | |
| format: double | |
| example: 0 | |
| bank_name: | |
| description: Name of the Bank | |
| type: string | |
| example: Xavier Bank | |
| bankaccount: | |
| type: object | |
| properties: | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| account_name: | |
| $ref: '#/components/schemas/account_name' | |
| account_code: | |
| $ref: '#/components/schemas/account_code' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| currency_code: | |
| $ref: '#/components/schemas/currency_code' | |
| currency_symbol: | |
| $ref: '#/components/schemas/currency_symbol' | |
| price_precision: | |
| $ref: '#/components/schemas/price_precision' | |
| account_type: | |
| $ref: '#/components/schemas/account_type' | |
| account_number: | |
| $ref: '#/components/schemas/account_number' | |
| uncategorized_transactions: | |
| $ref: '#/components/schemas/uncategorized_transactions' | |
| total_unprinted_checks: | |
| $ref: '#/components/schemas/total_unprinted_checks' | |
| is_active: | |
| $ref: '#/components/schemas/is_active' | |
| is_feeds_subscribed: | |
| $ref: '#/components/schemas/is_feeds_subscribed' | |
| is_feeds_active: | |
| $ref: '#/components/schemas/is_feeds_active' | |
| balance: | |
| $ref: '#/components/schemas/balance' | |
| bank_balance: | |
| $ref: '#/components/schemas/bank_balance' | |
| bcy_balance: | |
| $ref: '#/components/schemas/bcy_balance' | |
| bank_name: | |
| $ref: '#/components/schemas/bank_name' | |
| routing_number: | |
| $ref: '#/components/schemas/routing_number' | |
| is_primary_account: | |
| $ref: '#/components/schemas/is_primary_account' | |
| is_paypal_account: | |
| $ref: '#/components/schemas/is_paypal_account' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| refresh_status_code: | |
| $ref: '#/components/schemas/refresh_status_code' | |
| feeds_last_refresh_date: | |
| $ref: '#/components/schemas/feeds_last_refresh_date' | |
| service_id: | |
| $ref: '#/components/schemas/service_id' | |
| is_system_account: | |
| $ref: '#/components/schemas/is_system_account' | |
| is_show_warning_for_feeds_refresh: | |
| $ref: '#/components/schemas/is_show_warning_for_feeds_refresh' | |
| bankaccounts: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| account_name: | |
| $ref: '#/components/schemas/account_name' | |
| account_code: | |
| $ref: '#/components/schemas/account_code' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| currency_code: | |
| $ref: '#/components/schemas/currency_code' | |
| account_type: | |
| $ref: '#/components/schemas/account_type' | |
| uncategorized_transactions: | |
| $ref: '#/components/schemas/uncategorized_transactions' | |
| total_unprinted_checks: | |
| $ref: '#/components/schemas/total_unprinted_checks' | |
| is_active: | |
| $ref: '#/components/schemas/is_active' | |
| balance: | |
| $ref: '#/components/schemas/balance' | |
| bank_balance: | |
| $ref: '#/components/schemas/bank_balance' | |
| bcy_balance: | |
| $ref: '#/components/schemas/bcy_balance' | |
| bank_name: | |
| $ref: '#/components/schemas/bank_name' | |
| banktransaction: | |
| type: object | |
| properties: | |
| transaction_id: | |
| $ref: '#/components/schemas/transaction_id' | |
| from_account_id: | |
| $ref: '#/components/schemas/from_account_id' | |
| from_account_name: | |
| $ref: '#/components/schemas/from_account_name' | |
| to_account_id: | |
| $ref: '#/components/schemas/to_account_id' | |
| to_account_name: | |
| $ref: '#/components/schemas/to_account_name' | |
| transaction_type: | |
| $ref: '#/components/schemas/transaction_type' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| currency_code: | |
| $ref: '#/components/schemas/currency_code' | |
| payment_mode: | |
| $ref: '#/components/schemas/payment_mode' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| customer_name: | |
| $ref: '#/components/schemas/customer_name' | |
| vendor_id: | |
| $ref: '#/components/schemas/vendor_id' | |
| vendor_name: | |
| $ref: '#/components/schemas/vendor_name' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| bank_charges: | |
| $ref: '#/components/schemas/bank_charges' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| documents: | |
| $ref: '#/components/schemas/documents' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| tax_name: | |
| $ref: '#/components/schemas/tax_name' | |
| tax_percentage: | |
| $ref: '#/components/schemas/tax_percentage' | |
| tax_amount: | |
| $ref: '#/components/schemas/tax_amount' | |
| sub_total: | |
| $ref: '#/components/schemas/sub_total' | |
| tax_authority_id: | |
| $ref: '#/components/schemas/tax_authority_id' | |
| tax_authority_name: | |
| $ref: '#/components/schemas/tax_authority_name' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| tax_exemption_code: | |
| $ref: '#/components/schemas/tax_exemption_code' | |
| total: | |
| $ref: '#/components/schemas/total' | |
| bcy_total: | |
| $ref: '#/components/schemas/bcy_total' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| product_type: | |
| $ref: '#/components/schemas/product_type' | |
| acquisition_vat_id: | |
| $ref: '#/components/schemas/acquisition_vat_id' | |
| acquisition_vat_name: | |
| $ref: '#/components/schemas/acquisition_vat_name' | |
| acquisition_vat_percentage: | |
| $ref: '#/components/schemas/acquisition_vat_percentage' | |
| acquisition_vat_amount: | |
| $ref: '#/components/schemas/acquisition_vat_amount' | |
| reverse_charge_vat_id: | |
| $ref: '#/components/schemas/reverse_charge_vat_id' | |
| reverse_charge_vat_name: | |
| $ref: '#/components/schemas/reverse_charge_vat_name' | |
| reverse_charge_vat_percentage: | |
| $ref: '#/components/schemas/reverse_charge_vat_percentage' | |
| reverse_charge_vat_amount: | |
| $ref: '#/components/schemas/reverse_charge_vat_amount' | |
| reverse_charge_tax_id: | |
| $ref: '#/components/schemas/reverse_charge_tax_id' | |
| filed_in_vat_return_id: | |
| $ref: '#/components/schemas/filed_in_vat_return_id' | |
| filed_in_vat_return_name: | |
| $ref: '#/components/schemas/filed_in_vat_return_name' | |
| filed_in_vat_return_type: | |
| $ref: '#/components/schemas/filed_in_vat_return_type' | |
| imported_transactions: | |
| $ref: '#/components/schemas/imported_transactions' | |
| tags: | |
| $ref: '#/components/schemas/tags_response' | |
| line_items: | |
| $ref: '#/components/schemas/line_items' | |
| base_currency_adjustment_id: | |
| description: ID of the Base Currency Adjustment | |
| type: string | |
| example: '460000000039001' | |
| bcc_mail_ids: | |
| description: Array of email address of the recipients to be BCC ed. | |
| type: array | |
| items: | |
| type: string | |
| example: | |
| - mark@safInstruments.com | |
| bcc_mails: | |
| type: array | |
| items: | |
| type: string | |
| bcc_mails_str: | |
| type: string | |
| example: '' | |
| bcy_amount: | |
| type: string | |
| example: 450 | |
| bcy_balance: | |
| description: Balance in Base Currency | |
| type: number | |
| format: double | |
| example: 0 | |
| bcy_rate: | |
| description: Rate in Base Currency of the Organization | |
| type: integer | |
| example: 40 | |
| bcy_total: | |
| description: Total in Base Currency of the Organisation | |
| type: integer | |
| example: 33 | |
| bcy_total_without_tax: | |
| type: number | |
| format: double | |
| example: 100 | |
| begin_time: | |
| type: string | |
| example: 03:00 | |
| bill: | |
| type: object | |
| properties: | |
| bill_id: | |
| $ref: '#/components/schemas/bill_id' | |
| purchaseorder_ids: | |
| $ref: '#/components/schemas/purchaseorder_ids' | |
| vendor_id: | |
| $ref: '#/components/schemas/vendor_id' | |
| vendor_name: | |
| $ref: '#/components/schemas/vendor_name' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| vat_reg_no: | |
| $ref: '#/components/schemas/vat_reg_no' | |
| source_of_supply: | |
| $ref: '#/components/schemas/source_of_supply' | |
| destination_of_supply: | |
| $ref: '#/components/schemas/destination_of_supply' | |
| place_of_supply: | |
| $ref: '#/components/schemas/place_of_supply' | |
| permit_number: | |
| $ref: '#/components/schemas/permit_number' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| gst_treatment: | |
| $ref: '#/components/schemas/gst_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| is_pre_gst: | |
| $ref: '#/components/schemas/is_pre_gst' | |
| pricebook_id: | |
| $ref: '#/components/schemas/pricebook_id' | |
| pricebook_name: | |
| $ref: '#/components/schemas/pricebook_name' | |
| is_reverse_charge_applied: | |
| $ref: '#/components/schemas/is_reverse_charge_applied' | |
| unused_credits_payable_amount: | |
| $ref: '#/components/schemas/unused_credits_payable_amount' | |
| status: | |
| $ref: '#/components/schemas/status' | |
| bill_number: | |
| $ref: '#/components/schemas/bill_number' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| due_date: | |
| $ref: '#/components/schemas/due_date' | |
| payment_terms: | |
| $ref: '#/components/schemas/payment_terms' | |
| payment_terms_label: | |
| $ref: '#/components/schemas/payment_terms_label' | |
| payment_expected_date: | |
| $ref: '#/components/schemas/payment_expected_date' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| recurring_bill_id: | |
| $ref: '#/components/schemas/recurring_bill_id' | |
| due_by_days: | |
| $ref: '#/components/schemas/due_by_days' | |
| due_in_days: | |
| $ref: '#/components/schemas/due_in_days' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| currency_code: | |
| $ref: '#/components/schemas/currency_code' | |
| currency_symbol: | |
| $ref: '#/components/schemas/currency_symbol' | |
| documents: | |
| $ref: '#/components/schemas/documents' | |
| price_precision: | |
| $ref: '#/components/schemas/price_precision' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| adjustment: | |
| $ref: '#/components/schemas/adjustment' | |
| adjustment_description: | |
| $ref: '#/components/schemas/adjustment_description' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| tags: | |
| $ref: '#/components/schemas/tags_response' | |
| is_tds_applied: | |
| $ref: '#/components/schemas/is_tds_applied' | |
| is_item_level_tax_calc: | |
| $ref: '#/components/schemas/is_item_level_tax_calc' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| filed_in_vat_return_id: | |
| $ref: '#/components/schemas/filed_in_vat_return_id' | |
| filed_in_vat_return_name: | |
| $ref: '#/components/schemas/filed_in_vat_return_name' | |
| filed_in_vat_return_type: | |
| $ref: '#/components/schemas/filed_in_vat_return_type' | |
| is_abn_quoted: | |
| $ref: '#/components/schemas/is_abn_quoted' | |
| line_items: | |
| $ref: '#/components/schemas/line_items' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| location_name: | |
| $ref: '#/components/schemas/location_name' | |
| sub_total: | |
| $ref: '#/components/schemas/sub_total' | |
| tax_total: | |
| $ref: '#/components/schemas/tax_total' | |
| total: | |
| $ref: '#/components/schemas/total' | |
| payment_made: | |
| $ref: '#/components/schemas/payment_made' | |
| vendor_credits_applied: | |
| $ref: '#/components/schemas/vendor_credits_applied' | |
| is_line_item_invoiced: | |
| $ref: '#/components/schemas/is_line_item_invoiced' | |
| purchaseorders: | |
| $ref: '#/components/schemas/purchaseorders' | |
| taxes: | |
| $ref: '#/components/schemas/taxes' | |
| acquisition_vat_summary: | |
| $ref: '#/components/schemas/acquisition_vat_summary' | |
| acquisition_vat_total: | |
| $ref: '#/components/schemas/acquisition_vat_total' | |
| reverse_charge_vat_summary: | |
| $ref: '#/components/schemas/reverse_charge_vat_summary' | |
| reverse_charge_vat_total: | |
| $ref: '#/components/schemas/reverse_charge_vat_total' | |
| balance: | |
| $ref: '#/components/schemas/balance' | |
| billing_address: | |
| $ref: '#/components/schemas/billing_address' | |
| payments: | |
| $ref: '#/components/schemas/payments' | |
| vendor_credits: | |
| $ref: '#/components/schemas/vendor_credits' | |
| created_time: | |
| $ref: '#/components/schemas/created_time' | |
| created_by_id: | |
| $ref: '#/components/schemas/created_by_id' | |
| last_modified_time: | |
| $ref: '#/components/schemas/last_modified_time' | |
| reference_id: | |
| $ref: '#/components/schemas/reference_id' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| terms: | |
| $ref: '#/components/schemas/terms' | |
| attachment_name: | |
| $ref: '#/components/schemas/attachment_name' | |
| open_purchaseorders_count: | |
| $ref: '#/components/schemas/open_purchaseorders_count' | |
| bill_id: | |
| description: ID of the Bill | |
| type: string | |
| example: '460000000053199' | |
| bill_item_id: | |
| type: string | |
| description: Unique identifier of the specific bill line item to be converted | |
| to an invoice line item. This allows you to convert individual line items | |
| from a bill rather than the entire bill, providing granular control over bill-to-invoice | |
| conversion. | |
| example: ' ' | |
| bill_number: | |
| description: Unique sequential identifier for the bill. Used for tracking and | |
| reference purposes. Format varies by organization settings. Can be auto-generated | |
| or manually entered. Must be unique within the organization. | |
| type: string | |
| example: '00454' | |
| bill_numbers: | |
| description: Numbers of the bill | |
| type: string | |
| bill_payment_id: | |
| description: ID of the Bill Payment | |
| type: string | |
| bill_payments: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| payment_id: | |
| $ref: '#/components/schemas/payment_id' | |
| amount_applied: | |
| $ref: '#/components/schemas/amount_applied' | |
| bill_template_id: | |
| description: Default bill template id used for this vendor while creating bill. | |
| type: string | |
| example: 460000000000103 | |
| billable_amount: | |
| type: number | |
| format: double | |
| example: 500 | |
| billable_hours: | |
| type: string | |
| example: '12:26' | |
| billed_amount: | |
| type: number | |
| format: double | |
| example: 500 | |
| billed_hours: | |
| type: string | |
| example: '12:27' | |
| billed_status: | |
| type: string | |
| example: unbilled | |
| billing_address: | |
| type: object | |
| properties: | |
| address: | |
| $ref: '#/components/schemas/address' | |
| street2: | |
| $ref: '#/components/schemas/street2' | |
| city: | |
| $ref: '#/components/schemas/city' | |
| state: | |
| $ref: '#/components/schemas/state' | |
| zip: | |
| $ref: '#/components/schemas/zip' | |
| country: | |
| $ref: '#/components/schemas/country' | |
| fax: | |
| $ref: '#/components/schemas/fax' | |
| attention: | |
| $ref: '#/components/schemas/attention' | |
| billing_address_id: | |
| description: Unique identifier of the billing address to be used for this invoice. | |
| Use the `billing_address_id` returned by the Addresses API for the same customer | |
| and organization. This address appears on the invoice document and is used | |
| for billing purposes. If omitted, the customer's default billing address will | |
| be used. | |
| type: string | |
| example: '218500000000142012' | |
| billing_type: | |
| description: 'The way you bill your customer. Allowed Values: <code>fixed_cost_for_project</code>, | |
| <code>based_on_project_hours</code>, <code>based_on_staff_hours</code> and | |
| <code>based_on_task_hours</code>' | |
| type: string | |
| example: fixed_cost_for_project | |
| bills: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| bill_payment_id: | |
| $ref: '#/components/schemas/bill_payment_id' | |
| bill_id: | |
| $ref: '#/components/schemas/bill_id' | |
| amount_applied: | |
| $ref: '#/components/schemas/amount_applied' | |
| tax_amount_withheld: | |
| $ref: '#/components/schemas/tax_amount_withheld' | |
| bills_credited: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| bill_id: | |
| description: ID of the Bill Credited | |
| type: string | |
| example: '460000000057075' | |
| vendor_credit_bill_id: | |
| $ref: '#/components/schemas/vendor_credit_bill_id' | |
| date: | |
| description: Date of the Bill Credit | |
| type: string | |
| example: '2014-08-28' | |
| bill_number: | |
| description: Number of the Bill Credited | |
| type: string | |
| amount: | |
| description: Amount that is credited in the bill | |
| type: number | |
| format: double | |
| example: 13 | |
| body: | |
| description: Body of an email has to be sent. Max-length [5000] | |
| type: string | |
| example: Dear Customer, <br/>We have attached with this email a list of | |
| all your transactions with us for the period 01 Sep 2013 to 30 Sep 2013. You | |
| can write to us or call us if you need any assistance or clarifications. <br/>Thanks | |
| for your business.<br/>Regards<br/>Zillium Inc | |
| body_alias: | |
| description: The body of the email. | |
| type: string | |
| example: true | |
| budget_amount: | |
| type: string | |
| example: ' ' | |
| budget_hours: | |
| description: Task budget hours. | |
| type: string | |
| example: '0' | |
| budget_type: | |
| type: string | |
| example: ' ' | |
| bulk-delete-customer-payments-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The selected customer payments have been deleted. | |
| readOnly: true | |
| bulk-delete-vendor-payments-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The selected vendor payments have been deleted. | |
| readOnly: true | |
| bulk-export-estimates-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Invalid value passed for estimate_ids | |
| readOnly: true | |
| bulk-export-invoices-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| bulk-export-sales-orders-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| bulk-fetch-item-details-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| items: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| item_id: | |
| $ref: '#/components/schemas/item_id' | |
| name: | |
| $ref: '#/components/schemas/name' | |
| status: | |
| $ref: '#/components/schemas/status' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| unit: | |
| $ref: '#/components/schemas/unit' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| purchase_tax_rule_id: | |
| $ref: '#/components/schemas/purchase_tax_rule_id' | |
| sales_tax_rule_id: | |
| $ref: '#/components/schemas/sales_tax_rule_id' | |
| tax_name: | |
| $ref: '#/components/schemas/tax_name' | |
| tax_percentage: | |
| $ref: '#/components/schemas/tax_percentage' | |
| tax_type: | |
| $ref: '#/components/schemas/tax_type' | |
| sku: | |
| $ref: '#/components/schemas/sku' | |
| product_type: | |
| $ref: '#/components/schemas/product_type' | |
| sat_item_key_code: | |
| $ref: '#/components/schemas/sat_item_key_code' | |
| unitkey_code: | |
| $ref: '#/components/schemas/unitkey_code' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| page_context: | |
| description: The context of a particular page. | |
| type: object | |
| properties: | |
| page: | |
| $ref: '#/components/schemas/page' | |
| per_page: | |
| $ref: '#/components/schemas/per_page' | |
| has_more_page: | |
| $ref: '#/components/schemas/has_more_page' | |
| report_name: | |
| $ref: '#/components/schemas/report_name' | |
| sort_column: | |
| $ref: '#/components/schemas/sort_column' | |
| sort_order: | |
| $ref: '#/components/schemas/sort_order' | |
| bulk-invoice-reminder-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| info: | |
| type: object | |
| properties: | |
| email_success_info: | |
| type: object | |
| properties: | |
| message: | |
| type: string | |
| example: The reminders were successfully sent | |
| sent_count: | |
| type: integer | |
| example: 2 | |
| email_errors_info: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| message: | |
| type: string | |
| example: The reminders were successfully sent | |
| ids: | |
| type: array | |
| items: | |
| type: string | |
| example: '2000000007037' | |
| code: | |
| type: integer | |
| example: 4083 | |
| bulk-print-estimates-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| bulk-print-invoices-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| bulk-print-sales-orders-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| bulk-update-custom-module-request: | |
| required: | |
| - record_name | |
| type: object | |
| properties: | |
| cf_debt_amount: | |
| $ref: '#/components/schemas/cf_debt_amount' | |
| module_record_id: | |
| $ref: '#/components/schemas/module_record_ids' | |
| record_name: | |
| description: Name of the record | |
| type: string | |
| example: Alice | |
| bulk-update-custom-module-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Bulk update successfull | |
| readOnly: true | |
| module_record: | |
| $ref: '#/components/schemas/module_record_module_put' | |
| can_approve: | |
| description: To get whether the record can be approved | |
| type: boolean | |
| example: false | |
| can_mark_as_bill: | |
| type: boolean | |
| example: false | |
| can_mark_as_unbill: | |
| type: boolean | |
| example: false | |
| can_reclaim_vat_on_mileage: | |
| description: Check if VAT can be reclaimed on mileage | |
| type: boolean | |
| x-node_available_in: | |
| - uk | |
| - eu | |
| x-node_unavailable_in: [] | |
| can_send_in_mail: | |
| type: boolean | |
| example: true | |
| can_show_in_ze: | |
| type: boolean | |
| example: false | |
| can_submit: | |
| description: Whether the record can be submitted | |
| type: boolean | |
| example: false | |
| cancel-a-purchase-order-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The purchase order has been cancelled. | |
| readOnly: true | |
| cancel-write-off-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The write off done for this invoice has been cancelled. | |
| readOnly: true | |
| card_id: | |
| description: Card ID of the card associated with the transaction. | |
| type: string | |
| example: '90300000079226' | |
| categorize-a-vendor-payment-request: | |
| type: object | |
| properties: | |
| vendor_id: | |
| $ref: '#/components/schemas/vendor_id' | |
| bills: | |
| $ref: '#/components/schemas/bills' | |
| payment_mode: | |
| $ref: '#/components/schemas/payment_mode' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| paid_through_account_id: | |
| $ref: '#/components/schemas/paid_through_account_id' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| custom_fields: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| index: | |
| $ref: '#/components/schemas/index' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| is_paid_via_print_check: | |
| $ref: '#/components/schemas/is_paid_via_print_check' | |
| check_details: | |
| $ref: '#/components/schemas/check_details' | |
| categorize-a-vendor-payment-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The transaction(s) have been categorized. | |
| readOnly: true | |
| categorize-an-uncategorized-transaction-request: | |
| required: | |
| - transaction_type | |
| type: object | |
| properties: | |
| from_account_id: | |
| $ref: '#/components/schemas/from_account_id' | |
| to_account_id: | |
| $ref: '#/components/schemas/to_account_id' | |
| transaction_type: | |
| $ref: '#/components/schemas/transaction_type' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| payment_mode: | |
| $ref: '#/components/schemas/payment_mode' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| documents: | |
| $ref: '#/components/schemas/documents' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| to_account_tags: | |
| $ref: '#/components/schemas/tags' | |
| from_account_tags: | |
| $ref: '#/components/schemas/tags' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| bank_charges: | |
| $ref: '#/components/schemas/bank_charges' | |
| user_id: | |
| $ref: '#/components/schemas/user_id' | |
| tax_authority_id: | |
| $ref: '#/components/schemas/tax_authority_id' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| line_items: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| line_id: | |
| $ref: '#/components/schemas/line_id' | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| account_name: | |
| $ref: '#/components/schemas/account_name' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| tax_amount: | |
| $ref: '#/components/schemas/tax_amount' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tax_name: | |
| $ref: '#/components/schemas/tax_name' | |
| tax_type: | |
| $ref: '#/components/schemas/tax_type' | |
| tax_percentage: | |
| $ref: '#/components/schemas/tax_percentage' | |
| item_total: | |
| $ref: '#/components/schemas/item_total' | |
| item_total_inclusive_of_tax: | |
| $ref: '#/components/schemas/item_total_inclusive_of_tax' | |
| item_order: | |
| $ref: '#/components/schemas/item_order' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| categorize-an-uncategorized-transaction-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The transaction(s) have been categorized. | |
| readOnly: true | |
| categorize-as-credit-note-refunds-request: | |
| required: | |
| - creditnote_id | |
| - date | |
| type: object | |
| properties: | |
| creditnote_id: | |
| $ref: '#/components/schemas/creditnote_id' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| refund_mode: | |
| $ref: '#/components/schemas/refund_mode' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| from_account_id: | |
| $ref: '#/components/schemas/from_account_id' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| categorize-as-credit-note-refunds-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The transaction(s) have been categorized. | |
| readOnly: true | |
| categorize-as-customer-payment-refund-request: | |
| required: | |
| - date | |
| - amount | |
| - from_account_id | |
| type: object | |
| properties: | |
| date: | |
| $ref: '#/components/schemas/date' | |
| refund_mode: | |
| $ref: '#/components/schemas/refund_mode' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| from_account_id: | |
| $ref: '#/components/schemas/from_account_id' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| categorize-as-customer-payment-refund-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The transaction(s) have been categorized. | |
| readOnly: true | |
| categorize-as-customer-payment-request: | |
| type: object | |
| properties: | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| retainerinvoice_id: | |
| $ref: '#/components/schemas/retainerinvoice_id' | |
| invoices: | |
| $ref: '#/components/schemas/invoices' | |
| payment_mode: | |
| $ref: '#/components/schemas/payment_mode' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| bank_charges: | |
| $ref: '#/components/schemas/bank_charges' | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| custom_fields: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| index: | |
| $ref: '#/components/schemas/index' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| documents: | |
| $ref: '#/components/schemas/documents' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| template_id: | |
| $ref: '#/components/schemas/template_id' | |
| contact_persons: | |
| $ref: '#/components/schemas/contact_persons' | |
| categorize-as-customer-payment-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The transaction(s) have been categorized. | |
| readOnly: true | |
| categorize-as-expense-request: | |
| type: object | |
| properties: | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| paid_through_account_id: | |
| $ref: '#/components/schemas/paid_through_account_id' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| project_id: | |
| $ref: '#/components/schemas/project_id' | |
| tax_exemption_code: | |
| $ref: '#/components/schemas/tax_exemption_code' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| is_billable: | |
| $ref: '#/components/schemas/is_billable' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| zp_project_id: | |
| $ref: '#/components/schemas/zp_project_id' | |
| zp_project_name: | |
| $ref: '#/components/schemas/zp_project_name' | |
| zp_client_id: | |
| $ref: '#/components/schemas/zp_client_id' | |
| vendor_id: | |
| $ref: '#/components/schemas/vendor_id' | |
| vehicle_id: | |
| $ref: '#/components/schemas/vehicle_id' | |
| mileage_unit: | |
| $ref: '#/components/schemas/mileage_unit' | |
| mileage_rate: | |
| $ref: '#/components/schemas/mileage_rate' | |
| can_reclaim_vat_on_mileage: | |
| $ref: '#/components/schemas/can_reclaim_vat_on_mileage' | |
| fuel_type: | |
| $ref: '#/components/schemas/fuel_type' | |
| engine_capacity_range: | |
| $ref: '#/components/schemas/engine_capacity_range' | |
| employee_id: | |
| $ref: '#/components/schemas/employee_id' | |
| mileage_type: | |
| $ref: '#/components/schemas/mileage_type' | |
| expense_type: | |
| $ref: '#/components/schemas/expense_type' | |
| distance: | |
| $ref: '#/components/schemas/distance' | |
| start_reading: | |
| $ref: '#/components/schemas/start_reading' | |
| end_reading: | |
| $ref: '#/components/schemas/end_reading' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| custom_fields: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| index: | |
| $ref: '#/components/schemas/index' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| documents: | |
| $ref: '#/components/schemas/documents' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| recurring_expense_id: | |
| $ref: '#/components/schemas/recurring_expense_id' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| acquisition_vat_id: | |
| $ref: '#/components/schemas/acquisition_vat_id' | |
| reverse_charge_vat_id: | |
| $ref: '#/components/schemas/reverse_charge_vat_id' | |
| is_update_customer: | |
| $ref: '#/components/schemas/is_update_customer' | |
| product_type: | |
| $ref: '#/components/schemas/product_type' | |
| taxes: | |
| $ref: '#/components/schemas/taxes' | |
| reason: | |
| $ref: '#/components/schemas/reason' | |
| line_items: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| line_item_id: | |
| $ref: '#/components/schemas/line_item_id' | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| item_order: | |
| $ref: '#/components/schemas/item_order' | |
| product_type: | |
| $ref: '#/components/schemas/product_type' | |
| acquisition_vat_id: | |
| $ref: '#/components/schemas/acquisition_vat_id' | |
| reverse_charge_vat_id: | |
| $ref: '#/components/schemas/reverse_charge_vat_id' | |
| tax_exemption_code: | |
| $ref: '#/components/schemas/tax_exemption_code' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| zcrm_potential_id: | |
| $ref: '#/components/schemas/zcrm_potential_id' | |
| categorize-as-expense-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The transaction(s) have been categorized. | |
| readOnly: true | |
| categorize-as-vendor-credit-refunds-request: | |
| required: | |
| - vendor_credit_id | |
| - date | |
| type: object | |
| properties: | |
| vendor_credit_id: | |
| $ref: '#/components/schemas/vendor_credit_id' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| refund_mode: | |
| $ref: '#/components/schemas/refund_mode' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| categorize-as-vendor-credit-refunds-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The transaction(s) have been categorized. | |
| readOnly: true | |
| categorize-as-vendor-payment-refund-request: | |
| required: | |
| - date | |
| - amount | |
| - to_account_id | |
| type: object | |
| properties: | |
| vendorpayment_id: | |
| $ref: '#/components/schemas/vendorpayment_id' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| refund_mode: | |
| $ref: '#/components/schemas/refund_mode' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| to_account_id: | |
| $ref: '#/components/schemas/to_account_id' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| categorize-as-vendor-payment-refund-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The transaction(s) have been categorized. | |
| readOnly: true | |
| categorized_transaction_id: | |
| type: string | |
| example: '460000000052051' | |
| cc_mail_ids: | |
| description: Array of email address of the recipients to be cced. | |
| type: array | |
| items: | |
| type: string | |
| example: | |
| - peterparker@bowmanfurniture.com | |
| cc_mail_ids_alias: | |
| description: The email IDs that have to be copied when the credit note is to | |
| be mailed. | |
| type: array | |
| items: | |
| type: string | |
| example: true | |
| cc_mails_list: | |
| type: array | |
| items: | |
| type: string | |
| cc_mails_str: | |
| type: string | |
| example: '' | |
| cf_debt_amount: | |
| description: Value of the custom Field | |
| type: number | |
| example: 10000 | |
| cf_debt_amount_formatted: | |
| description: The formatted value of the custom Field | |
| type: string | |
| example: ₹10,000.00 | |
| cfdi_reference_type: | |
| description: 'Choose CFDI Reference Type.</br>Allowed values: <code>credit_note</code>, | |
| <code>debit_note</code>, <code>return_of_merchandise</code>, <code>substitution_previous_cfdi</code>, | |
| <code>transfer_of_goods</code>, <code>invoice_generated_from_order</code>, | |
| <code>cfdi_for_advance</code>.' | |
| type: string | |
| example: return_of_merchandise | |
| x-node_available_in: | |
| - mx | |
| x-node_unavailable_in: [] | |
| cfdi_usage: | |
| description: 'Choose CFDI Usage.</br>Allowed values: <code>acquisition_of_merchandise</code>, | |
| <code>return_discount_bonus</code>, <code>general_expense</code>, <code>buildings</code>, | |
| <code>furniture_office_equipment</code>, <code>transport_equipment</code>, | |
| <code>computer_equipmentdye_molds_tools</code>, <code>telephone_communication</code>, | |
| <code>satellite_communication</code>, <code>other_machinery_equipment</code>, | |
| <code>hospital_expense</code>, <code>medical_expense_disability</code>, <code>funeral_expense</code>, | |
| <code>donation</code>, <code>interest_mortage_loans</code>, <code>contribution_sar</code>, | |
| <code>medical_expense_insurance_pormium</code>, <code>school_transportation_expense</code>, | |
| <code>deposit_saving_account</code>, <code>payment_educational_service</code>, | |
| <code>no_tax_effect</code>, <code>payment</code>, <code>payroll</code>.' | |
| type: string | |
| example: acquisition_of_merchandise | |
| x-node_available_in: | |
| - mx | |
| x-node_unavailable_in: [] | |
| chart_of_account: | |
| type: object | |
| properties: | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| account_name: | |
| $ref: '#/components/schemas/account_name' | |
| account_code: | |
| $ref: '#/components/schemas/account_code' | |
| is_active: | |
| $ref: '#/components/schemas/is_active' | |
| account_type: | |
| $ref: '#/components/schemas/account_type' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| currency_code: | |
| $ref: '#/components/schemas/currency_code' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| is_system_account: | |
| $ref: '#/components/schemas/is_system_account' | |
| is_involved_in_transaction: | |
| $ref: '#/components/schemas/is_involved_in_transaction' | |
| can_show_in_ze: | |
| $ref: '#/components/schemas/can_show_in_ze' | |
| include_in_vat_return: | |
| $ref: '#/components/schemas/include_in_vat_return' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| parent_account_id: | |
| $ref: '#/components/schemas/parent_account_id' | |
| documents: | |
| $ref: '#/components/schemas/documents' | |
| created_time: | |
| $ref: '#/components/schemas/created_time' | |
| last_modified_time: | |
| $ref: '#/components/schemas/last_modified_time' | |
| check_details: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| memo: | |
| $ref: '#/components/schemas/memo' | |
| check_number: | |
| $ref: '#/components/schemas/check_number' | |
| check_id: | |
| description: ID of the Check created | |
| type: string | |
| check_number: | |
| description: Number of the Check Created | |
| type: string | |
| check_status: | |
| description: Status of the Check | |
| type: string | |
| child_count: | |
| type: string | |
| city: | |
| description: City present in the Address | |
| type: string | |
| client_viewed_time: | |
| type: string | |
| example: 2016-06-19T05:49:12-0500 | |
| clone-project-request: | |
| required: | |
| - project_name | |
| type: object | |
| properties: | |
| project_name: | |
| description: Name of the project. <code>Max-length [100]</code> | |
| type: string | |
| example: Network Distribution | |
| description: | |
| description: Project description. <code>Max-length [500]</code> | |
| type: string | |
| example: Distribution for the system of intermediaries between the producer | |
| of goods and/or services and the final user | |
| clone-project-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Project has been cloned successfully. | |
| readOnly: true | |
| project: | |
| type: object | |
| properties: | |
| project_id: | |
| $ref: '#/components/schemas/project_id' | |
| project_name: | |
| $ref: '#/components/schemas/project_name' | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| customer_name: | |
| $ref: '#/components/schemas/customer_name' | |
| currency_code: | |
| $ref: '#/components/schemas/currency_code' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| status: | |
| $ref: '#/components/schemas/status' | |
| billing_type: | |
| $ref: '#/components/schemas/billing_type' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| budget_type: | |
| $ref: '#/components/schemas/budget_type' | |
| total_hours: | |
| $ref: '#/components/schemas/total_hours' | |
| total_amount: | |
| $ref: '#/components/schemas/total_amount' | |
| billed_hours: | |
| $ref: '#/components/schemas/billed_hours' | |
| billed_amount: | |
| $ref: '#/components/schemas/billed_amount' | |
| un_billed_hours: | |
| $ref: '#/components/schemas/un_billed_hours' | |
| un_billed_amount: | |
| $ref: '#/components/schemas/un_billed_amount' | |
| billable_hours: | |
| $ref: '#/components/schemas/billable_hours' | |
| billable_amount: | |
| $ref: '#/components/schemas/billable_amount' | |
| cost_budget_amount: | |
| $ref: '#/components/schemas/cost_budget_amount' | |
| non_billable_hours: | |
| $ref: '#/components/schemas/non_billable_hours' | |
| non_billable_amount: | |
| $ref: '#/components/schemas/non_billable_amount' | |
| is_recurrence_associated: | |
| $ref: '#/components/schemas/is_recurrence_associated' | |
| recurring_invoices: | |
| $ref: '#/components/schemas/recurring_invoices' | |
| created_time: | |
| $ref: '#/components/schemas/created_time' | |
| show_in_dashboard: | |
| $ref: '#/components/schemas/show_in_dashboard' | |
| tasks: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| task_id: | |
| $ref: '#/components/schemas/task_id' | |
| task_name: | |
| $ref: '#/components/schemas/task_name' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| budget_hours: | |
| $ref: '#/components/schemas/budget_hours' | |
| total_hours: | |
| $ref: '#/components/schemas/total_hours' | |
| billed_hours: | |
| $ref: '#/components/schemas/billed_hours' | |
| un_billed_hours: | |
| $ref: '#/components/schemas/un_billed_hours' | |
| non_billable_hours: | |
| $ref: '#/components/schemas/non_billable_hours' | |
| status: | |
| $ref: '#/components/schemas/status' | |
| is_billable: | |
| $ref: '#/components/schemas/is_billable' | |
| task_custom_fields: | |
| $ref: '#/components/schemas/task_custom_fields' | |
| users: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| user_id: | |
| $ref: '#/components/schemas/user_id' | |
| is_current_user: | |
| $ref: '#/components/schemas/is_current_user' | |
| user_name: | |
| $ref: '#/components/schemas/user_name' | |
| email: | |
| $ref: '#/components/schemas/email' | |
| user_role: | |
| $ref: '#/components/schemas/user_role' | |
| status: | |
| $ref: '#/components/schemas/status' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| budget_hours: | |
| $ref: '#/components/schemas/budget_hours' | |
| total_hours: | |
| $ref: '#/components/schemas/total_hours' | |
| billed_hours: | |
| $ref: '#/components/schemas/billed_hours' | |
| un_billed_hours: | |
| $ref: '#/components/schemas/un_billed_hours' | |
| cost_rate: | |
| $ref: '#/components/schemas/cost_rate' | |
| closing_balance: | |
| description: Closing balances of the account | |
| type: number | |
| format: double | |
| example: 0 | |
| code: | |
| description: Unique code or SKU for the line item. Used for product identification | |
| and inventory tracking. Helps distinguish between different variants of the | |
| same product. | |
| type: string | |
| example: basic-monthly | |
| comment: | |
| type: object | |
| properties: | |
| comment_id: | |
| $ref: '#/components/schemas/comment_id' | |
| bill_id: | |
| $ref: '#/components/schemas/bill_id' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| commented_by_id: | |
| $ref: '#/components/schemas/commented_by_id' | |
| commented_by: | |
| $ref: '#/components/schemas/commented_by' | |
| comment_type: | |
| $ref: '#/components/schemas/comment_type' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| date_description: | |
| $ref: '#/components/schemas/date_description' | |
| time: | |
| $ref: '#/components/schemas/time' | |
| comment_description: | |
| description: The description for comment. | |
| type: string | |
| example: Recurring Invoice created | |
| comment_id: | |
| description: ID of the Comment | |
| type: string | |
| example: '460000000069037' | |
| comment_type: | |
| description: Type of Comment | |
| type: string | |
| example: internal | |
| commented_by: | |
| description: Name of the User who Caused the Comment | |
| type: string | |
| example: John Roberts | |
| commented_by_id: | |
| description: ID of the User who caused the Comment | |
| type: string | |
| example: '460000000053001' | |
| comments: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| date: | |
| $ref: '#/components/schemas/date' | |
| commented_by: | |
| $ref: '#/components/schemas/commented_by' | |
| operation_type: | |
| $ref: '#/components/schemas/operation_type' | |
| comment_type: | |
| $ref: '#/components/schemas/comment_type' | |
| date_formatted: | |
| $ref: '#/components/schemas/date_formatted' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| time: | |
| $ref: '#/components/schemas/time' | |
| comment_id: | |
| $ref: '#/components/schemas/comment_id' | |
| commented_by_id: | |
| $ref: '#/components/schemas/commented_by_id' | |
| communication_preference: | |
| description: Preferred modes of communication for the contact person. | |
| type: object | |
| properties: | |
| is_sms_enabled: | |
| $ref: '#/components/schemas/is_sms_enabled' | |
| is_whatsapp_enabled: | |
| $ref: '#/components/schemas/is_whatsapp_enabled' | |
| company_id_label: | |
| description: Label denoting company ID | |
| type: string | |
| example: Company ID | |
| company_id_value: | |
| description: Value in the label "company ID" | |
| type: string | |
| example: ' ' | |
| company_name: | |
| description: Legal or registered contact's company name. Used for legal documents | |
| and formal communications. Max-length [200]. | |
| type: string | |
| example: Bowman and Co | |
| companyid_label: | |
| description: Label " Company ID " | |
| type: string | |
| example: ' ' | |
| companyid_value: | |
| description: value in field "company ID" | |
| type: string | |
| example: ' ' | |
| comparator: | |
| description: Comparator used in Criteria | |
| type: string | |
| example: greater_than_or_equals | |
| computation_type: | |
| description: 'Enter the computation types of assets. The available types are: | |
| <code>prorata_basis</code> and <code>no_prorata</code>' | |
| type: string | |
| example: prorata_basis | |
| configured: | |
| description: Boolean check to see if a payment gateway has been configured | |
| type: boolean | |
| example: true | |
| contact: | |
| description: Contact person name, involved in the transaction. | |
| type: string | |
| contact-response: | |
| type: object | |
| properties: | |
| contact_id: | |
| $ref: '#/components/schemas/contact_id' | |
| contact_name: | |
| $ref: '#/components/schemas/contact_name' | |
| company_name: | |
| $ref: '#/components/schemas/company_name' | |
| has_transaction: | |
| $ref: '#/components/schemas/has_transaction' | |
| contact_type: | |
| $ref: '#/components/schemas/contact_type' | |
| customer_sub_type: | |
| $ref: '#/components/schemas/customer_sub_type' | |
| credit_limit: | |
| $ref: '#/components/schemas/credit_limit' | |
| is_portal_enabled: | |
| $ref: '#/components/schemas/is_portal_enabled' | |
| language_code: | |
| $ref: '#/components/schemas/language_code' | |
| is_taxable: | |
| $ref: '#/components/schemas/is_taxable' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tds_tax_id: | |
| $ref: '#/components/schemas/tds_tax_id' | |
| tax_name: | |
| $ref: '#/components/schemas/tax_name' | |
| tax_percentage: | |
| $ref: '#/components/schemas/tax_percentage' | |
| tax_authority_id: | |
| $ref: '#/components/schemas/tax_authority_id' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| tax_authority_name: | |
| $ref: '#/components/schemas/tax_authority_name' | |
| tax_exemption_code: | |
| $ref: '#/components/schemas/tax_exemption_code' | |
| place_of_contact: | |
| $ref: '#/components/schemas/place_of_contact' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| tax_exemption_certificate_number: | |
| $ref: '#/components/schemas/tax_exemption_certificate_number' | |
| tax_regime: | |
| $ref: '#/components/schemas/tax_regime' | |
| legal_name: | |
| $ref: '#/components/schemas/legal_name' | |
| is_tds_registered: | |
| $ref: '#/components/schemas/is_tds_registered' | |
| gst_treatment: | |
| $ref: '#/components/schemas/gst_treatment' | |
| is_linked_with_zohocrm: | |
| $ref: '#/components/schemas/is_linked_with_zohocrm' | |
| website: | |
| $ref: '#/components/schemas/website' | |
| owner_id: | |
| $ref: '#/components/schemas/owner_id' | |
| primary_contact_id: | |
| $ref: '#/components/schemas/primary_contact_id' | |
| pricebook_id: | |
| $ref: '#/components/schemas/pricebook_id' | |
| contact_number: | |
| $ref: '#/components/schemas/contact_number' | |
| ignore_auto_number_generation: | |
| $ref: '#/components/schemas/ignore_auto_number_generation' | |
| payment_terms: | |
| $ref: '#/components/schemas/payment_terms' | |
| payment_terms_label: | |
| $ref: '#/components/schemas/payment_terms_label' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| currency_code: | |
| $ref: '#/components/schemas/currency_code' | |
| currency_symbol: | |
| $ref: '#/components/schemas/currency_symbol' | |
| opening_balances: | |
| $ref: '#/components/schemas/opening_balances' | |
| outstanding_receivable_amount: | |
| $ref: '#/components/schemas/outstanding_receivable_amount' | |
| outstanding_receivable_amount_bcy: | |
| $ref: '#/components/schemas/outstanding_receivable_amount_bcy' | |
| unused_credits_receivable_amount: | |
| $ref: '#/components/schemas/unused_credits_receivable_amount' | |
| unused_credits_receivable_amount_bcy: | |
| $ref: '#/components/schemas/unused_credits_receivable_amount_bcy' | |
| status: | |
| $ref: '#/components/schemas/status' | |
| payment_reminder_enabled: | |
| $ref: '#/components/schemas/payment_reminder_enabled' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| billing_address: | |
| $ref: '#/components/schemas/billing_address' | |
| shipping_address: | |
| $ref: '#/components/schemas/shipping_address' | |
| facebook: | |
| $ref: '#/components/schemas/facebook' | |
| twitter: | |
| $ref: '#/components/schemas/twitter' | |
| contact_persons: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| contact_person_id: | |
| $ref: '#/components/schemas/contact_person_id' | |
| salutation: | |
| $ref: '#/components/schemas/salutation' | |
| first_name: | |
| $ref: '#/components/schemas/first_name' | |
| last_name: | |
| $ref: '#/components/schemas/last_name' | |
| email: | |
| $ref: '#/components/schemas/email' | |
| phone: | |
| $ref: '#/components/schemas/phone' | |
| mobile: | |
| $ref: '#/components/schemas/mobile' | |
| designation: | |
| $ref: '#/components/schemas/designation' | |
| department: | |
| $ref: '#/components/schemas/department' | |
| skype: | |
| $ref: '#/components/schemas/skype' | |
| is_primary_contact: | |
| $ref: '#/components/schemas/is_primary_contact' | |
| communication_preference: | |
| $ref: '#/components/schemas/communication_preference' | |
| enable_portal: | |
| $ref: '#/components/schemas/enable_portal' | |
| default_templates: | |
| $ref: '#/components/schemas/default_templates' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| created_time: | |
| $ref: '#/components/schemas/created_time' | |
| last_modified_time: | |
| $ref: '#/components/schemas/last_modified_time' | |
| contact_comments: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| comment_id: | |
| $ref: '#/components/schemas/comment_id' | |
| contact_id: | |
| $ref: '#/components/schemas/contact_id' | |
| contact_name: | |
| $ref: '#/components/schemas/contact_name' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| commented_by_id: | |
| $ref: '#/components/schemas/commented_by_id' | |
| commented_by: | |
| $ref: '#/components/schemas/commented_by' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| date_description: | |
| $ref: '#/components/schemas/date_description' | |
| time: | |
| $ref: '#/components/schemas/time' | |
| transaction_id: | |
| $ref: '#/components/schemas/transaction_id' | |
| transaction_type: | |
| $ref: '#/components/schemas/transaction_type' | |
| is_entity_deleted: | |
| $ref: '#/components/schemas/is_entity_deleted' | |
| operation_type: | |
| $ref: '#/components/schemas/operation_type' | |
| contact_id: | |
| description: Contact id of the contact | |
| type: string | |
| example: 460000000026049 | |
| contact_name: | |
| description: Name of the Contact | |
| type: string | |
| example: Bowman and co | |
| contact_number: | |
| description: Contact number associated with the contact for internal tracking | |
| and identification purposes. Max-length [200]. | |
| type: string | |
| example: CNT-001234 | |
| contact_person-response: | |
| type: object | |
| properties: | |
| contact_id: | |
| $ref: '#/components/schemas/contact_id' | |
| contact_person_id: | |
| $ref: '#/components/schemas/contact_person_id' | |
| salutation: | |
| $ref: '#/components/schemas/salutation' | |
| first_name: | |
| $ref: '#/components/schemas/first_name' | |
| last_name: | |
| $ref: '#/components/schemas/last_name' | |
| email: | |
| $ref: '#/components/schemas/email' | |
| phone: | |
| $ref: '#/components/schemas/phone' | |
| mobile: | |
| $ref: '#/components/schemas/mobile' | |
| is_primary_contact: | |
| $ref: '#/components/schemas/is_primary_contact' | |
| skype: | |
| $ref: '#/components/schemas/skype' | |
| designation: | |
| $ref: '#/components/schemas/designation' | |
| department: | |
| $ref: '#/components/schemas/department' | |
| is_added_in_portal: | |
| $ref: '#/components/schemas/is_added_in_portal' | |
| communication_preference: | |
| $ref: '#/components/schemas/communication_preference' | |
| contact_person_email: | |
| description: Email ID of the Contact Person. | |
| type: string | |
| example: willsmith@bowmanfurniture.com | |
| contact_person_id: | |
| description: ID of the Contact Person | |
| type: integer | |
| format: int64 | |
| contact_person_name: | |
| description: Name of the Contact Person | |
| type: string | |
| example: David | |
| contact_persons: | |
| description: Array of contact person(s) for whom invoice has to be sent. | |
| type: array | |
| items: | |
| type: string | |
| example: | |
| - '460000000870911' | |
| - '460000000870915' | |
| contact_persons_associated: | |
| description: Contact Persons associated with the transaction. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| contact_person_id: | |
| $ref: '#/components/schemas/contact_person_id' | |
| contact_person_name: | |
| $ref: '#/components/schemas/contact_person_name' | |
| first_name: | |
| $ref: '#/components/schemas/first_name' | |
| last_name: | |
| $ref: '#/components/schemas/last_name' | |
| contact_person_email: | |
| $ref: '#/components/schemas/contact_person_email' | |
| phone: | |
| $ref: '#/components/schemas/phone' | |
| mobile: | |
| $ref: '#/components/schemas/mobile' | |
| communication_preference: | |
| $ref: '#/components/schemas/communication_preference' | |
| contact_persons_associated_payload: | |
| description: Contact Persons associated with the transaction. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| contact_person_id: | |
| $ref: '#/components/schemas/contact_person_id' | |
| communication_preference: | |
| $ref: '#/components/schemas/communication_preference' | |
| contact_type: | |
| description: 'Determines how the contact is treated in the system. Allowed values: | |
| <code>customer</code>, <code>vendor</code>.' | |
| type: string | |
| example: customer | |
| contacts: | |
| description: The list of all contacts. | |
| type: array | |
| items: | |
| type: string | |
| convert-credit-note-to-draft-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The credit note has been marked as Draft. | |
| readOnly: true | |
| convert-po-to-bill-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| purchaseorder_ids: | |
| $ref: '#/components/schemas/purchaseorder_ids' | |
| bill: | |
| $ref: '#/components/schemas/bill' | |
| convert-to-open-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Status of the credit note has been changed to open. | |
| readOnly: true | |
| cost_amount: | |
| description: Cost amount | |
| type: number | |
| format: double | |
| example: 0 | |
| cost_budget_amount: | |
| description: Budgeted Cost to complete this project | |
| type: number | |
| format: double | |
| example: '1000.00' | |
| cost_rate: | |
| type: number | |
| format: double | |
| example: '10.00' | |
| country: | |
| description: Country of the Address | |
| type: string | |
| country_code: | |
| description: '<b>For UK Edition:</b> Two letter country code of a contact<br/> | |
| <b>For Avalara:</b> Two letter country code for the customer country, if your | |
| customer is not in US. Refer [AvaTax Codes for Countries and States][2].<br/> | |
| <b>For GCC Editions :</b> Two Letter country code for the GCC Country or the | |
| UAE emirate of the contact which will be considered as <b>place of supply</b>.<br/>Supported | |
| codes for UAE emirates are : </br>Abu Dhabi - <code>AB</code>,</br>Ajman - | |
| <code>AJ</code>,</br>Dubai - <code>DU</code>,</br>Fujairah - <code>FU</code>,</br>Ras | |
| al-Khaimah - <code>RA</code>,</br>Sharjah - <code>SH</code>,</br>Umm al-Quwain | |
| - <code>UM</code>.<br/>Supported codes for the GCC countries are : </br>United | |
| Arab Emirates - <code>AE</code>,</br>Saudi Arabia - <code>SA</code>,</br>Bahrain | |
| - <code>BH</code>,</br>Kuwait - <code>KW</code>,</br>Oman - <code>OM</code>,</br>Qatar | |
| - <code>QA</code>.' | |
| type: string | |
| x-node_available_in: | |
| - uk | |
| - gcc | |
| - Avalara Integration | |
| x-node_unavailable_in: [] | |
| create-a-bank-account-request: | |
| required: | |
| - account_name | |
| - account_type | |
| type: object | |
| properties: | |
| account_name: | |
| $ref: '#/components/schemas/account_name' | |
| account_type: | |
| $ref: '#/components/schemas/account_type' | |
| account_number: | |
| $ref: '#/components/schemas/account_number' | |
| account_code: | |
| $ref: '#/components/schemas/account_code' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| currency_code: | |
| $ref: '#/components/schemas/currency_code' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| bank_name: | |
| $ref: '#/components/schemas/bank_name' | |
| routing_number: | |
| $ref: '#/components/schemas/routing_number' | |
| is_primary_account: | |
| $ref: '#/components/schemas/is_primary_account' | |
| is_paypal_account: | |
| $ref: '#/components/schemas/is_paypal_account' | |
| paypal_type: | |
| $ref: '#/components/schemas/paypal_type' | |
| paypal_email_address: | |
| $ref: '#/components/schemas/paypal_email_address' | |
| create-a-bank-account-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The account has been created. | |
| readOnly: true | |
| bankaccount: | |
| $ref: '#/components/schemas/bankaccount' | |
| create-a-base-currency-adjustment-request: | |
| required: | |
| - currency_id | |
| - adjustment_date | |
| - exchange_rate | |
| - notes | |
| type: object | |
| properties: | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| adjustment_date: | |
| $ref: '#/components/schemas/adjustment_date' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| create-a-base-currency-adjustment-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The adjustment has been made. The account balances will now reflect | |
| the adjustment. | |
| readOnly: true | |
| data: | |
| $ref: '#/components/schemas/data' | |
| create-a-bill-request: | |
| required: | |
| - vendor_id | |
| - bill_number | |
| type: object | |
| properties: | |
| vendor_id: | |
| $ref: '#/components/schemas/vendor_id' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| is_update_customer: | |
| $ref: '#/components/schemas/is_update_customer' | |
| purchaseorder_ids: | |
| $ref: '#/components/schemas/purchaseorder_ids' | |
| bill_number: | |
| $ref: '#/components/schemas/bill_number' | |
| documents: | |
| $ref: '#/components/schemas/documents' | |
| source_of_supply: | |
| $ref: '#/components/schemas/source_of_supply' | |
| destination_of_supply: | |
| $ref: '#/components/schemas/destination_of_supply' | |
| place_of_supply: | |
| $ref: '#/components/schemas/place_of_supply' | |
| permit_number: | |
| $ref: '#/components/schemas/permit_number' | |
| gst_treatment: | |
| $ref: '#/components/schemas/gst_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| pricebook_id: | |
| $ref: '#/components/schemas/pricebook_id' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| due_date: | |
| $ref: '#/components/schemas/due_date' | |
| payment_terms: | |
| $ref: '#/components/schemas/payment_terms' | |
| payment_terms_label: | |
| $ref: '#/components/schemas/payment_terms_label' | |
| recurring_bill_id: | |
| $ref: '#/components/schemas/recurring_bill_id' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| is_item_level_tax_calc: | |
| $ref: '#/components/schemas/is_item_level_tax_calc' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| adjustment: | |
| $ref: '#/components/schemas/adjustment' | |
| adjustment_description: | |
| $ref: '#/components/schemas/adjustment_description' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| custom_fields: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| index: | |
| $ref: '#/components/schemas/index' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| line_items: | |
| description: Line items of a bill. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| purchaseorder_item_id: | |
| $ref: '#/components/schemas/purchaseorder_item_id' | |
| line_item_id: | |
| $ref: '#/components/schemas/line_item_id' | |
| item_id: | |
| $ref: '#/components/schemas/item_id' | |
| name: | |
| $ref: '#/components/schemas/name' | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| hsn_or_sac: | |
| $ref: '#/components/schemas/hsn_or_sac' | |
| reverse_charge_tax_id: | |
| $ref: '#/components/schemas/reverse_charge_tax_id' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| quantity: | |
| $ref: '#/components/schemas/quantity' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tds_tax_id: | |
| $ref: '#/components/schemas/tds_tax_id' | |
| tax_treatment_code: | |
| $ref: '#/components/schemas/tax_treatment_code' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| tax_exemption_code: | |
| $ref: '#/components/schemas/tax_exemption_code' | |
| item_order: | |
| $ref: '#/components/schemas/item_order' | |
| product_type: | |
| $ref: '#/components/schemas/product_type' | |
| acquisition_vat_id: | |
| $ref: '#/components/schemas/acquisition_vat_id' | |
| reverse_charge_vat_id: | |
| $ref: '#/components/schemas/reverse_charge_vat_id' | |
| unit: | |
| $ref: '#/components/schemas/unit' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| is_billable: | |
| $ref: '#/components/schemas/is_billable' | |
| project_id: | |
| $ref: '#/components/schemas/project_id' | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| item_custom_fields: | |
| $ref: '#/components/schemas/item_custom_fields' | |
| serial_numbers: | |
| $ref: '#/components/schemas/serial_numbers' | |
| taxes: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tax_name: | |
| $ref: '#/components/schemas/tax_name' | |
| tax_amount: | |
| $ref: '#/components/schemas/tax_amount' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| terms: | |
| $ref: '#/components/schemas/terms' | |
| approvers: | |
| $ref: '#/components/schemas/approvers' | |
| create-a-bill-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| bill: | |
| $ref: '#/components/schemas/bill' | |
| create-a-comment-request: | |
| type: object | |
| properties: | |
| description: | |
| description: The description of the comment. | |
| type: string | |
| example: This is a comment. | |
| payment_expected_date: | |
| $ref: '#/components/schemas/payment_expected_date' | |
| show_comment_to_clients: | |
| $ref: '#/components/schemas/show_comment_to_clients' | |
| create-a-contact-person-request: | |
| required: | |
| - first_name | |
| type: object | |
| properties: | |
| contact_id: | |
| $ref: '#/components/schemas/contact_id' | |
| salutation: | |
| $ref: '#/components/schemas/salutation' | |
| first_name: | |
| $ref: '#/components/schemas/first_name' | |
| last_name: | |
| $ref: '#/components/schemas/last_name' | |
| email: | |
| $ref: '#/components/schemas/email' | |
| phone: | |
| $ref: '#/components/schemas/phone' | |
| mobile: | |
| $ref: '#/components/schemas/mobile' | |
| skype: | |
| $ref: '#/components/schemas/skype' | |
| designation: | |
| $ref: '#/components/schemas/designation' | |
| department: | |
| $ref: '#/components/schemas/department' | |
| enable_portal: | |
| $ref: '#/components/schemas/enable_portal' | |
| communication_preference: | |
| $ref: '#/components/schemas/communication_preference' | |
| create-a-contact-person-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The contactperson has been Created | |
| readOnly: true | |
| contact_person: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/contact_person-response' | |
| create-a-contact-request: | |
| required: | |
| - contact_name | |
| type: object | |
| properties: | |
| contact_name: | |
| $ref: '#/components/schemas/contact_name' | |
| company_name: | |
| $ref: '#/components/schemas/company_name' | |
| website: | |
| $ref: '#/components/schemas/website' | |
| language_code: | |
| $ref: '#/components/schemas/language_code' | |
| contact_type: | |
| $ref: '#/components/schemas/contact_type' | |
| customer_sub_type: | |
| $ref: '#/components/schemas/customer_sub_type' | |
| credit_limit: | |
| $ref: '#/components/schemas/credit_limit' | |
| pricebook_id: | |
| $ref: '#/components/schemas/pricebook_id' | |
| contact_number: | |
| $ref: '#/components/schemas/contact_number' | |
| ignore_auto_number_generation: | |
| $ref: '#/components/schemas/ignore_auto_number_generation' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| is_portal_enabled: | |
| $ref: '#/components/schemas/is_portal_enabled' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| payment_terms: | |
| $ref: '#/components/schemas/payment_terms' | |
| payment_terms_label: | |
| $ref: '#/components/schemas/payment_terms_label' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| billing_address: | |
| $ref: '#/components/schemas/billing_address' | |
| shipping_address: | |
| $ref: '#/components/schemas/shipping_address' | |
| contact_persons: | |
| $ref: '#/components/schemas/contact_persons' | |
| default_templates: | |
| $ref: '#/components/schemas/default_templates' | |
| custom_fields: | |
| description: Custom fields of the contact. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| index: | |
| $ref: '#/components/schemas/index' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| opening_balances: | |
| $ref: '#/components/schemas/opening_balances' | |
| vat_reg_no: | |
| $ref: '#/components/schemas/vat_reg_no' | |
| owner_id: | |
| $ref: '#/components/schemas/owner_id' | |
| tax_reg_no: | |
| $ref: '#/components/schemas/tax_reg_no' | |
| tax_exemption_certificate_number: | |
| $ref: '#/components/schemas/tax_exemption_certificate_number' | |
| country_code: | |
| $ref: '#/components/schemas/country_code' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| tax_regime: | |
| $ref: '#/components/schemas/tax_regime' | |
| legal_name: | |
| $ref: '#/components/schemas/legal_name' | |
| is_tds_registered: | |
| $ref: '#/components/schemas/is_tds_registered' | |
| place_of_contact: | |
| $ref: '#/components/schemas/place_of_contact' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| gst_treatment: | |
| $ref: '#/components/schemas/gst_treatment' | |
| tax_authority_name: | |
| $ref: '#/components/schemas/tax_authority_name' | |
| avatax_exempt_no: | |
| $ref: '#/components/schemas/avatax_exempt_no' | |
| avatax_use_code: | |
| $ref: '#/components/schemas/avatax_use_code' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| tax_exemption_code: | |
| $ref: '#/components/schemas/tax_exemption_code' | |
| tax_authority_id: | |
| $ref: '#/components/schemas/tax_authority_id' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tds_tax_id: | |
| $ref: '#/components/schemas/tds_tax_id' | |
| is_taxable: | |
| $ref: '#/components/schemas/is_taxable' | |
| facebook: | |
| $ref: '#/components/schemas/facebook' | |
| twitter: | |
| $ref: '#/components/schemas/twitter' | |
| track_1099: | |
| $ref: '#/components/schemas/track_1099' | |
| tax_id_type: | |
| $ref: '#/components/schemas/tax_id_type' | |
| tax_id_value: | |
| $ref: '#/components/schemas/tax_id_value' | |
| create-a-contact-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The contact has been created | |
| readOnly: true | |
| contact: | |
| $ref: '#/components/schemas/contact-response' | |
| create-a-credit-note-request: | |
| required: | |
| - customer_id | |
| - date | |
| - creditnote_number | |
| - line_items | |
| type: object | |
| properties: | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| contact_persons_associated: | |
| $ref: '#/components/schemas/contact_persons_associated_payload' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| is_draft: | |
| $ref: '#/components/schemas/is_draft' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| line_items: | |
| description: Array of line items for the credit note. Each line item represents | |
| a product or service being credited to the customer. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| item_id: | |
| $ref: '#/components/schemas/item_id' | |
| invoice_id: | |
| $ref: '#/components/schemas/invoice_id' | |
| invoice_item_id: | |
| description: Unique identifier of the invoice line item that this | |
| credit note line item references. Use this when creating a credit | |
| note for a specific invoice line item. | |
| type: string | |
| example: '982000000567021' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| code: | |
| $ref: '#/components/schemas/code' | |
| name: | |
| $ref: '#/components/schemas/name' | |
| type: | |
| $ref: '#/components/schemas/type' | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| account_name: | |
| $ref: '#/components/schemas/account_name' | |
| quantity: | |
| $ref: '#/components/schemas/quantity' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tds_tax_id: | |
| $ref: '#/components/schemas/tds_tax_id' | |
| tax_treatment_code: | |
| $ref: '#/components/schemas/tax_treatment_code' | |
| product_type: | |
| $ref: '#/components/schemas/product_type' | |
| sat_item_key_code: | |
| $ref: '#/components/schemas/sat_item_key_code' | |
| unitkey_code: | |
| $ref: '#/components/schemas/unitkey_code' | |
| serial_numbers: | |
| $ref: '#/components/schemas/serial_numbers' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| project_id: | |
| $ref: '#/components/schemas/project_id' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| creditnote_number: | |
| $ref: '#/components/schemas/creditnote_number' | |
| gst_treatment: | |
| $ref: '#/components/schemas/gst_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| is_reverse_charge_applied: | |
| $ref: '#/components/schemas/is_reverse_charge_applied' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| cfdi_usage: | |
| $ref: '#/components/schemas/cfdi_usage' | |
| cfdi_reference_type: | |
| $ref: '#/components/schemas/cfdi_reference_type' | |
| place_of_supply: | |
| $ref: '#/components/schemas/place_of_supply' | |
| ignore_auto_number_generation: | |
| $ref: '#/components/schemas/ignore_auto_number_generation' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| terms: | |
| $ref: '#/components/schemas/terms' | |
| template_id: | |
| $ref: '#/components/schemas/template_id' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tax_authority_id: | |
| $ref: '#/components/schemas/tax_authority_id' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| avatax_use_code: | |
| $ref: '#/components/schemas/avatax_use_code' | |
| avatax_exempt_no: | |
| $ref: '#/components/schemas/avatax_exempt_no' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| avatax_tax_code: | |
| $ref: '#/components/schemas/avatax_tax_code' | |
| create-a-credit-note-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The credit note has been created. | |
| readOnly: true | |
| creditnote: | |
| $ref: '#/components/schemas/creditnote-response' | |
| create-a-currency-request: | |
| required: | |
| - currency_code | |
| - currency_format | |
| type: object | |
| properties: | |
| currency_code: | |
| $ref: '#/components/schemas/currency_code' | |
| currency_symbol: | |
| $ref: '#/components/schemas/currency_symbol' | |
| price_precision: | |
| $ref: '#/components/schemas/price_precision' | |
| currency_format: | |
| $ref: '#/components/schemas/currency_format' | |
| create-a-currency-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The currency has been added. | |
| readOnly: true | |
| currency: | |
| $ref: '#/components/schemas/currency' | |
| create-a-customer-debit-note-request: | |
| required: | |
| - customer_id | |
| - line_items | |
| - type | |
| - reference_invoice_id | |
| type: object | |
| properties: | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| type: | |
| type: string | |
| description: Type of the document. For customer debit notes, this should | |
| be <code>debit_note</code> | |
| example: debit_note | |
| enum: | |
| - debit_note | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| contact_persons: | |
| $ref: '#/components/schemas/contact_persons' | |
| invoice_number: | |
| $ref: '#/components/schemas/invoice_number' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| payment_terms: | |
| $ref: '#/components/schemas/payment_terms' | |
| payment_terms_label: | |
| $ref: '#/components/schemas/payment_terms_label' | |
| due_date: | |
| $ref: '#/components/schemas/due_date' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| reference_invoice_id: | |
| $ref: '#/components/schemas/reference_invoice_id' | |
| reference_invoice_type: | |
| $ref: '#/components/schemas/reference_invoice_type' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| line_items: | |
| type: array | |
| items: | |
| type: object | |
| required: | |
| - item_id | |
| properties: | |
| item_id: | |
| $ref: '#/components/schemas/item_id' | |
| hsn_or_sac: | |
| $ref: '#/components/schemas/hsn_or_sac' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| quantity: | |
| $ref: '#/components/schemas/quantity' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| create-a-customer-debit-note-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| message: | |
| type: string | |
| example: The debit note has been created. | |
| invoice: | |
| $ref: '#/components/schemas/debit_note' | |
| create-a-fixed-asset-request: | |
| type: object | |
| required: | |
| - asset_name | |
| - fixed_asset_type_id | |
| - asset_account_id | |
| - asset_cost | |
| - asset_purchase_date | |
| properties: | |
| asset_name: | |
| $ref: '#/components/schemas/asset_name' | |
| fixed_asset_type_id: | |
| $ref: '#/components/schemas/fixed_asset_type_id' | |
| asset_account_id: | |
| $ref: '#/components/schemas/asset_account_id' | |
| expense_account_id: | |
| $ref: '#/components/schemas/expense_account_id' | |
| depreciation_account_id: | |
| $ref: '#/components/schemas/depreciation_account_id' | |
| depreciation_method: | |
| $ref: '#/components/schemas/depreciation_method' | |
| depreciation_frequency: | |
| $ref: '#/components/schemas/depreciation_frequency' | |
| depreciation_percentage: | |
| $ref: '#/components/schemas/depreciation_percentage' | |
| total_life: | |
| $ref: '#/components/schemas/total_life' | |
| salvage_value: | |
| $ref: '#/components/schemas/salvage_value' | |
| depreciation_start_date: | |
| $ref: '#/components/schemas/depreciation_start_date' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| asset_cost: | |
| $ref: '#/components/schemas/asset_cost' | |
| computation_type: | |
| $ref: '#/components/schemas/computation_type' | |
| warranty_expiry_date: | |
| $ref: '#/components/schemas/warranty_expiry_date' | |
| asset_purchase_date: | |
| $ref: '#/components/schemas/asset_purchase_date' | |
| serial_no: | |
| $ref: '#/components/schemas/serial_no' | |
| dep_start_value: | |
| $ref: '#/components/schemas/dep_start_value' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| create-a-fixed-asset-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The fixed asset has been created. | |
| readOnly: true | |
| fixed_asset: | |
| $ref: '#/components/schemas/fixed_asset' | |
| create-a-fixed-asset-type-request: | |
| required: | |
| - fixed_asset_type_name | |
| - expense_account_id | |
| - depreciation_account_id | |
| - depreciation_method | |
| - depreciation_frequency | |
| - depreciation_percentage | |
| - total_life | |
| - salvage_value | |
| - computation_type | |
| type: object | |
| properties: | |
| fixed_asset_type_name: | |
| $ref: '#/components/schemas/fixed_asset_type_name' | |
| expense_account_id: | |
| $ref: '#/components/schemas/expense_account_id' | |
| depreciation_account_id: | |
| $ref: '#/components/schemas/depreciation_account_id' | |
| depreciation_method: | |
| $ref: '#/components/schemas/depreciation_method' | |
| depreciation_frequency: | |
| $ref: '#/components/schemas/depreciation_frequency' | |
| depreciation_percentage: | |
| $ref: '#/components/schemas/depreciation_percentage' | |
| total_life: | |
| $ref: '#/components/schemas/total_life' | |
| salvage_value: | |
| $ref: '#/components/schemas/salvage_value' | |
| computation_type: | |
| $ref: '#/components/schemas/computation_type' | |
| create-a-fixed-asset-type-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The fixed asset type has been created. | |
| readOnly: true | |
| fixed_asset_type: | |
| $ref: '#/components/schemas/fixed_asset_type' | |
| create-a-journal-request: | |
| required: | |
| - journal_date | |
| type: object | |
| properties: | |
| journal_date: | |
| $ref: '#/components/schemas/journal_date' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| journal_type: | |
| $ref: '#/components/schemas/journal_type' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| include_in_vat_return: | |
| $ref: '#/components/schemas/include_in_vat_return' | |
| product_type: | |
| $ref: '#/components/schemas/product_type' | |
| is_bas_adjustment: | |
| $ref: '#/components/schemas/is_bas_adjustment' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| line_items: | |
| type: array | |
| items: | |
| type: object | |
| required: | |
| - amount | |
| - debit_or_credit | |
| properties: | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| line_id: | |
| $ref: '#/components/schemas/line_id' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| tax_authority_id: | |
| $ref: '#/components/schemas/tax_authority_id' | |
| tax_exemption_type: | |
| $ref: '#/components/schemas/tax_exemption_type' | |
| tax_exemption_code: | |
| $ref: '#/components/schemas/tax_exemption_code' | |
| tax_authority_name: | |
| $ref: '#/components/schemas/tax_authority_name' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| debit_or_credit: | |
| $ref: '#/components/schemas/debit_or_credit' | |
| acquisition_vat_id: | |
| $ref: '#/components/schemas/acquisition_vat_id' | |
| reverse_charge_vat_id: | |
| $ref: '#/components/schemas/reverse_charge_vat_id' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| project_id: | |
| $ref: '#/components/schemas/project_id' | |
| tax_exemption_code: | |
| $ref: '#/components/schemas/tax_exemption_code' | |
| tax_exemption_type: | |
| $ref: '#/components/schemas/tax_exemption_type' | |
| status: | |
| $ref: '#/components/schemas/status' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| create-a-journal-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The journal entry has been created. | |
| readOnly: true | |
| journal: | |
| $ref: '#/components/schemas/journal' | |
| create-a-location-request: | |
| required: | |
| - location_name | |
| - country | |
| - tax_settings_id | |
| type: object | |
| properties: | |
| type: | |
| $ref: '#/components/schemas/type' | |
| email: | |
| $ref: '#/components/schemas/email' | |
| phone: | |
| $ref: '#/components/schemas/phone' | |
| address: | |
| $ref: '#/components/schemas/address' | |
| location_name: | |
| $ref: '#/components/schemas/location_name' | |
| tax_settings_id: | |
| $ref: '#/components/schemas/tax_settings_id' | |
| parent_location_id: | |
| $ref: '#/components/schemas/parent_location_id' | |
| associated_series_ids: | |
| $ref: '#/components/schemas/associated_series_ids' | |
| auto_number_generation_id: | |
| $ref: '#/components/schemas/autonumbergenerationgroup_id' | |
| is_all_users_selected: | |
| $ref: '#/components/schemas/is_all_users_selected' | |
| user_ids: | |
| $ref: '#/components/schemas/user_ids' | |
| create-a-location-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Location has been created. | |
| readOnly: true | |
| locations: | |
| $ref: '#/components/schemas/locations' | |
| create-a-payment-request: | |
| required: | |
| - customer_id | |
| - payment_mode | |
| - amount | |
| - invoices | |
| - date | |
| - invoice_id | |
| - amount_applied | |
| type: object | |
| properties: | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| payment_mode: | |
| $ref: '#/components/schemas/payment_mode' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| invoices: | |
| description: List of invoices associated with the payment. Each invoice | |
| object contains <code>invoice_id</code>, <code>invoice_number</code>, | |
| <code>date</code>, <code>invoice_amount</code>, <code>amount_applied</code> | |
| and <code>balance_amount</code>. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| invoice_id: | |
| $ref: '#/components/schemas/invoice_id' | |
| amount_applied: | |
| $ref: '#/components/schemas/amount_applied' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| payment_form: | |
| $ref: '#/components/schemas/payment_form' | |
| bank_charges: | |
| $ref: '#/components/schemas/bank_charges' | |
| custom_fields: | |
| description: Additional fields for the payments. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| label: | |
| $ref: '#/components/schemas/label' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| invoice_id: | |
| $ref: '#/components/schemas/invoice_id' | |
| amount_applied: | |
| $ref: '#/components/schemas/amount_applied' | |
| tax_amount_withheld: | |
| $ref: '#/components/schemas/tax_amount_withheld' | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| contact_persons: | |
| $ref: '#/components/schemas/contact_persons' | |
| retainerinvoice_id: | |
| $ref: '#/components/schemas/retainerinvoice_id' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| create-a-payment-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The payment has been created. | |
| readOnly: true | |
| payment: | |
| $ref: '#/components/schemas/payment-response' | |
| create-a-project-request: | |
| required: | |
| - project_name | |
| - customer_id | |
| - billing_type | |
| - user_id | |
| type: object | |
| properties: | |
| project_name: | |
| description: Name of the project. <code>Max-length [100]</code> | |
| type: string | |
| example: Network Distribution | |
| customer_id: | |
| description: ID of the customer. | |
| type: string | |
| example: '460000000044001' | |
| currency_id: | |
| type: string | |
| example: '460000000098001' | |
| description: | |
| description: Project description. <code>Max-length [500]</code> | |
| type: string | |
| example: Distribution for the system of intermediaries between the producer | |
| of goods and/or services and the final user | |
| billing_type: | |
| description: 'The way you bill your customer. Allowed Values: <code>fixed_cost_for_project</code>, | |
| <code>based_on_project_hours</code>, <code>based_on_staff_hours</code> | |
| and <code>based_on_task_hours</code>' | |
| type: string | |
| example: based_on_task_hours | |
| rate: | |
| description: Hourly rate for a task. | |
| type: string | |
| example: ' ' | |
| budget_type: | |
| description: 'The way you budget. Allowed Values: <code>total_project_cost</code>, | |
| <code>total_project_hours</code>, <code>hours_per_task</code> and <code>hours_per_staff</code>' | |
| type: string | |
| example: ' ' | |
| budget_hours: | |
| description: Task budget hours | |
| type: string | |
| example: ' ' | |
| budget_amount: | |
| description: Give value, if you are estimating total project revenue budget. | |
| type: string | |
| example: ' ' | |
| cost_budget_amount: | |
| description: Budgeted Cost to complete this project | |
| type: number | |
| format: double | |
| example: '1000.00' | |
| user_id: | |
| description: ID of the user to be added to the project. | |
| type: string | |
| example: INV-00003 | |
| tasks: | |
| type: array | |
| items: | |
| type: object | |
| required: | |
| - task_name | |
| properties: | |
| task_name: | |
| description: Name of the task. <code>Max-length [100]</code> | |
| type: string | |
| example: INV-00003 | |
| description: | |
| description: Task description. <code>Max-length [500]</code> | |
| type: string | |
| example: INV-00003 | |
| rate: | |
| description: Hourly rate of a task. | |
| type: string | |
| example: INV-00003 | |
| budget_hours: | |
| description: Task budgeting. | |
| type: string | |
| example: INV-00003 | |
| users: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| user_id: | |
| description: ID of the user to be added to the project. | |
| type: string | |
| example: INV-00003 | |
| is_current_user: | |
| $ref: '#/components/schemas/is_current_user' | |
| user_name: | |
| $ref: '#/components/schemas/user_name' | |
| email: | |
| $ref: '#/components/schemas/email' | |
| user_role: | |
| $ref: '#/components/schemas/user_role' | |
| status: | |
| $ref: '#/components/schemas/status' | |
| rate: | |
| description: Hourly rate for a task. | |
| type: string | |
| example: ' ' | |
| budget_hours: | |
| description: Task budget hours | |
| type: string | |
| example: ' ' | |
| total_hours: | |
| $ref: '#/components/schemas/total_hours' | |
| billed_hours: | |
| $ref: '#/components/schemas/billed_hours' | |
| un_billed_hours: | |
| $ref: '#/components/schemas/un_billed_hours' | |
| cost_rate: | |
| $ref: '#/components/schemas/cost_rate' | |
| create-a-project-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The project has been created. | |
| readOnly: true | |
| project: | |
| $ref: '#/components/schemas/project-response' | |
| create-a-purchase-order-request: | |
| required: | |
| - vendor_id | |
| - line_items | |
| type: object | |
| properties: | |
| vendor_id: | |
| $ref: '#/components/schemas/vendor_id' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| contact_persons_associated: | |
| $ref: '#/components/schemas/contact_persons_associated_payload' | |
| purchaseorder_number: | |
| $ref: '#/components/schemas/purchaseorder_number' | |
| gst_treatment: | |
| $ref: '#/components/schemas/gst_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| source_of_supply: | |
| $ref: '#/components/schemas/source_of_supply' | |
| destination_of_supply: | |
| $ref: '#/components/schemas/destination_of_supply' | |
| place_of_supply: | |
| $ref: '#/components/schemas/place_of_supply' | |
| pricebook_id: | |
| $ref: '#/components/schemas/pricebook_id' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| billing_address_id: | |
| $ref: '#/components/schemas/billing_address_id' | |
| crm_owner_id: | |
| $ref: '#/components/schemas/crm_owner_id' | |
| crm_custom_reference_id: | |
| $ref: '#/components/schemas/crm_custom_reference_id' | |
| template_id: | |
| $ref: '#/components/schemas/template_id' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| delivery_date: | |
| $ref: '#/components/schemas/delivery_date' | |
| due_date: | |
| $ref: '#/components/schemas/due_date' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| discount: | |
| $ref: '#/components/schemas/discount' | |
| discount_account_id: | |
| $ref: '#/components/schemas/discount_account_id' | |
| is_discount_before_tax: | |
| $ref: '#/components/schemas/is_discount_before_tax' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| notes_default: | |
| $ref: '#/components/schemas/notes_default' | |
| terms: | |
| $ref: '#/components/schemas/terms' | |
| terms_default: | |
| $ref: '#/components/schemas/terms_default' | |
| ship_via: | |
| $ref: '#/components/schemas/ship_via' | |
| delivery_org_address_id: | |
| $ref: '#/components/schemas/delivery_org_address_id' | |
| delivery_customer_id: | |
| $ref: '#/components/schemas/delivery_customer_id' | |
| attention: | |
| $ref: '#/components/schemas/attention' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| is_update_customer: | |
| $ref: '#/components/schemas/is_update_customer' | |
| salesorder_id: | |
| $ref: '#/components/schemas/salesorder_id' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| line_items: | |
| description: Line items of purchase order. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| item_id: | |
| $ref: '#/components/schemas/item_id' | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| name: | |
| $ref: '#/components/schemas/name' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| unit: | |
| $ref: '#/components/schemas/unit' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| hsn_or_sac: | |
| $ref: '#/components/schemas/hsn_or_sac' | |
| reverse_charge_tax_id: | |
| $ref: '#/components/schemas/reverse_charge_tax_id' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| quantity: | |
| $ref: '#/components/schemas/quantity' | |
| item_order: | |
| $ref: '#/components/schemas/item_order' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tds_tax_id: | |
| $ref: '#/components/schemas/tds_tax_id' | |
| tax_treatment_code: | |
| $ref: '#/components/schemas/tax_treatment_code' | |
| tax_exemption_code: | |
| $ref: '#/components/schemas/tax_exemption_code' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| acquisition_vat_id: | |
| $ref: '#/components/schemas/acquisition_vat_id' | |
| reverse_charge_vat_id: | |
| $ref: '#/components/schemas/reverse_charge_vat_id' | |
| item_custom_fields: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| index: | |
| $ref: '#/components/schemas/index' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| project_id: | |
| $ref: '#/components/schemas/project_id' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| documents: | |
| $ref: '#/components/schemas/documents' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| create-a-purchase-order-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Purchase Order has been added. | |
| readOnly: true | |
| purchaseorder: | |
| $ref: '#/components/schemas/purchaseorder' | |
| create-a-recurring-bill-request: | |
| required: | |
| - vendor_id | |
| - recurrence_name | |
| - start_date | |
| - repeat_every | |
| - recurrence_frequency | |
| type: object | |
| properties: | |
| vendor_id: | |
| $ref: '#/components/schemas/vendor_id' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| recurrence_name: | |
| $ref: '#/components/schemas/recurrence_name' | |
| start_date: | |
| $ref: '#/components/schemas/start_date' | |
| end_date: | |
| $ref: '#/components/schemas/end_date' | |
| source_of_supply: | |
| $ref: '#/components/schemas/source_of_supply' | |
| place_of_supply: | |
| $ref: '#/components/schemas/place_of_supply' | |
| destination_of_supply: | |
| $ref: '#/components/schemas/destination_of_supply' | |
| gst_treatment: | |
| $ref: '#/components/schemas/gst_treatment' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| vat_reg_no: | |
| $ref: '#/components/schemas/vat_reg_no' | |
| is_abn_quoted: | |
| $ref: '#/components/schemas/is_abn_quoted' | |
| abn: | |
| $ref: '#/components/schemas/abn' | |
| is_reverse_charge_applied: | |
| $ref: '#/components/schemas/is_reverse_charge_applied' | |
| pricebook_id: | |
| $ref: '#/components/schemas/pricebook_id' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| line_items: | |
| description: Line items of a recurrence bill. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| line_item_id: | |
| $ref: '#/components/schemas/line_item_id' | |
| item_id: | |
| $ref: '#/components/schemas/item_id' | |
| name: | |
| $ref: '#/components/schemas/name' | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| hsn_or_sac: | |
| $ref: '#/components/schemas/hsn_or_sac' | |
| reverse_charge_tax_id: | |
| $ref: '#/components/schemas/reverse_charge_tax_id' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| quantity: | |
| $ref: '#/components/schemas/quantity' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tds_tax_id: | |
| $ref: '#/components/schemas/tds_tax_id' | |
| tax_treatment_code: | |
| $ref: '#/components/schemas/tax_treatment_code' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| tax_exemption_code: | |
| $ref: '#/components/schemas/tax_exemption_code' | |
| item_order: | |
| $ref: '#/components/schemas/item_order' | |
| product_type: | |
| $ref: '#/components/schemas/product_type' | |
| acquisition_vat_id: | |
| $ref: '#/components/schemas/acquisition_vat_id' | |
| reverse_charge_vat_id: | |
| $ref: '#/components/schemas/reverse_charge_vat_id' | |
| unit: | |
| $ref: '#/components/schemas/unit' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| is_billable: | |
| $ref: '#/components/schemas/is_billable' | |
| project_id: | |
| $ref: '#/components/schemas/project_id' | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| item_custom_fields: | |
| $ref: '#/components/schemas/item_custom_fields' | |
| serial_numbers: | |
| $ref: '#/components/schemas/serial_numbers' | |
| is_tds_applied: | |
| $ref: '#/components/schemas/is_tds_applied' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| terms: | |
| $ref: '#/components/schemas/terms' | |
| payment_terms: | |
| $ref: '#/components/schemas/payment_terms' | |
| payment_terms_label: | |
| $ref: '#/components/schemas/payment_terms_label' | |
| custom_fields: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| index: | |
| $ref: '#/components/schemas/index' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| discount: | |
| $ref: '#/components/schemas/discount' | |
| discount_account_id: | |
| $ref: '#/components/schemas/discount_account_id' | |
| is_discount_before_tax: | |
| $ref: '#/components/schemas/is_discount_before_tax' | |
| repeat_every: | |
| description: Description for repeat_every | |
| type: string | |
| example: '' | |
| recurrence_frequency: | |
| description: Description for recurrence_frequency | |
| type: string | |
| example: '' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| create-a-recurring-bill-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| recurring_bill: | |
| $ref: '#/components/schemas/recurring_bill' | |
| create-a-recurring-expense-request: | |
| required: | |
| - account_id | |
| - recurrence_name | |
| - start_date | |
| - recurrence_frequency | |
| - repeat_every | |
| - amount | |
| type: object | |
| properties: | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| recurrence_name: | |
| $ref: '#/components/schemas/recurrence_name' | |
| start_date: | |
| $ref: '#/components/schemas/start_date' | |
| end_date: | |
| $ref: '#/components/schemas/end_date' | |
| recurrence_frequency: | |
| $ref: '#/components/schemas/recurrence_frequency' | |
| repeat_every: | |
| $ref: '#/components/schemas/repeat_every' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| source_of_supply: | |
| $ref: '#/components/schemas/source_of_supply' | |
| destination_of_supply: | |
| $ref: '#/components/schemas/destination_of_supply' | |
| place_of_supply: | |
| $ref: '#/components/schemas/place_of_supply' | |
| reverse_charge_tax_id: | |
| $ref: '#/components/schemas/reverse_charge_tax_id' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| line_items: | |
| $ref: '#/components/schemas/line_items' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| product_type: | |
| $ref: '#/components/schemas/product_type' | |
| acquisition_vat_id: | |
| $ref: '#/components/schemas/acquisition_vat_id' | |
| reverse_charge_vat_id: | |
| $ref: '#/components/schemas/reverse_charge_vat_id' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| is_billable: | |
| $ref: '#/components/schemas/is_billable' | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| project_id: | |
| $ref: '#/components/schemas/project_id' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| create-a-recurring-expense-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The recurring expense has been created | |
| readOnly: true | |
| recurring_expense: | |
| $ref: '#/components/schemas/recurring_expense-response' | |
| create-a-recurring-invoice-request: | |
| required: | |
| - recurrence_name | |
| - customer_id | |
| - recurrence_frequency | |
| type: object | |
| properties: | |
| recurrence_name: | |
| $ref: '#/components/schemas/recurrence_name' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| contact_persons_associated: | |
| $ref: '#/components/schemas/contact_persons_associated_payload' | |
| place_of_supply: | |
| $ref: '#/components/schemas/place_of_supply' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| gst_treatment: | |
| $ref: '#/components/schemas/gst_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| is_reverse_charge_applied: | |
| $ref: '#/components/schemas/is_reverse_charge_applied' | |
| cfdi_usage: | |
| $ref: '#/components/schemas/cfdi_usage' | |
| allow_partial_payments: | |
| $ref: '#/components/schemas/allow_partial_payments' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| start_date: | |
| $ref: '#/components/schemas/start_date' | |
| end_date: | |
| $ref: '#/components/schemas/end_date' | |
| recurrence_frequency: | |
| $ref: '#/components/schemas/recurrence_frequency' | |
| repeat_every: | |
| $ref: '#/components/schemas/repeat_every' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| line_items: | |
| description: Line items of an invoice. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| line_item_id: | |
| $ref: '#/components/schemas/line_item_id' | |
| quantity: | |
| $ref: '#/components/schemas/quantity' | |
| name: | |
| $ref: '#/components/schemas/name' | |
| item_total: | |
| $ref: '#/components/schemas/item_total' | |
| product_type: | |
| $ref: '#/components/schemas/product_type' | |
| hsn_or_sac: | |
| $ref: '#/components/schemas/hsn_or_sac' | |
| sat_item_key_code: | |
| $ref: '#/components/schemas/sat_item_key_code' | |
| unitkey_code: | |
| $ref: '#/components/schemas/unitkey_code' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tds_tax_id: | |
| $ref: '#/components/schemas/tds_tax_id' | |
| tax_treatment_code: | |
| $ref: '#/components/schemas/tax_treatment_code' | |
| project_id: | |
| $ref: '#/components/schemas/project_id' | |
| header_name: | |
| $ref: '#/components/schemas/header_name' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| email: | |
| $ref: '#/components/schemas/email' | |
| billing_address: | |
| $ref: '#/components/schemas/billing_address' | |
| shipping_address: | |
| $ref: '#/components/schemas/shipping_address' | |
| avatax_use_code: | |
| $ref: '#/components/schemas/avatax_use_code' | |
| avatax_exempt_no: | |
| $ref: '#/components/schemas/avatax_exempt_no' | |
| template_id: | |
| $ref: '#/components/schemas/template_id' | |
| payment_terms: | |
| $ref: '#/components/schemas/payment_terms' | |
| payment_terms_label: | |
| $ref: '#/components/schemas/payment_terms_label' | |
| tax_authority_id: | |
| $ref: '#/components/schemas/tax_authority_id' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| payment_options: | |
| $ref: '#/components/schemas/payment_options' | |
| discount: | |
| $ref: '#/components/schemas/discount' | |
| is_discount_before_tax: | |
| $ref: '#/components/schemas/is_discount_before_tax' | |
| discount_type: | |
| $ref: '#/components/schemas/discount_type' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| item_id: | |
| $ref: '#/components/schemas/item_id' | |
| name: | |
| $ref: '#/components/schemas/name' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| quantity: | |
| $ref: '#/components/schemas/quantity' | |
| unit: | |
| $ref: '#/components/schemas/unit' | |
| avatax_tax_code: | |
| $ref: '#/components/schemas/avatax_tax_code' | |
| salesperson_name: | |
| $ref: '#/components/schemas/salesperson_name' | |
| shipping_charge: | |
| $ref: '#/components/schemas/shipping_charge' | |
| adjustment: | |
| $ref: '#/components/schemas/adjustment' | |
| adjustment_description: | |
| $ref: '#/components/schemas/adjustment_description' | |
| create-a-recurring-invoice-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The recurring invoice has been created. | |
| readOnly: true | |
| recurring_invoice: | |
| $ref: '#/components/schemas/recurring_invoice-response' | |
| page_context: | |
| type: object | |
| properties: | |
| page: | |
| $ref: '#/components/schemas/page' | |
| per_page: | |
| $ref: '#/components/schemas/per_page' | |
| has_more_page: | |
| $ref: '#/components/schemas/has_more_page' | |
| report_name: | |
| $ref: '#/components/schemas/report_name' | |
| applied_filter: | |
| $ref: '#/components/schemas/applied_filter' | |
| sort_column: | |
| $ref: '#/components/schemas/sort_column' | |
| sort_order: | |
| $ref: '#/components/schemas/sort_order' | |
| create-a-retainerinvoice-request: | |
| required: | |
| - customer_id | |
| - line_items | |
| type: object | |
| properties: | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| contact_persons_associated: | |
| $ref: '#/components/schemas/contact_persons_associated_payload' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| terms: | |
| $ref: '#/components/schemas/terms' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| line_items: | |
| description: Line items of an invoice. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| description: | |
| $ref: '#/components/schemas/description' | |
| item_order: | |
| $ref: '#/components/schemas/item_order' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| payment_options: | |
| $ref: '#/components/schemas/payment_options' | |
| template_id: | |
| $ref: '#/components/schemas/template_id' | |
| place_of_supply: | |
| $ref: '#/components/schemas/place_of_supply' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| create-a-retainerinvoice-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The retainer invoice has been created. | |
| readOnly: true | |
| retainerinvoice: | |
| $ref: '#/components/schemas/retainerinvoice-response' | |
| create-a-rule-request: | |
| required: | |
| - rule_name | |
| - target_account_id | |
| - apply_to | |
| - criteria_type | |
| - criterion | |
| - record_as | |
| type: object | |
| properties: | |
| rule_name: | |
| $ref: '#/components/schemas/rule_name' | |
| target_account_id: | |
| $ref: '#/components/schemas/target_account_id' | |
| apply_to: | |
| description: 'Rule applies to either deposits or withdrawals for bank accounts | |
| and to refunds or charges for credit card account. Allowed Values : <code>withdrawals</code>, | |
| <code>deposits</code>, <code>refunds</code> and <code>charges</code>.' | |
| type: string | |
| example: deposits | |
| criteria_type: | |
| description: 'Specifies whether all the criteria have to be satisfied or | |
| not. Allowed Values : <code>and</code> and <code>or</code>' | |
| type: string | |
| example: and | |
| criterion: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| field: | |
| $ref: '#/components/schemas/field' | |
| comparator: | |
| $ref: '#/components/schemas/comparator' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| record_as: | |
| description: 'Record transaction based on value specified in apply_to node. | |
| For bank accounts: If apply_to is deposits: sales_without_invoices, transfer_fund, | |
| interest_income, other_income, expense_refund, deposit. If apply_to is | |
| withdrawals: expense, transfer_fund, card_payment, owner_drawings. For | |
| credit_card accounts: If apply_to is refunds: card_payment, transfer_fund, | |
| expense_refund, refund. If apply_to is charges: expense, transfer_fund. | |
| Allowed Values: <code>expense</code>, <code>deposit</code>, <code>refund</code>, | |
| <code>transfer_fund</code>, <code>card_payment</code>, <code>sales_without_invoices</code>, | |
| <code>expense_refund</code>, <code>interest_income</code>, <code>other_income</code> | |
| and <code>owner_drawings</code>' | |
| type: string | |
| example: deposit | |
| account_id: | |
| description: Account which is involved in the rule with the target account. | |
| type: integer | |
| format: int64 | |
| example: 460000000049001 | |
| customer_id: | |
| description: ID of the customer.(Applicable for sales_without_invoices,deposit, | |
| expense) | |
| type: integer | |
| format: int64 | |
| example: 46000000000111 | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| reference_number: | |
| description: 'Specifies if Reference number is manual or generated from | |
| the statement. Allowed Values: <code>manual</code> and <code>from_statement</code>' | |
| type: string | |
| example: manual | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| is_reverse_charge_applied: | |
| $ref: '#/components/schemas/is_reverse_charge_applied' | |
| product_type: | |
| $ref: '#/components/schemas/product_type' | |
| tax_authority_id: | |
| $ref: '#/components/schemas/tax_authority_id' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| create-a-rule-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The bank rule has been created. | |
| readOnly: true | |
| rule: | |
| $ref: '#/components/schemas/rule' | |
| create-a-sales-order-request: | |
| required: | |
| - customer_id | |
| type: object | |
| properties: | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| contact_persons_associated: | |
| $ref: '#/components/schemas/contact_persons_associated_payload' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| shipment_date: | |
| $ref: '#/components/schemas/shipment_date' | |
| custom_fields: | |
| description: Custom fields for a sales order. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| customfield_id: | |
| $ref: '#/components/schemas/customfield_id' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| place_of_supply: | |
| $ref: '#/components/schemas/place_of_supply' | |
| salesperson_id: | |
| $ref: '#/components/schemas/salesperson_id' | |
| merchant_id: | |
| $ref: '#/components/schemas/merchant_id' | |
| gst_treatment: | |
| $ref: '#/components/schemas/gst_treatment' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| line_items: | |
| description: Line items of a sales order. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| item_order: | |
| $ref: '#/components/schemas/item_order' | |
| item_id: | |
| $ref: '#/components/schemas/item_id' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| name: | |
| $ref: '#/components/schemas/name' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| quantity: | |
| $ref: '#/components/schemas/quantity' | |
| product_type: | |
| $ref: '#/components/schemas/product_type' | |
| hsn_or_sac: | |
| $ref: '#/components/schemas/hsn_or_sac' | |
| sat_item_key_code: | |
| $ref: '#/components/schemas/sat_item_key_code' | |
| unitkey_code: | |
| $ref: '#/components/schemas/unitkey_code' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| discount: | |
| $ref: '#/components/schemas/discount' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tds_tax_id: | |
| $ref: '#/components/schemas/tds_tax_id' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| unit: | |
| $ref: '#/components/schemas/unit' | |
| item_custom_fields: | |
| description: Custom fields for a sales order items. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| customfield_id: | |
| $ref: '#/components/schemas/customfield_id' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| tax_exemption_code: | |
| $ref: '#/components/schemas/tax_exemption_code' | |
| tax_treatment_code: | |
| $ref: '#/components/schemas/tax_treatment_code' | |
| avatax_exempt_no: | |
| $ref: '#/components/schemas/avatax_exempt_no' | |
| avatax_use_code: | |
| $ref: '#/components/schemas/avatax_use_code' | |
| project_id: | |
| $ref: '#/components/schemas/project_id' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| terms: | |
| $ref: '#/components/schemas/terms' | |
| billing_address_id: | |
| $ref: '#/components/schemas/billing_address_id' | |
| shipping_address_id: | |
| $ref: '#/components/schemas/shipping_address_id' | |
| crm_owner_id: | |
| $ref: '#/components/schemas/crm_owner_id' | |
| crm_custom_reference_id: | |
| $ref: '#/components/schemas/crm_custom_reference_id' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| is_reverse_charge_applied: | |
| $ref: '#/components/schemas/is_reverse_charge_applied' | |
| salesorder_number: | |
| $ref: '#/components/schemas/salesorder_number' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| is_update_customer: | |
| $ref: '#/components/schemas/is_update_customer' | |
| discount: | |
| $ref: '#/components/schemas/discount' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| salesperson_name: | |
| $ref: '#/components/schemas/salesperson_name' | |
| notes_default: | |
| $ref: '#/components/schemas/notes_default' | |
| terms_default: | |
| $ref: '#/components/schemas/terms_default' | |
| tax_id: | |
| description: Tax ID for the Sales Order. | |
| type: string | |
| example: '460000000017094' | |
| tax_authority_id: | |
| $ref: '#/components/schemas/tax_authority_id' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| tax_authority_name: | |
| $ref: '#/components/schemas/tax_authority_name' | |
| tax_exemption_code: | |
| $ref: '#/components/schemas/tax_exemption_code' | |
| avatax_exempt_no: | |
| $ref: '#/components/schemas/avatax_exempt_no' | |
| avatax_use_code: | |
| $ref: '#/components/schemas/avatax_use_code' | |
| shipping_charge: | |
| $ref: '#/components/schemas/shipping_charge' | |
| adjustment: | |
| $ref: '#/components/schemas/adjustment' | |
| delivery_method: | |
| $ref: '#/components/schemas/delivery_method' | |
| estimate_id: | |
| description: ID of the estimate associated with the Sales Order | |
| type: string | |
| is_discount_before_tax: | |
| $ref: '#/components/schemas/is_discount_before_tax' | |
| discount_type: | |
| $ref: '#/components/schemas/discount_type' | |
| adjustment_description: | |
| $ref: '#/components/schemas/adjustment_description' | |
| pricebook_id: | |
| $ref: '#/components/schemas/pricebook_id' | |
| template_id: | |
| $ref: '#/components/schemas/template_id' | |
| documents: | |
| $ref: '#/components/schemas/documents' | |
| zcrm_potential_id: | |
| $ref: '#/components/schemas/zcrm_potential_id' | |
| zcrm_potential_name: | |
| $ref: '#/components/schemas/zcrm_potential_name' | |
| create-a-sales-order-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Sales Order Created Successfully. | |
| readOnly: true | |
| salesorder: | |
| $ref: '#/components/schemas/salesorder' | |
| create-a-sales-receipt-request: | |
| required: | |
| - customer_id | |
| - payment_mode | |
| type: object | |
| properties: | |
| customer_id: | |
| description: Unique identifier for the customer | |
| type: string | |
| example: '460000000017138' | |
| receipt_number: | |
| description: Sales receipt number (required if auto-numbering is disabled) | |
| type: string | |
| example: SR-00001 | |
| date: | |
| description: Date of the sales receipt | |
| type: string | |
| example: '2014-07-28' | |
| payment_mode: | |
| description: 'Mode through which payment was received. Allowed values: cash, | |
| check, credit_card, bank_transfer, etc.' | |
| type: string | |
| example: cash | |
| line_items: | |
| description: Line items for the sales receipt | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| item_id: | |
| description: ID of the item | |
| type: string | |
| example: '460000000017088' | |
| rate: | |
| description: Rate of the item | |
| type: number | |
| format: double | |
| example: 120 | |
| quantity: | |
| description: Quantity of the item | |
| type: number | |
| format: double | |
| example: 2 | |
| tax_id: | |
| description: ID of the tax to be applied | |
| type: string | |
| example: '460000000017094' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| notes: | |
| description: Notes for the sales receipt | |
| type: string | |
| example: Thank you for your business | |
| terms: | |
| description: Terms and conditions | |
| type: string | |
| example: Payment received in full | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| create-a-sales-receipt-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Sales Receipt Created Successfully. | |
| readOnly: true | |
| salesreceipt: | |
| $ref: '#/components/schemas/salesreceipt-response' | |
| create-a-tax-authority-us-and-ca-edition-only-request: | |
| required: | |
| - tax_authority_name | |
| type: object | |
| properties: | |
| tax_authority_name: | |
| $ref: '#/components/schemas/tax_authority_name' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| registration_number: | |
| $ref: '#/components/schemas/registration_number' | |
| registration_number_label: | |
| $ref: '#/components/schemas/registration_number_label' | |
| create-a-tax-authority-us-and-ca-edition-only-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Tax Authority has been added. | |
| readOnly: true | |
| tax_authority: | |
| $ref: '#/components/schemas/tax_authority' | |
| create-a-tax-exemption-us-edition-only-request: | |
| required: | |
| - tax_exemption_code | |
| - type | |
| type: object | |
| properties: | |
| tax_exemption_code: | |
| $ref: '#/components/schemas/tax_exemption_code' | |
| description: | |
| description: Description | |
| type: string | |
| example: Tax exempted because the contact is a reseller. | |
| type: | |
| $ref: '#/components/schemas/type' | |
| create-a-tax-exemption-us-edition-only-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Tax Exemption has been added. | |
| readOnly: true | |
| tax_exemption: | |
| type: object | |
| properties: | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| tax_exemption_code: | |
| $ref: '#/components/schemas/tax_exemption_code' | |
| description: | |
| description: Description | |
| type: string | |
| example: Tax exempted because the contact is a reseller. | |
| type: | |
| $ref: '#/components/schemas/type' | |
| create-a-tax-group-request: | |
| type: object | |
| properties: | |
| tax_group_name: | |
| $ref: '#/components/schemas/tax_group_name' | |
| taxes: | |
| $ref: '#/components/schemas/taxes' | |
| create-a-tax-group-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| tax_group: | |
| type: object | |
| properties: | |
| tax_group_id: | |
| $ref: '#/components/schemas/tax_group_id' | |
| tax_group_name: | |
| $ref: '#/components/schemas/tax_group_name' | |
| tax_group_percentage: | |
| $ref: '#/components/schemas/tax_group_percentage' | |
| taxes: | |
| description: Comma Seperated list of tax IDs that are to be associated | |
| to the tax group. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tax_name: | |
| $ref: '#/components/schemas/tax_name' | |
| tax_percentage: | |
| $ref: '#/components/schemas/tax_percentage' | |
| tax_type: | |
| $ref: '#/components/schemas/tax_type' | |
| tax_factor: | |
| $ref: '#/components/schemas/tax_factor' | |
| tax_authority_id: | |
| $ref: '#/components/schemas/tax_authority_id' | |
| tax_authority_name: | |
| $ref: '#/components/schemas/tax_authority_name' | |
| create-a-tax-request: | |
| type: object | |
| properties: | |
| tax_name: | |
| $ref: '#/components/schemas/tax_name' | |
| tax_percentage: | |
| $ref: '#/components/schemas/tax_percentage' | |
| tax_type: | |
| $ref: '#/components/schemas/tax_type' | |
| tax_factor: | |
| $ref: '#/components/schemas/tax_factor' | |
| tax_specific_type: | |
| $ref: '#/components/schemas/tax_specific_type' | |
| tax_authority_name: | |
| $ref: '#/components/schemas/tax_authority_name' | |
| tax_authority_id: | |
| $ref: '#/components/schemas/tax_authority_id' | |
| country_code: | |
| $ref: '#/components/schemas/country_code' | |
| purchase_tax_expense_account_id: | |
| $ref: '#/components/schemas/purchase_tax_expense_account_id' | |
| is_value_added: | |
| $ref: '#/components/schemas/is_value_added' | |
| update_recurring_invoice: | |
| $ref: '#/components/schemas/update_recurring_invoice' | |
| update_recurring_expense: | |
| $ref: '#/components/schemas/update_recurring_expense' | |
| update_draft_invoice: | |
| $ref: '#/components/schemas/update_draft_invoice' | |
| update_recurring_bills: | |
| $ref: '#/components/schemas/update_recurring_bills' | |
| update_draft_so: | |
| $ref: '#/components/schemas/update_draft_so' | |
| update_subscription: | |
| $ref: '#/components/schemas/update_subscription' | |
| update_project: | |
| $ref: '#/components/schemas/update_project' | |
| is_editable: | |
| $ref: '#/components/schemas/is_editable' | |
| create-a-tax-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The tax has been added. | |
| readOnly: true | |
| tax: | |
| $ref: '#/components/schemas/tax' | |
| create-a-transaction-for-an-account-request: | |
| required: | |
| - transaction_type | |
| type: object | |
| properties: | |
| from_account_id: | |
| $ref: '#/components/schemas/from_account_id' | |
| to_account_id: | |
| $ref: '#/components/schemas/to_account_id' | |
| transaction_type: | |
| $ref: '#/components/schemas/transaction_type' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| payment_mode: | |
| $ref: '#/components/schemas/payment_mode' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| from_account_tags: | |
| $ref: '#/components/schemas/tags' | |
| to_account_tags: | |
| $ref: '#/components/schemas/tags' | |
| documents: | |
| $ref: '#/components/schemas/documents' | |
| bank_charges: | |
| $ref: '#/components/schemas/bank_charges' | |
| user_id: | |
| $ref: '#/components/schemas/user_id' | |
| tax_authority_id: | |
| $ref: '#/components/schemas/tax_authority_id' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| create-a-transaction-for-an-account-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The bank transaction has been recorded. | |
| readOnly: true | |
| banktransaction: | |
| $ref: '#/components/schemas/banktransaction' | |
| create-a-user-request: | |
| required: | |
| - name | |
| type: object | |
| properties: | |
| name: | |
| $ref: '#/components/schemas/name' | |
| email: | |
| $ref: '#/components/schemas/email' | |
| role_id: | |
| $ref: '#/components/schemas/role_id' | |
| cost_rate: | |
| $ref: '#/components/schemas/cost_rate' | |
| create-a-user-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Your invitation has been sent. | |
| readOnly: true | |
| create-a-vendor-credit-request: | |
| required: | |
| - vendor_id | |
| type: object | |
| properties: | |
| vendor_id: | |
| $ref: '#/components/schemas/vendor_id' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| vendor_credit_number: | |
| description: Mandatory if auto number generation is disabled. | |
| type: string | |
| example: DN-00002 | |
| gst_treatment: | |
| $ref: '#/components/schemas/gst_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| source_of_supply: | |
| $ref: '#/components/schemas/source_of_supply' | |
| destination_of_supply: | |
| $ref: '#/components/schemas/destination_of_supply' | |
| place_of_supply: | |
| $ref: '#/components/schemas/place_of_supply' | |
| pricebook_id: | |
| $ref: '#/components/schemas/pricebook_id' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| is_update_customer: | |
| $ref: '#/components/schemas/is_update_customer' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| line_items: | |
| $ref: '#/components/schemas/line_items' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| documents: | |
| $ref: '#/components/schemas/documents' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| create-a-vendor-credit-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Vendor credit has been created. | |
| readOnly: true | |
| vendor_credit: | |
| $ref: '#/components/schemas/vendor_credit-response' | |
| create-a-vendor-payment-request: | |
| required: | |
| - amount | |
| type: object | |
| properties: | |
| vendor_id: | |
| $ref: '#/components/schemas/vendor_id' | |
| bills: | |
| $ref: '#/components/schemas/bills' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| paid_through_account_id: | |
| $ref: '#/components/schemas/paid_through_account_id' | |
| payment_mode: | |
| $ref: '#/components/schemas/payment_mode' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| check_details: | |
| $ref: '#/components/schemas/check_details' | |
| is_paid_via_print_check: | |
| $ref: '#/components/schemas/is_paid_via_print_check' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| custom_fields: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| index: | |
| $ref: '#/components/schemas/index' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| create-a-vendor-payment-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The payment made to the vendor has been recorded. | |
| readOnly: true | |
| ach_payment_status: | |
| $ref: '#/components/schemas/ach_payment_status' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| balance: | |
| $ref: '#/components/schemas/balance' | |
| billing_address: | |
| $ref: '#/components/schemas/billing_address' | |
| bills: | |
| description: Individual bill payment details as list. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| bill_payment_id: | |
| $ref: '#/components/schemas/bill_payment_id' | |
| bill_id: | |
| $ref: '#/components/schemas/bill_id' | |
| amount_applied: | |
| $ref: '#/components/schemas/amount_applied' | |
| tax_amount_withheld: | |
| $ref: '#/components/schemas/tax_amount_withheld' | |
| balance: | |
| $ref: '#/components/schemas/balance' | |
| bill_number: | |
| $ref: '#/components/schemas/bill_number' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| due_date: | |
| $ref: '#/components/schemas/due_date' | |
| price_precision: | |
| $ref: '#/components/schemas/price_precision' | |
| total: | |
| $ref: '#/components/schemas/total' | |
| check_details: | |
| type: object | |
| properties: | |
| amount_in_words: | |
| $ref: '#/components/schemas/amount_in_words' | |
| check_id: | |
| $ref: '#/components/schemas/check_id' | |
| check_number: | |
| $ref: '#/components/schemas/check_number' | |
| check_status: | |
| $ref: '#/components/schemas/check_status' | |
| memo: | |
| $ref: '#/components/schemas/memo' | |
| comments: | |
| $ref: '#/components/schemas/comments' | |
| created_time: | |
| $ref: '#/components/schemas/created_time' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| currency_symbol: | |
| $ref: '#/components/schemas/currency_symbol' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| imported_transactions: | |
| $ref: '#/components/schemas/imported_transactions' | |
| documents: | |
| $ref: '#/components/schemas/documents' | |
| is_ach_payment: | |
| $ref: '#/components/schemas/is_ach_payment' | |
| is_paid_via_print_check: | |
| $ref: '#/components/schemas/is_paid_via_print_check' | |
| last_modified_time: | |
| $ref: '#/components/schemas/last_modified_time' | |
| paid_through_account_id: | |
| $ref: '#/components/schemas/paid_through_account_id' | |
| paid_through_account_name: | |
| $ref: '#/components/schemas/paid_through_account_name' | |
| paid_through_account_type: | |
| $ref: '#/components/schemas/paid_through_account_type' | |
| payment_id: | |
| $ref: '#/components/schemas/payment_id' | |
| payment_mode: | |
| $ref: '#/components/schemas/payment_mode' | |
| payment_number: | |
| $ref: '#/components/schemas/payment_number' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| tags: | |
| $ref: '#/components/schemas/tags_response' | |
| tax_account_name: | |
| $ref: '#/components/schemas/tax_account_name' | |
| tax_amount_withheld: | |
| $ref: '#/components/schemas/tax_amount_withheld' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| location_name: | |
| $ref: '#/components/schemas/location_name' | |
| vendor_id: | |
| $ref: '#/components/schemas/vendor_id' | |
| vendor_name: | |
| $ref: '#/components/schemas/vendor_name' | |
| vendorpayment_refunds: | |
| $ref: '#/components/schemas/vendorpayment_refunds' | |
| create-an-account-request: | |
| type: object | |
| properties: | |
| account_name: | |
| $ref: '#/components/schemas/account_name' | |
| account_code: | |
| $ref: '#/components/schemas/account_code' | |
| account_type: | |
| $ref: '#/components/schemas/account_type' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| show_on_dashboard: | |
| $ref: '#/components/schemas/show_on_dashboard' | |
| can_show_in_ze: | |
| $ref: '#/components/schemas/can_show_in_ze' | |
| include_in_vat_return: | |
| $ref: '#/components/schemas/include_in_vat_return' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| parent_account_id: | |
| $ref: '#/components/schemas/parent_account_id' | |
| create-an-account-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The account has been created. | |
| readOnly: true | |
| chart_of_account: | |
| $ref: '#/components/schemas/chart_of_account' | |
| create-an-employee-request: | |
| required: | |
| - name | |
| type: object | |
| properties: | |
| name: | |
| $ref: '#/components/schemas/name' | |
| email: | |
| $ref: '#/components/schemas/email' | |
| create-an-employee-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| employee: | |
| type: object | |
| properties: | |
| employee_id: | |
| $ref: '#/components/schemas/employee_id' | |
| name: | |
| $ref: '#/components/schemas/name' | |
| email: | |
| $ref: '#/components/schemas/email' | |
| create-an-estimate-request: | |
| required: | |
| - customer_id | |
| - line_items | |
| type: object | |
| properties: | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| contact_persons_associated: | |
| $ref: '#/components/schemas/contact_persons_associated_payload' | |
| template_id: | |
| $ref: '#/components/schemas/template_id' | |
| place_of_supply: | |
| $ref: '#/components/schemas/place_of_supply' | |
| gst_treatment: | |
| $ref: '#/components/schemas/gst_treatment' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| estimate_number: | |
| description: Unique identifier for the estimate. If not provided, the system | |
| auto-generates one. This number is used for tracking, referencing, and | |
| communicating the estimate to customers. It appears on the estimate PDF | |
| and in all customer communications. | |
| $ref: '#/components/schemas/estimate_number' | |
| reference_number: | |
| description: External reference associated with the estimate. Use this field | |
| to link the estimate to external systems, customer requests, or internal | |
| workflows. The reference number appears on the estimate document for customer | |
| and internal tracking. | |
| $ref: '#/components/schemas/reference_number' | |
| date: | |
| description: 'Date the estimate is created. This date appears on the estimate | |
| document and is used for record-keeping, reporting, and determining the | |
| validity period. Format: YYYY-MM-DD.' | |
| $ref: '#/components/schemas/date' | |
| expiry_date: | |
| description: 'Date when the estimate expires. After this date, the estimate | |
| is no longer valid for acceptance. Used to set deadlines for customer | |
| response and manage time-sensitive offers. Format: YYYY-MM-DD.' | |
| $ref: '#/components/schemas/expiry_date' | |
| exchange_rate: | |
| description: Exchange rate used to convert the estimate amount to the base | |
| currency of your organization. Required for multi-currency transactions. | |
| The exchange rate affects the total amount and reporting in the base currency. | |
| $ref: '#/components/schemas/exchange_rate' | |
| discount: | |
| description: Discount applied to the estimate, either as a percentage (e.g., | |
| 10%) or a fixed amount (e.g., 100.00). Specify the value and type as per | |
| your pricing policy. | |
| $ref: '#/components/schemas/discount' | |
| is_discount_before_tax: | |
| description: Indicates whether the discount is applied before or after tax | |
| calculation. When true, the discount is applied to the subtotal before | |
| tax. When false, the discount is applied after tax is calculated. | |
| $ref: '#/components/schemas/is_discount_before_tax' | |
| discount_type: | |
| description: 'Specifies how the discount is applied: at the entity (entire | |
| estimate) level or item (line item) level. Allowed values: "entity_level", | |
| "item_level". This setting determines whether the discount is distributed | |
| across all items or applied to specific items only.' | |
| $ref: '#/components/schemas/discount_type' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| custom_body: | |
| $ref: '#/components/schemas/custom_body' | |
| custom_subject: | |
| $ref: '#/components/schemas/custom_subject' | |
| salesperson_name: | |
| $ref: '#/components/schemas/salesperson_name' | |
| custom_fields: | |
| description: Custom fields for an estimate. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| index: | |
| $ref: '#/components/schemas/index' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| line_items: | |
| description: Line items of an estimate. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| item_id: | |
| $ref: '#/components/schemas/item_id' | |
| line_item_id: | |
| $ref: '#/components/schemas/line_item_id' | |
| name: | |
| $ref: '#/components/schemas/name' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| product_type: | |
| $ref: '#/components/schemas/product_type' | |
| hsn_or_sac: | |
| $ref: '#/components/schemas/hsn_or_sac' | |
| sat_item_key_code: | |
| $ref: '#/components/schemas/sat_item_key_code' | |
| unitkey_code: | |
| $ref: '#/components/schemas/unitkey_code' | |
| item_order: | |
| $ref: '#/components/schemas/item_order' | |
| bcy_rate: | |
| $ref: '#/components/schemas/bcy_rate' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| quantity: | |
| $ref: '#/components/schemas/quantity' | |
| unit: | |
| $ref: '#/components/schemas/unit' | |
| discount_amount: | |
| $ref: '#/components/schemas/discount_amount' | |
| discount: | |
| $ref: '#/components/schemas/discount' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tds_tax_id: | |
| $ref: '#/components/schemas/tds_tax_id' | |
| tax_name: | |
| $ref: '#/components/schemas/tax_name' | |
| tax_type: | |
| $ref: '#/components/schemas/tax_type' | |
| tax_percentage: | |
| $ref: '#/components/schemas/tax_percentage' | |
| tax_treatment_code: | |
| $ref: '#/components/schemas/tax_treatment_code' | |
| item_total: | |
| $ref: '#/components/schemas/item_total' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| terms: | |
| $ref: '#/components/schemas/terms' | |
| shipping_charge: | |
| $ref: '#/components/schemas/shipping_charge' | |
| adjustment: | |
| $ref: '#/components/schemas/adjustment' | |
| adjustment_description: | |
| $ref: '#/components/schemas/adjustment_description' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| tax_authority_id: | |
| $ref: '#/components/schemas/tax_authority_id' | |
| avatax_use_code: | |
| $ref: '#/components/schemas/avatax_use_code' | |
| avatax_exempt_no: | |
| $ref: '#/components/schemas/avatax_exempt_no' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| is_reverse_charge_applied: | |
| $ref: '#/components/schemas/is_reverse_charge_applied' | |
| item_id: | |
| $ref: '#/components/schemas/item_id' | |
| line_item_id: | |
| $ref: '#/components/schemas/line_item_id' | |
| name: | |
| $ref: '#/components/schemas/name' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| unit: | |
| $ref: '#/components/schemas/unit' | |
| quantity: | |
| $ref: '#/components/schemas/quantity' | |
| project_id: | |
| $ref: '#/components/schemas/project_id' | |
| accept_retainer: | |
| $ref: '#/components/schemas/accept_retainer' | |
| retainer_percentage: | |
| $ref: '#/components/schemas/retainer_percentage' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| create-an-estimate-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The estimate has been created | |
| readOnly: true | |
| estimate: | |
| $ref: '#/components/schemas/estimate-response' | |
| create-an-exchange-rate-request: | |
| type: object | |
| properties: | |
| effective_date: | |
| $ref: '#/components/schemas/effective_date' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| create-an-exchange-rate-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The exchange rate has been added. | |
| readOnly: true | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| create-an-expense-request: | |
| required: | |
| - date | |
| - account_id | |
| - amount | |
| - paid_through_account_id | |
| type: object | |
| properties: | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| source_of_supply: | |
| $ref: '#/components/schemas/source_of_supply' | |
| destination_of_supply: | |
| $ref: '#/components/schemas/destination_of_supply' | |
| place_of_supply: | |
| $ref: '#/components/schemas/place_of_supply' | |
| hsn_or_sac: | |
| $ref: '#/components/schemas/hsn_or_sac' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| reverse_charge_tax_id: | |
| $ref: '#/components/schemas/reverse_charge_tax_id' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| line_items: | |
| $ref: '#/components/schemas/line_items' | |
| taxes: | |
| $ref: '#/components/schemas/taxes' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| is_billable: | |
| $ref: '#/components/schemas/is_billable' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| project_id: | |
| $ref: '#/components/schemas/project_id' | |
| mileage_type: | |
| $ref: '#/components/schemas/mileage_type' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| product_type: | |
| $ref: '#/components/schemas/product_type' | |
| acquisition_vat_id: | |
| $ref: '#/components/schemas/acquisition_vat_id' | |
| reverse_charge_vat_id: | |
| $ref: '#/components/schemas/reverse_charge_vat_id' | |
| start_reading: | |
| $ref: '#/components/schemas/start_reading' | |
| end_reading: | |
| $ref: '#/components/schemas/end_reading' | |
| distance: | |
| $ref: '#/components/schemas/distance' | |
| mileage_unit: | |
| $ref: '#/components/schemas/mileage_unit' | |
| mileage_rate: | |
| $ref: '#/components/schemas/mileage_rate' | |
| employee_id: | |
| $ref: '#/components/schemas/employee_id' | |
| vehicle_type: | |
| $ref: '#/components/schemas/vehicle_type' | |
| can_reclaim_vat_on_mileage: | |
| $ref: '#/components/schemas/can_reclaim_vat_on_mileage' | |
| fuel_type: | |
| $ref: '#/components/schemas/fuel_type' | |
| engine_capacity_range: | |
| $ref: '#/components/schemas/engine_capacity_range' | |
| paid_through_account_id: | |
| $ref: '#/components/schemas/paid_through_account_id' | |
| vendor_id: | |
| $ref: '#/components/schemas/vendor_id' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| create-an-expense-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The expense has been recorded. | |
| readOnly: true | |
| expense: | |
| $ref: '#/components/schemas/expense-response' | |
| create-an-instant-invoice-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The invoice has been created. | |
| readOnly: true | |
| invoice: | |
| type: object | |
| properties: | |
| invoice_id: | |
| $ref: '#/components/schemas/invoice_id' | |
| ach_payment_initiated: | |
| $ref: '#/components/schemas/ach_payment_initiated' | |
| invoice_number: | |
| $ref: '#/components/schemas/invoice_number' | |
| is_pre_gst: | |
| $ref: '#/components/schemas/is_pre_gst' | |
| place_of_supply: | |
| $ref: '#/components/schemas/place_of_supply' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| gst_treatment: | |
| $ref: '#/components/schemas/gst_treatment' | |
| cfdi_usage: | |
| $ref: '#/components/schemas/cfdi_usage' | |
| cfdi_reference_type: | |
| $ref: '#/components/schemas/cfdi_reference_type' | |
| reference_invoice_id: | |
| description: Associate the reference invoice. | |
| type: string | |
| example: '132738000000126013' | |
| x-node_available_in: | |
| - mx | |
| x-node_unavailable_in: [] | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| is_reverse_charge_applied: | |
| $ref: '#/components/schemas/is_reverse_charge_applied' | |
| vat_reg_no: | |
| $ref: '#/components/schemas/vat_reg_no' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| status: | |
| $ref: '#/components/schemas/status' | |
| payment_terms: | |
| $ref: '#/components/schemas/payment_terms' | |
| payment_terms_label: | |
| $ref: '#/components/schemas/payment_terms_label' | |
| due_date: | |
| $ref: '#/components/schemas/due_date' | |
| payment_expected_date: | |
| $ref: '#/components/schemas/payment_expected_date' | |
| last_payment_date: | |
| $ref: '#/components/schemas/last_payment_date' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| customer_name: | |
| $ref: '#/components/schemas/customer_name' | |
| contact_persons_associated: | |
| $ref: '#/components/schemas/contact_persons_associated' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| currency_code: | |
| $ref: '#/components/schemas/currency_code' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| discount: | |
| $ref: '#/components/schemas/discount' | |
| is_discount_before_tax: | |
| $ref: '#/components/schemas/is_discount_before_tax' | |
| discount_type: | |
| $ref: '#/components/schemas/discount_type' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| recurring_invoice_id: | |
| $ref: '#/components/schemas/recurring_invoice_id' | |
| is_viewed_by_client: | |
| $ref: '#/components/schemas/is_viewed_by_client' | |
| has_attachment: | |
| $ref: '#/components/schemas/has_attachment' | |
| client_viewed_time: | |
| $ref: '#/components/schemas/client_viewed_time' | |
| line_items: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| line_item_id: | |
| $ref: '#/components/schemas/line_item_id' | |
| item_id: | |
| $ref: '#/components/schemas/item_id' | |
| project_id: | |
| $ref: '#/components/schemas/project_id' | |
| sat_item_key_code: | |
| $ref: '#/components/schemas/sat_item_key_code' | |
| unitkey_code: | |
| $ref: '#/components/schemas/unitkey_code' | |
| project_name: | |
| $ref: '#/components/schemas/project_name' | |
| time_entry_ids: | |
| $ref: '#/components/schemas/time_entry_ids' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| location_name: | |
| $ref: '#/components/schemas/location_name' | |
| item_type: | |
| $ref: '#/components/schemas/item_type' | |
| product_type: | |
| $ref: '#/components/schemas/product_type' | |
| expense_id: | |
| $ref: '#/components/schemas/expense_id' | |
| expense_receipt_name: | |
| $ref: '#/components/schemas/expense_receipt_name' | |
| name: | |
| $ref: '#/components/schemas/name' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| item_order: | |
| $ref: '#/components/schemas/item_order' | |
| bcy_rate: | |
| $ref: '#/components/schemas/bcy_rate' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| quantity: | |
| $ref: '#/components/schemas/quantity' | |
| unit: | |
| $ref: '#/components/schemas/unit' | |
| discount_amount: | |
| $ref: '#/components/schemas/discount_amount' | |
| discount: | |
| $ref: '#/components/schemas/discount' | |
| tags: | |
| $ref: '#/components/schemas/tags_response' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tds_tax_id: | |
| $ref: '#/components/schemas/tds_tax_id' | |
| tax_name: | |
| $ref: '#/components/schemas/tax_name' | |
| tax_type: | |
| $ref: '#/components/schemas/tax_type' | |
| tax_percentage: | |
| $ref: '#/components/schemas/tax_percentage' | |
| tax_treatment_code: | |
| $ref: '#/components/schemas/tax_treatment_code' | |
| item_total: | |
| $ref: '#/components/schemas/item_total' | |
| header_name: | |
| $ref: '#/components/schemas/header_name' | |
| header_id: | |
| $ref: '#/components/schemas/header_id' | |
| shipping_charge: | |
| $ref: '#/components/schemas/shipping_charge' | |
| adjustment: | |
| $ref: '#/components/schemas/adjustment' | |
| adjustment_description: | |
| $ref: '#/components/schemas/adjustment_description' | |
| sub_total: | |
| $ref: '#/components/schemas/sub_total' | |
| tax_total: | |
| $ref: '#/components/schemas/tax_total' | |
| total: | |
| $ref: '#/components/schemas/total' | |
| taxes: | |
| $ref: '#/components/schemas/taxes' | |
| payment_reminder_enabled: | |
| $ref: '#/components/schemas/payment_reminder_enabled' | |
| payment_made: | |
| $ref: '#/components/schemas/payment_made' | |
| credits_applied: | |
| $ref: '#/components/schemas/credits_applied' | |
| tax_amount_withheld: | |
| $ref: '#/components/schemas/tax_amount_withheld' | |
| balance: | |
| $ref: '#/components/schemas/balance' | |
| write_off_amount: | |
| $ref: '#/components/schemas/write_off_amount' | |
| allow_partial_payments: | |
| $ref: '#/components/schemas/allow_partial_payments' | |
| price_precision: | |
| $ref: '#/components/schemas/price_precision' | |
| payment_options: | |
| $ref: '#/components/schemas/payment_options' | |
| is_emailed: | |
| $ref: '#/components/schemas/is_emailed' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| location_name: | |
| $ref: '#/components/schemas/location_name' | |
| reminders_sent: | |
| $ref: '#/components/schemas/reminders_sent' | |
| last_reminder_sent_date: | |
| $ref: '#/components/schemas/last_reminder_sent_date' | |
| billing_address: | |
| $ref: '#/components/schemas/billing_address' | |
| shipping_address: | |
| $ref: '#/components/schemas/update-shipping-address-request' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| terms: | |
| $ref: '#/components/schemas/terms' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| tags: | |
| $ref: '#/components/schemas/tags_response' | |
| template_id: | |
| $ref: '#/components/schemas/template_id' | |
| template_name: | |
| $ref: '#/components/schemas/template_name' | |
| created_time: | |
| $ref: '#/components/schemas/created_time' | |
| last_modified_time: | |
| $ref: '#/components/schemas/last_modified_time' | |
| attachment_name: | |
| $ref: '#/components/schemas/attachment_name' | |
| can_send_in_mail: | |
| $ref: '#/components/schemas/can_send_in_mail' | |
| salesperson_id: | |
| $ref: '#/components/schemas/salesperson_id' | |
| salesperson_name: | |
| $ref: '#/components/schemas/salesperson_name' | |
| salesorder_id: | |
| $ref: '#/components/schemas/salesorder_id' | |
| salesorder_number: | |
| $ref: '#/components/schemas/salesorder_number' | |
| salesorders: | |
| type: object | |
| properties: | |
| salesorder_id: | |
| $ref: '#/components/schemas/salesorder_id' | |
| salesorder_number: | |
| $ref: '#/components/schemas/salesorder_number' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| crm_custom_reference_id: | |
| $ref: '#/components/schemas/crm_custom_reference_id' | |
| salesorder_order_status: | |
| $ref: '#/components/schemas/salesorder_order_status' | |
| total: | |
| $ref: '#/components/schemas/total' | |
| total_formatted: | |
| $ref: '#/components/schemas/total_formatted' | |
| sub_total: | |
| $ref: '#/components/schemas/sub_total' | |
| sub_total_formatted: | |
| $ref: '#/components/schemas/sub_total_formatted' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| shipment_date: | |
| $ref: '#/components/schemas/shipment_date' | |
| invoice_url: | |
| $ref: '#/components/schemas/invoice_url' | |
| create-an-invoice-request: | |
| required: | |
| - customer_id | |
| - line_items | |
| type: object | |
| properties: | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| contact_persons: | |
| $ref: '#/components/schemas/contact_persons' | |
| contact_persons_associated: | |
| $ref: '#/components/schemas/contact_persons_associated_payload' | |
| invoice_number: | |
| $ref: '#/components/schemas/invoice_number' | |
| place_of_supply: | |
| $ref: '#/components/schemas/place_of_supply' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| is_reverse_charge_applied: | |
| $ref: '#/components/schemas/is_reverse_charge_applied' | |
| gst_treatment: | |
| $ref: '#/components/schemas/gst_treatment' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| cfdi_usage: | |
| $ref: '#/components/schemas/cfdi_usage' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| template_id: | |
| $ref: '#/components/schemas/template_id' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| payment_terms: | |
| $ref: '#/components/schemas/payment_terms' | |
| payment_terms_label: | |
| $ref: '#/components/schemas/payment_terms_label' | |
| due_date: | |
| $ref: '#/components/schemas/due_date' | |
| discount: | |
| $ref: '#/components/schemas/discount' | |
| is_discount_before_tax: | |
| $ref: '#/components/schemas/is_discount_before_tax' | |
| discount_type: | |
| $ref: '#/components/schemas/discount_type' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| recurring_invoice_id: | |
| $ref: '#/components/schemas/recurring_invoice_id' | |
| invoiced_estimate_id: | |
| $ref: '#/components/schemas/invoiced_estimate_id' | |
| salesperson_name: | |
| $ref: '#/components/schemas/salesperson_name' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| send: | |
| $ref: '#/components/schemas/send' | |
| line_items: | |
| type: array | |
| items: | |
| type: object | |
| required: | |
| - item_id | |
| properties: | |
| item_id: | |
| $ref: '#/components/schemas/item_id' | |
| project_id: | |
| $ref: '#/components/schemas/project_id' | |
| time_entry_ids: | |
| $ref: '#/components/schemas/time_entry_ids' | |
| product_type: | |
| $ref: '#/components/schemas/product_type' | |
| hsn_or_sac: | |
| $ref: '#/components/schemas/hsn_or_sac' | |
| sat_item_key_code: | |
| $ref: '#/components/schemas/sat_item_key_code' | |
| unitkey_code: | |
| $ref: '#/components/schemas/unitkey_code' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| expense_id: | |
| $ref: '#/components/schemas/expense_id' | |
| bill_id: | |
| $ref: '#/components/schemas/bill_id' | |
| bill_item_id: | |
| $ref: '#/components/schemas/bill_item_id' | |
| expense_receipt_name: | |
| $ref: '#/components/schemas/expense_receipt_name' | |
| name: | |
| $ref: '#/components/schemas/name' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| item_order: | |
| $ref: '#/components/schemas/item_order' | |
| bcy_rate: | |
| $ref: '#/components/schemas/bcy_rate' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| quantity: | |
| $ref: '#/components/schemas/quantity' | |
| unit: | |
| $ref: '#/components/schemas/unit' | |
| discount_amount: | |
| $ref: '#/components/schemas/discount_amount' | |
| discount: | |
| $ref: '#/components/schemas/discount' | |
| tags: | |
| $ref: '#/components/schemas/tags' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tds_tax_id: | |
| $ref: '#/components/schemas/tds_tax_id' | |
| tax_name: | |
| $ref: '#/components/schemas/tax_name' | |
| tax_type: | |
| $ref: '#/components/schemas/tax_type' | |
| tax_percentage: | |
| $ref: '#/components/schemas/tax_percentage' | |
| tax_treatment_code: | |
| $ref: '#/components/schemas/tax_treatment_code' | |
| header_name: | |
| $ref: '#/components/schemas/header_name' | |
| salesorder_item_id: | |
| $ref: '#/components/schemas/salesorder_item_id' | |
| payment_options: | |
| $ref: '#/components/schemas/payment_options' | |
| allow_partial_payments: | |
| $ref: '#/components/schemas/allow_partial_payments' | |
| custom_body: | |
| $ref: '#/components/schemas/custom_body' | |
| custom_subject: | |
| $ref: '#/components/schemas/custom_subject' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| terms: | |
| $ref: '#/components/schemas/terms' | |
| shipping_charge: | |
| $ref: '#/components/schemas/shipping_charge' | |
| adjustment: | |
| $ref: '#/components/schemas/adjustment' | |
| adjustment_description: | |
| $ref: '#/components/schemas/adjustment_description' | |
| reason: | |
| $ref: '#/components/schemas/reason' | |
| tax_authority_id: | |
| $ref: '#/components/schemas/tax_authority_id' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| billing_address_id: | |
| $ref: '#/components/schemas/billing_address_id' | |
| shipping_address_id: | |
| $ref: '#/components/schemas/shipping_address_id' | |
| avatax_use_code: | |
| $ref: '#/components/schemas/avatax_use_code' | |
| avatax_exempt_no: | |
| $ref: '#/components/schemas/avatax_exempt_no' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| expense_id: | |
| $ref: '#/components/schemas/expense_id' | |
| salesorder_item_id: | |
| $ref: '#/components/schemas/salesorder_item_id' | |
| avatax_tax_code: | |
| $ref: '#/components/schemas/avatax_tax_code' | |
| time_entry_ids: | |
| $ref: '#/components/schemas/time_entry_ids' | |
| batch_payments: | |
| description: Array of batch payment details to be processed with the invoice. | |
| Each payment includes payment mode, amount, and account information for | |
| automated payment processing. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| payment_mode: | |
| description: Mode of payment for this batch payment entry. | |
| type: string | |
| example: Cash | |
| amount: | |
| description: Payment amount for this batch payment entry. | |
| type: string | |
| example: '100.00' | |
| account_id: | |
| description: Account ID where the payment will be recorded. | |
| type: string | |
| example: '1000000095342' | |
| example: | |
| - payment_mode: Cash | |
| amount: '100.00' | |
| account_id: '1000000095342' | |
| create-an-invoice-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The invoice has been created. | |
| readOnly: true | |
| invoice: | |
| $ref: '#/components/schemas/invoice-response' | |
| create-an-item-request: | |
| required: | |
| - name | |
| - rate | |
| type: object | |
| properties: | |
| name: | |
| $ref: '#/components/schemas/name' | |
| rate: | |
| $ref: '#/components/schemas/rate' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| locations: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| initial_stock: | |
| $ref: '#/components/schemas/initial_stock' | |
| initial_stock_rate: | |
| $ref: '#/components/schemas/initial_stock_rate' | |
| purchase_tax_rule_id: | |
| $ref: '#/components/schemas/purchase_tax_rule_id' | |
| sales_tax_rule_id: | |
| $ref: '#/components/schemas/sales_tax_rule_id' | |
| tax_percentage: | |
| $ref: '#/components/schemas/tax_percentage' | |
| sku: | |
| $ref: '#/components/schemas/sku' | |
| product_type: | |
| $ref: '#/components/schemas/product_type' | |
| hsn_or_sac: | |
| $ref: '#/components/schemas/hsn_or_sac' | |
| sat_item_key_code: | |
| $ref: '#/components/schemas/sat_item_key_code' | |
| unitkey_code: | |
| $ref: '#/components/schemas/unitkey_code' | |
| is_taxable: | |
| $ref: '#/components/schemas/is_taxable' | |
| tax_exemption_id: | |
| $ref: '#/components/schemas/tax_exemption_id' | |
| purchase_tax_exemption_id: | |
| $ref: '#/components/schemas/purchase_tax_exemption_id' | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| avatax_tax_code: | |
| $ref: '#/components/schemas/avatax_tax_code' | |
| avatax_use_code: | |
| $ref: '#/components/schemas/avatax_use_code' | |
| item_type: | |
| $ref: '#/components/schemas/item_type' | |
| purchase_description: | |
| $ref: '#/components/schemas/purchase_description' | |
| purchase_rate: | |
| $ref: '#/components/schemas/purchase_rate' | |
| purchase_account_id: | |
| $ref: '#/components/schemas/purchase_account_id' | |
| inventory_account_id: | |
| $ref: '#/components/schemas/inventory_account_id' | |
| vendor_id: | |
| $ref: '#/components/schemas/vendor_id' | |
| reorder_level: | |
| $ref: '#/components/schemas/reorder_level' | |
| item_tax_preferences: | |
| $ref: '#/components/schemas/item_tax_preferences' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| create-an-item-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The item has been added. | |
| readOnly: true | |
| item: | |
| $ref: '#/components/schemas/item-response' | |
| create-an-organization-request: | |
| required: | |
| - name | |
| - currency_code | |
| - time_zone | |
| - portal_name | |
| type: object | |
| properties: | |
| name: | |
| description: Name of the project. | |
| type: string | |
| example: Zillium Inc | |
| fiscal_year_start_month: | |
| description: 'Fiscal or financial starting year of your business. Allowed | |
| Values: <code>january</code>, <code>february</code>, <code>march</code>, | |
| <code>april</code>,<code> may</code>, <code>june</code>, <code>july</code>, | |
| <code>august</code>, <code>september</code>, <code>october</code>, <code>november</code> | |
| and <code>december</code>' | |
| type: string | |
| example: january | |
| currency_code: | |
| description: Standard code for currency. | |
| type: string | |
| example: USD | |
| time_zone: | |
| description: Time zone in with the organization is located geographically. | |
| type: string | |
| example: PST | |
| date_format: | |
| description: Format for representing the date. | |
| type: string | |
| example: dd MMM yyyy | |
| field_separator: | |
| description: Field separator for components in date. | |
| type: string | |
| example: ' ' | |
| language_code: | |
| description: language code for organization.For instance <code>en</code> | |
| represents english. | |
| type: string | |
| example: en | |
| industry_type: | |
| $ref: '#/components/schemas/industry_type' | |
| industry_size: | |
| $ref: '#/components/schemas/industry_size' | |
| portal_name: | |
| $ref: '#/components/schemas/portal_name' | |
| org_address: | |
| $ref: '#/components/schemas/org_address' | |
| remit_to_address: | |
| $ref: '#/components/schemas/remit_to_address' | |
| address: | |
| $ref: '#/components/schemas/address' | |
| create-an-organization-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| organization: | |
| $ref: '#/components/schemas/organization-response' | |
| create-custom-modules-request: | |
| required: | |
| - record_name | |
| type: object | |
| properties: | |
| record_name: | |
| $ref: '#/components/schemas/record_name' | |
| cf_debt_amount: | |
| $ref: '#/components/schemas/cf_debt_amount' | |
| create-custom-modules-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: debtor is created successfully | |
| readOnly: true | |
| module_record: | |
| $ref: '#/components/schemas/module_record' | |
| create-opening-balance-request: | |
| required: | |
| - date | |
| type: object | |
| properties: | |
| date: | |
| $ref: '#/components/schemas/date' | |
| accounts: | |
| type: array | |
| items: | |
| type: object | |
| required: | |
| - debit_or_credit | |
| properties: | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| debit_or_credit: | |
| $ref: '#/components/schemas/debit_or_credit' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| create-opening-balance-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The opening balances are saved! | |
| readOnly: true | |
| opening_balance: | |
| $ref: '#/components/schemas/opening_balance' | |
| created_by_id: | |
| description: Name of User who created the Bill | |
| type: string | |
| example: '4600000053001' | |
| created_time: | |
| description: Created Time of the Transaction | |
| type: string | |
| example: 2013-01-24T12:03:25+0530 | |
| created_time_formatted: | |
| description: Formatted value of created time | |
| type: string | |
| example: 2022-02-18T11:00:45+0530 | |
| credit-to-an-invoice-request: | |
| required: | |
| - invoice_id | |
| - amount_applied | |
| type: object | |
| properties: | |
| invoices: | |
| description: List of invoices for which the credit note has been raised. | |
| This contains <code>invoice_id</code> and <code>amount</code>. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| invoice_id: | |
| $ref: '#/components/schemas/invoice_id' | |
| amount_applied: | |
| $ref: '#/components/schemas/amount_applied' | |
| invoice_id: | |
| $ref: '#/components/schemas/invoice_id' | |
| amount_applied: | |
| $ref: '#/components/schemas/amount_applied' | |
| credit-to-an-invoice-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Credits have been applied to the invoice(s). | |
| readOnly: true | |
| credit_amount: | |
| type: number | |
| format: double | |
| example: 25 | |
| credit_limit: | |
| description: <b>For Customer Only :</b> The maximum credit amount that can be | |
| allowed for the customer. Once the customer's outstanding receivables reach | |
| this limit, the system will restrict the customer from creating any further | |
| transactions. | |
| type: number | |
| format: double | |
| example: 1000 | |
| credited_amount: | |
| description: The total amount that is credited. | |
| type: number | |
| format: double | |
| example: 12.02 | |
| credited_date: | |
| description: The date of credit | |
| type: string | |
| example: '2013-11-18' | |
| creditnote-response: | |
| type: object | |
| properties: | |
| creditnote_id: | |
| $ref: '#/components/schemas/creditnote_id' | |
| creditnote_number: | |
| $ref: '#/components/schemas/creditnote_number' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| is_pre_gst: | |
| $ref: '#/components/schemas/is_pre_gst' | |
| place_of_supply: | |
| $ref: '#/components/schemas/place_of_supply' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| vat_reg_no: | |
| $ref: '#/components/schemas/vat_reg_no' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| cfdi_usage: | |
| $ref: '#/components/schemas/cfdi_usage' | |
| cfdi_reference_type: | |
| $ref: '#/components/schemas/cfdi_reference_type' | |
| gst_treatment: | |
| $ref: '#/components/schemas/gst_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| is_reverse_charge_applied: | |
| $ref: '#/components/schemas/is_reverse_charge_applied' | |
| status: | |
| $ref: '#/components/schemas/status' | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| customer_name: | |
| $ref: '#/components/schemas/customer_name' | |
| contact_persons_associated: | |
| $ref: '#/components/schemas/contact_persons_associated' | |
| custom_fields: | |
| description: Additional fields for the Credit-Notes. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| index: | |
| $ref: '#/components/schemas/index' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| label: | |
| $ref: '#/components/schemas/label' | |
| data_type: | |
| $ref: '#/components/schemas/data_type' | |
| tags: | |
| $ref: '#/components/schemas/tags_response' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| email: | |
| $ref: '#/components/schemas/email' | |
| total: | |
| $ref: '#/components/schemas/total' | |
| balance: | |
| $ref: '#/components/schemas/balance' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| location_name: | |
| $ref: '#/components/schemas/location_name' | |
| line_items: | |
| $ref: '#/components/schemas/line_items' | |
| invoices: | |
| description: List of invoices for which the credit note has been raised. | |
| This contains <code>invoice_id</code> and <code>amount</code>. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| invoice_id: | |
| $ref: '#/components/schemas/invoice_id' | |
| invoice_number: | |
| $ref: '#/components/schemas/invoice_number' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| taxes: | |
| description: Taxes associated wit the subscription. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tax_name: | |
| $ref: '#/components/schemas/tax_name' | |
| tax_amount: | |
| $ref: '#/components/schemas/tax_amount' | |
| currency_code: | |
| $ref: '#/components/schemas/currency_code' | |
| currency_symbol: | |
| $ref: '#/components/schemas/currency_symbol' | |
| billing_address: | |
| type: object | |
| properties: | |
| address: | |
| $ref: '#/components/schemas/address' | |
| street2: | |
| $ref: '#/components/schemas/street2' | |
| city: | |
| $ref: '#/components/schemas/city' | |
| state: | |
| $ref: '#/components/schemas/state' | |
| zip: | |
| $ref: '#/components/schemas/zip' | |
| country: | |
| $ref: '#/components/schemas/country' | |
| fax: | |
| $ref: '#/components/schemas/fax' | |
| shipping_address: | |
| type: object | |
| properties: | |
| address: | |
| $ref: '#/components/schemas/address' | |
| street2: | |
| $ref: '#/components/schemas/street2' | |
| city: | |
| $ref: '#/components/schemas/city' | |
| state: | |
| $ref: '#/components/schemas/state' | |
| zip: | |
| $ref: '#/components/schemas/zip' | |
| country: | |
| $ref: '#/components/schemas/country' | |
| fax: | |
| $ref: '#/components/schemas/fax' | |
| created_time: | |
| $ref: '#/components/schemas/created_time' | |
| updated_time: | |
| $ref: '#/components/schemas/updated_time' | |
| template_id: | |
| $ref: '#/components/schemas/template_id' | |
| template_name: | |
| $ref: '#/components/schemas/template_name' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| terms: | |
| $ref: '#/components/schemas/terms' | |
| creditnote_email_template_id: | |
| description: Default credit note email template id used for this customer while | |
| sending credit notes. | |
| type: string | |
| example: 460000000052075 | |
| creditnote_email_template_name: | |
| type: string | |
| example: Custom Credit Note Notification | |
| creditnote_id: | |
| description: ID of the credit note that has to be refunded. | |
| type: string | |
| example: '4000000030049' | |
| creditnote_invoice_id: | |
| type: string | |
| example: '982000000567172' | |
| creditnote_number: | |
| type: string | |
| example: CN-00001 | |
| creditnote_refund_id: | |
| type: string | |
| example: 982000000567158 | |
| creditnote_refunds: | |
| type: array | |
| items: | |
| type: string | |
| creditnote_template_id: | |
| description: Default credit note template id used for this customer while creating | |
| credit note. | |
| type: string | |
| example: 460000000000211 | |
| creditnote_template_name: | |
| type: string | |
| example: Fixed Cost - Professional | |
| creditnotes_invoice_id: | |
| description: The creditnotes invoice id | |
| type: string | |
| example: '982000000567172' | |
| creditnotes_number: | |
| description: The creditnotes Number | |
| type: string | |
| example: CN-00001 | |
| credits: | |
| description: The list of credits | |
| type: array | |
| items: | |
| type: string | |
| credits_applied: | |
| description: The credits applied | |
| type: number | |
| format: float | |
| example: 22.43 | |
| criteria_id: | |
| description: ID of the Criteria | |
| type: string | |
| example: '460000000048009' | |
| criteria_options: | |
| description: Options for criteria | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| option_id: | |
| $ref: '#/components/schemas/option_id' | |
| criteria_options: | |
| description: List containing filter tags and location | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| tag_id: | |
| $ref: '#/components/schemas/filter_tag_id' | |
| type: | |
| $ref: '#/components/schemas/filter_type' | |
| options: | |
| description: Options selected for the criteria | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/option_id' | |
| criteria_options_response: | |
| type: array | |
| description: Options selected for the criteria | |
| items: | |
| type: object | |
| properties: | |
| option_id: | |
| $ref: '#/components/schemas/option_id' | |
| option_name: | |
| $ref: '#/components/schemas/option_name' | |
| option_order: | |
| type: integer | |
| description: The order in which the options appear. | |
| example: 1 | |
| parent_id: | |
| type: string | |
| description: Parent Option ID. If the options does not have a parent, | |
| this will be empty | |
| example: '460000000038081' | |
| parent_name: | |
| type: string | |
| description: Parent Option Name. If the options does not have a parent, | |
| this will be empty | |
| example: Sales | |
| is_active: | |
| $ref: '#/components/schemas/option_is_active' | |
| is_default: | |
| $ref: '#/components/schemas/option_is_default' | |
| criteria: | |
| type: object | |
| properties: | |
| criteria_id: | |
| type: string | |
| description: Filter ID | |
| example: '460000000038084' | |
| tag_id: | |
| $ref: '#/components/schemas/filter_tag_id' | |
| type: | |
| $ref: '#/components/schemas/filter_type' | |
| options: | |
| description: Options selected for the criteria | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/filter_option_id' | |
| children: | |
| description: Child options of the option | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| option_id: | |
| $ref: '#/components/schemas/option_id' | |
| option_name: | |
| $ref: '#/components/schemas/option_name' | |
| option_order: | |
| type: integer | |
| description: The order in which the options appear. | |
| example: 1 | |
| parent_id: | |
| type: string | |
| description: Parent Option ID. If the options does not have a parent, | |
| this will be empty | |
| example: '460000000038081' | |
| parent_name: | |
| type: string | |
| description: Parent Option Name. If the options does not have a | |
| parent, this will be empty | |
| example: Sales | |
| is_active: | |
| $ref: '#/components/schemas/option_is_active' | |
| is_default: | |
| $ref: '#/components/schemas/option_is_default' | |
| criteria: | |
| type: object | |
| properties: | |
| criteria_id: | |
| type: string | |
| description: Filter ID | |
| example: '460000000038084' | |
| tag_id: | |
| $ref: '#/components/schemas/filter_tag_id' | |
| type: | |
| $ref: '#/components/schemas/filter_type' | |
| options: | |
| description: Options selected for the criteria | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/filter_option_id' | |
| criteria_options_response_for_details_page: | |
| type: array | |
| description: Options selected for the criteria | |
| items: | |
| type: object | |
| properties: | |
| option_id: | |
| $ref: '#/components/schemas/option_id' | |
| option_name: | |
| $ref: '#/components/schemas/option_name' | |
| option_order: | |
| type: integer | |
| description: The order in which the options appear. | |
| example: 1 | |
| parent_id: | |
| type: string | |
| description: Parent Option ID. If the options does not have a parent, | |
| this will be empty | |
| example: '460000000038081' | |
| parent_name: | |
| type: string | |
| description: Parent Option Name. If the options does not have a parent, | |
| this will be empty | |
| example: Sales | |
| is_active: | |
| $ref: '#/components/schemas/option_is_active' | |
| is_default: | |
| $ref: '#/components/schemas/option_is_default' | |
| criteria: | |
| type: object | |
| properties: | |
| criteria_id: | |
| type: string | |
| description: Filter ID | |
| example: '460000000038084' | |
| tag_id: | |
| $ref: '#/components/schemas/filter_tag_id' | |
| type: | |
| $ref: '#/components/schemas/filter_type' | |
| options: | |
| description: Options selected for the criteria | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/filter_option_name' | |
| children: | |
| description: Child options of the option | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| option_id: | |
| $ref: '#/components/schemas/option_id' | |
| option_name: | |
| $ref: '#/components/schemas/option_name' | |
| option_order: | |
| type: integer | |
| description: The order in which the options appear. | |
| example: 1 | |
| parent_id: | |
| type: string | |
| description: Parent Option ID. If the options does not have a parent, | |
| this will be empty | |
| example: '460000000038081' | |
| parent_name: | |
| type: string | |
| description: Parent Option Name. If the options does not have a | |
| parent, this will be empty | |
| example: Sales | |
| is_active: | |
| $ref: '#/components/schemas/option_is_active' | |
| is_default: | |
| $ref: '#/components/schemas/option_is_default' | |
| criteria: | |
| type: object | |
| properties: | |
| criteria_id: | |
| type: string | |
| description: Filter ID | |
| example: '460000000038084' | |
| tag_id: | |
| $ref: '#/components/schemas/filter_tag_id' | |
| type: | |
| $ref: '#/components/schemas/filter_type' | |
| options: | |
| description: Options selected for the criteria | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/filter_option_id' | |
| example: | |
| - option_id: '460000000038081' | |
| option_name: Sales | |
| is_active: true | |
| is_default: false | |
| depth: 0 | |
| option_order: 1 | |
| parent_id: '' | |
| parent_name: '' | |
| criteria: | |
| - options: | |
| - Asia | |
| - India | |
| - Europe | |
| criteria_id: '460000000048081' | |
| tag_id: '' | |
| type: location | |
| - options: | |
| - Untagged | |
| - Government | |
| - Military / Defense | |
| criteria_id: '460000000048083' | |
| tag_id: '460000000038078' | |
| type: tag | |
| children: | |
| - option_id: '460000000038083' | |
| option_name: Sales - Central | |
| children: [] | |
| is_active: true | |
| is_default: false | |
| depth: 0 | |
| option_order: 2 | |
| parent_id: '' | |
| parent_name: '' | |
| criteria: | |
| - options: | |
| - Asia | |
| - North America | |
| criteria_id: '460000000048081' | |
| tag_id: '' | |
| type: location | |
| - options: | |
| - All | |
| criteria_id: '460000000048083' | |
| tag_id: '460000000038078' | |
| type: tag | |
| criteria_tags: | |
| description: Filter tags and location | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| tag_id: | |
| $ref: '#/components/schemas/filter_tag_id' | |
| type: | |
| $ref: '#/components/schemas/filter_type' | |
| criteria_type: | |
| description: Type of Criteria | |
| type: string | |
| example: and | |
| criterion: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| criteria_id: | |
| $ref: '#/components/schemas/criteria_id' | |
| field: | |
| $ref: '#/components/schemas/field' | |
| comparator: | |
| $ref: '#/components/schemas/comparator' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| crm_custom_reference_id: | |
| type: string | |
| example: '' | |
| crm_owner_id: | |
| description: Unique identifier of the CRM owner assigned to this purchase order. | |
| This field links the purchase order to a specific CRM user who is responsible | |
| for managing the vendor relationship and overseeing the procurement process. | |
| The CRM owner can track, follow up, and manage all aspects of this purchase | |
| order within the CRM system. | |
| type: string | |
| currency: | |
| type: object | |
| properties: | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| currency_code: | |
| $ref: '#/components/schemas/currency_code' | |
| currency_name: | |
| $ref: '#/components/schemas/currency_name' | |
| currency_symbol: | |
| $ref: '#/components/schemas/currency_symbol' | |
| price_precision: | |
| $ref: '#/components/schemas/price_precision' | |
| currency_format: | |
| $ref: '#/components/schemas/currency_format' | |
| is_base_currency: | |
| $ref: '#/components/schemas/is_base_currency' | |
| currency_code: | |
| description: Code of the currency associated with the Bank Account | |
| type: string | |
| example: USD | |
| currency_format: | |
| description: The format for the currency to be displayed. Max-len [100] | |
| type: string | |
| example: 1,234,567.89 | |
| currency_id: | |
| description: ID of the Currency associated with the Account | |
| type: string | |
| example: '460000000000097' | |
| currency_name: | |
| description: The name for the currency. | |
| type: string | |
| example: AUD- Australian Dollar | |
| currency_symbol: | |
| description: Symbol of the Currency associated with the Account | |
| type: string | |
| example: $ | |
| current_asset_value: | |
| description: Current value of the fixed asset | |
| type: number | |
| example: 1000 | |
| current_balance: | |
| description: Current Balance in the account | |
| current_value: | |
| description: Current value of the fixed asset | |
| type: number | |
| example: 824.78 | |
| custom_body: | |
| type: string | |
| example: ' ' | |
| custom_field: | |
| description: 'Search bills by item name. Variants: <code>custom_field_startswith</code> | |
| and <code>custom_field_contains</code>' | |
| type: string | |
| custom_field_id: | |
| type: integer | |
| format: int64 | |
| custom_fields: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| custom_field_id: | |
| $ref: '#/components/schemas/custom_field_id' | |
| index: | |
| $ref: '#/components/schemas/index' | |
| label: | |
| $ref: '#/components/schemas/label' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| custom_fields_update: | |
| description: Custom fields for an invoice. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| customfield_id: | |
| type: integer | |
| format: int64 | |
| example: '46000000012845' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| custom_subject: | |
| type: string | |
| example: ' ' | |
| customer_email: | |
| description: Email address of the customer to whom the recurring invoice is | |
| raised. | |
| type: string | |
| example: emailid@abcstudios.com | |
| customer_id: | |
| description: ID of the Customer involved in the transaction | |
| type: string | |
| example: '460000000026049' | |
| customer_mobile_phone: | |
| description: Mobile phone number of the customer to whom the recurring invoice | |
| is raised. | |
| type: string | |
| example: 9876543210 | |
| customer_name: | |
| description: Name of the Customer Associated with the Rule | |
| type: string | |
| example: Trendz | |
| customer_phone: | |
| description: Phone number of the customer to whom the recurring invoice is raised. | |
| type: string | |
| example: 012-12345678 | |
| customer_sub_type: | |
| description: '<b>For Customer Only :</b> Additional classification for customers. | |
| Allowed values: <code>individual</code>, <code>business</code>.' | |
| type: string | |
| example: business | |
| customfield_id: | |
| description: ID of the Custom Field | |
| type: string | |
| example: '460000000080163' | |
| customview_id: | |
| description: ID of the customview | |
| type: string | |
| example: '460000004000597' | |
| data: | |
| type: object | |
| properties: | |
| base_currency_adjustment_id: | |
| $ref: '#/components/schemas/base_currency_adjustment_id' | |
| adjustment_date: | |
| $ref: '#/components/schemas/adjustment_date' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| accounts: | |
| $ref: '#/components/schemas/accounts' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| currency_code: | |
| $ref: '#/components/schemas/currency_code' | |
| data_type: | |
| description: Data type of the custom field. | |
| type: string | |
| example: text | |
| data_type_formatted: | |
| description: Formattd data type of the field | |
| type: string | |
| example: Text Box (Single Line) | |
| date: | |
| description: Date of the transaction | |
| type: string | |
| example: '2012-01-14' | |
| date_after: | |
| description: Date after which Transactions are to be filtered | |
| type: string | |
| date_before: | |
| description: Date before which Transactions are to be filtered | |
| type: string | |
| date_description: | |
| description: Description of the Date of Comment | |
| type: string | |
| example: few seconds ago | |
| date_format: | |
| type: string | |
| example: dd MMM yyyy | |
| date_formatted: | |
| description: Date of the comment | |
| type: string | |
| example: 17/02/2022 12:09 AM | |
| deactivate-account-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The account has been marked as inactive. | |
| readOnly: true | |
| debit_amount: | |
| type: string | |
| debit_note: | |
| type: object | |
| properties: | |
| invoice_id: | |
| type: string | |
| example: '982000000567114' | |
| invoice_number: | |
| type: string | |
| example: DN-00001 | |
| date: | |
| type: string | |
| example: '2013-11-17' | |
| status: | |
| type: string | |
| example: draft | |
| customer_id: | |
| type: string | |
| example: '982000000567001' | |
| customer_name: | |
| type: string | |
| example: Bowman & Co | |
| total: | |
| type: number | |
| example: 40.6 | |
| balance: | |
| type: number | |
| example: 40.6 | |
| created_time: | |
| type: string | |
| example: 2013-11-17T17:09:00+0530 | |
| last_modified_time: | |
| type: string | |
| example: 2013-11-17T17:09:00+0530 | |
| line_items: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/line_item' | |
| reference_invoice: | |
| $ref: '#/components/schemas/reference_invoice_data' | |
| tags: | |
| $ref: '#/components/schemas/tags_response' | |
| debit_note_number: | |
| type: string | |
| description: Debit note number | |
| example: DN-00001 | |
| debit_or_credit: | |
| description: Indicates if transaction is Debit or Credit | |
| type: string | |
| example: credit | |
| declined_date: | |
| description: The date of declination of the estimates | |
| type: string | |
| example: ' ' | |
| default_templates: | |
| type: object | |
| properties: | |
| invoice_template_id: | |
| $ref: '#/components/schemas/invoice_template_id' | |
| estimate_template_id: | |
| $ref: '#/components/schemas/estimate_template_id' | |
| creditnote_template_id: | |
| $ref: '#/components/schemas/creditnote_template_id' | |
| purchaseorder_template_id: | |
| $ref: '#/components/schemas/purchaseorder_template_id' | |
| salesorder_template_id: | |
| $ref: '#/components/schemas/salesorder_template_id' | |
| retainerinvoice_template_id: | |
| $ref: '#/components/schemas/retainerinvoice_template_id' | |
| paymentthankyou_template_id: | |
| $ref: '#/components/schemas/paymentthankyou_template_id' | |
| retainerinvoice_paymentthankyou_template_id: | |
| $ref: '#/components/schemas/retainerinvoice_paymentthankyou_template_id' | |
| invoice_email_template_id: | |
| $ref: '#/components/schemas/invoice_email_template_id' | |
| estimate_email_template_id: | |
| $ref: '#/components/schemas/estimate_email_template_id' | |
| creditnote_email_template_id: | |
| $ref: '#/components/schemas/creditnote_email_template_id' | |
| purchaseorder_email_template_id: | |
| $ref: '#/components/schemas/purchaseorder_email_template_id' | |
| salesorder_email_template_id: | |
| $ref: '#/components/schemas/salesorder_email_template_id' | |
| retainerinvoice_email_template_id: | |
| $ref: '#/components/schemas/retainerinvoice_email_template_id' | |
| paymentthankyou_email_template_id: | |
| $ref: '#/components/schemas/paymentthankyou_email_template_id' | |
| retainerinvoice_paymentthankyou_email_template_id: | |
| $ref: '#/components/schemas/retainerinvoice_paymentthankyou_email_template_id' | |
| statement_template_id: | |
| $ref: '#/components/schemas/statement_template_id' | |
| payment_remittance_email_template_id: | |
| $ref: '#/components/schemas/payment_remittance_email_template_id' | |
| bill_template_id: | |
| $ref: '#/components/schemas/bill_template_id' | |
| delete-a-base-currency-adjustment-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The selected base currency adjustment has been deleted. | |
| readOnly: true | |
| delete-a-bill-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The bill has been deleted. | |
| readOnly: true | |
| delete-a-comment-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The comment has been deleted. | |
| readOnly: true | |
| delete-a-contact-person-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The contact person has been deleted. | |
| readOnly: true | |
| delete-a-contact-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The contact has been deleted. | |
| readOnly: true | |
| delete-a-credit-note-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The credit note has been deleted. | |
| readOnly: true | |
| delete-a-currency-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The currency has been deleted. | |
| readOnly: true | |
| delete-a-customer-debit-note-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| message: | |
| type: string | |
| example: The invoice has been deleted. | |
| delete-a-fixed-asset-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The selected fixed asset has been deleted. | |
| readOnly: true | |
| delete-a-fixed-asset-type-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The selected fixed asset type has been deleted. | |
| readOnly: true | |
| delete-a-journal-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The selected journal entry has been deleted. | |
| readOnly: true | |
| delete-a-location-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The location has been deleted.. | |
| readOnly: true | |
| delete-a-payment-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The payment has been deleted. | |
| readOnly: true | |
| delete-a-receipt-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The attached expense receipt has been deleted. | |
| readOnly: true | |
| delete-a-recurring-bill-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The recurring bill has been deleted. | |
| readOnly: true | |
| delete-a-recurring-expense-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The recurring expense has been deleted. | |
| readOnly: true | |
| delete-a-recurring-invoice-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The recurring invoice is deleted successfully. | |
| readOnly: true | |
| delete-a-refund-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The refund has been deleted. | |
| readOnly: true | |
| delete-a-retainer-invoice-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The retainer invoice has been deleted. | |
| readOnly: true | |
| delete-a-retainer-payment-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The payment has been deleted. | |
| readOnly: true | |
| delete-a-rule-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The rule has been deleted. | |
| readOnly: true | |
| delete-a-sales-order-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Sales Order Deleted Successfully. | |
| readOnly: true | |
| delete-a-sales-receipt-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Sales Receipt Deleted Successfully. | |
| readOnly: true | |
| delete-a-tax-authority-us-and-ca-edition-only-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Tax authority has been deleted. | |
| readOnly: true | |
| delete-a-tax-exemption-us-edition-only-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Tax exemption has been deleted successfully. | |
| readOnly: true | |
| delete-a-tax-group-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The tax group has been deleted. | |
| readOnly: true | |
| delete-a-tax-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The record has been deleted. | |
| readOnly: true | |
| delete-a-transaction-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The transaction has been deleted. | |
| readOnly: true | |
| delete-a-user-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The user has been removed from your organization. | |
| readOnly: true | |
| delete-a-vendor-payment-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The payment has been deleted. | |
| readOnly: true | |
| delete-additional-address-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The address has been deleted. | |
| readOnly: true | |
| delete-an-account-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The account has been deleted. | |
| readOnly: true | |
| delete-an-attachment-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The attachment has been deleted. | |
| readOnly: true | |
| delete-an-employee-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Employee has been deleted. | |
| readOnly: true | |
| delete-an-estimate-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The estimate has been deleted. | |
| readOnly: true | |
| delete-an-exchage-rate-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Exchange rate successfully deleted | |
| readOnly: true | |
| delete-an-expense-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The expense has been deleted. | |
| readOnly: true | |
| delete-an-invoice-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The invoice has been deleted. | |
| readOnly: true | |
| delete-an-item-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The item has been deleted. | |
| readOnly: true | |
| delete-applied-credit-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Credits applied to an invoice have been deleted. | |
| readOnly: true | |
| delete-bills-credited-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Credits applied to the bill have been deleted. | |
| readOnly: true | |
| delete-comment-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Fixed asset comment has been deleted | |
| readOnly: true | |
| delete-credit-note-refund-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The refund has been successfully deleted. | |
| readOnly: true | |
| delete-custom-modules-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Module record deleted | |
| readOnly: true | |
| delete-individual-records-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| delete-invoice-document-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The document has been deleted successfully. | |
| readOnly: true | |
| delete-invoices-credited-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Credits applied to an invoice have been deleted. | |
| readOnly: true | |
| delete-last-imported-statement-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: You have successfully deleted the last imported statement. | |
| readOnly: true | |
| delete-opening-balance-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The entered opening balance has been deleted. | |
| readOnly: true | |
| delete-project-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The project has been deleted. | |
| readOnly: true | |
| delete-purchase-order-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The purchase order has been deleted. | |
| readOnly: true | |
| delete-task-request: | |
| type: object | |
| properties: | |
| task_id: | |
| description: Unique ID of the task generated by the server. | |
| type: string | |
| example: '90300000072369' | |
| delete-task-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The task has been deleted successfully. | |
| readOnly: true | |
| delete-the-expense-receipt-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The attached expense receipt has been deleted. | |
| readOnly: true | |
| delete-time-entries-request: | |
| required: | |
| - time_entry_ids | |
| type: object | |
| properties: | |
| time_entry_ids: | |
| $ref: '#/components/schemas/time_entry_ids' | |
| delete-time-entries-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The selected timesheet entries have been deleted | |
| readOnly: true | |
| delete-time-entry-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The time entry has been deleted. | |
| readOnly: true | |
| delete-user-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The staff has been removed | |
| readOnly: true | |
| delete-vendor-credit-refund-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The refund has been successfully deleted. | |
| readOnly: true | |
| delete-vendor-credit-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The vendor credit has been deleted. | |
| readOnly: true | |
| delete_receipt: | |
| type: boolean | |
| example: false | |
| delivery_address: | |
| type: object | |
| properties: | |
| zip: | |
| $ref: '#/components/schemas/zip' | |
| is_verifiable: | |
| $ref: '#/components/schemas/is_verifiable' | |
| state: | |
| $ref: '#/components/schemas/state' | |
| address1: | |
| $ref: '#/components/schemas/address1' | |
| address2: | |
| $ref: '#/components/schemas/address2' | |
| is_valid: | |
| $ref: '#/components/schemas/is_valid' | |
| city: | |
| $ref: '#/components/schemas/city' | |
| country: | |
| $ref: '#/components/schemas/country' | |
| address: | |
| $ref: '#/components/schemas/address' | |
| email: | |
| $ref: '#/components/schemas/email' | |
| is_primary: | |
| $ref: '#/components/schemas/is_primary' | |
| organization_address_id: | |
| $ref: '#/components/schemas/organization_address_id' | |
| phone: | |
| $ref: '#/components/schemas/phone' | |
| is_verified: | |
| $ref: '#/components/schemas/is_verified' | |
| delivery_customer_id: | |
| description: Unique identifier of the customer for whom the goods or services | |
| in this purchase order are being procured. This field is used when the purchase | |
| order is created on behalf of a customer, such as in drop-shipping scenarios | |
| or when procuring items for specific customer projects. The customer information | |
| may be displayed on the purchase order for vendor reference. | |
| type: string | |
| delivery_date: | |
| description: The expected delivery date when the goods or services ordered in | |
| this purchase order should be received. This date is used for planning, scheduling, | |
| and tracking deliveries. It helps in managing inventory, coordinating with | |
| vendors, and ensuring timely receipt of ordered items. The date should be | |
| in YYYY-MM-DD format and is typically communicated to the vendor as part of | |
| the purchase order terms. | |
| type: string | |
| example: '2014-02-10' | |
| delivery_method: | |
| description: Specification of the transportation and delivery mechanism for | |
| order fulfillment. Determines shipping costs, delivery timelines, carrier | |
| selection, and customer communication regarding order status and tracking | |
| information. | |
| type: string | |
| example: Air | |
| delivery_method_id: | |
| type: string | |
| delivery_org_address_id: | |
| description: Unique identifier of the organization address where the goods or | |
| services from this purchase order should be delivered. This field specifies | |
| the delivery location within your organization, such as a warehouse, office, | |
| or branch location. The address details are retrieved from your organization's | |
| address book and displayed on the purchase order for vendor reference. | |
| type: string | |
| dep_start_value: | |
| description: Enter the value from which depreciation will be calculated. | |
| type: number | |
| format: double | |
| example: 1000 | |
| department: | |
| description: department on which a person belongs. Max-length [50] | |
| type: string | |
| example: Sales | |
| dependent_tags: | |
| type: array | |
| description: The tags and location that is associated as filter for the tag | |
| items: | |
| type: object | |
| properties: | |
| dependent_id: | |
| type: string | |
| description: Dependent Tag's ID. If the dependent is location, value will | |
| be empty | |
| example: 460000000038081 | |
| dependent_name: | |
| type: string | |
| description: Dependent Tag's Name. If the dependent is location, value | |
| will be <code>Location</code> | |
| example: Sales | |
| dependent_order: | |
| type: integer | |
| description: The order in which the dependent tags appear. If the dependent | |
| is location, value will be empty | |
| example: 1 | |
| dependent_type: | |
| type: string | |
| description: 'Type of the dependent. Allowed values: Tag <code>tag</code>, | |
| Location <code>location</code>' | |
| example: tag | |
| dependent_options: | |
| description: Options selected for the dependent tag. If the dependent | |
| is location, this will be empty | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| dependent_option_id: | |
| type: string | |
| description: Dependent Option ID | |
| example: 460000000038083 | |
| dependent_option_name: | |
| type: string | |
| description: Dependent Option Name | |
| example: Sales - East | |
| dependent_option_order: | |
| type: integer | |
| description: The order in which the options appear. | |
| example: 1 | |
| tag_name: | |
| $ref: '#/components/schemas/tag_name' | |
| deprecated_placeholders_used: | |
| type: array | |
| items: | |
| type: string | |
| example: [] | |
| depreciated_value: | |
| description: Depreciated value of the fixed asset | |
| type: number | |
| example: 91.65 | |
| depreciation_account_id: | |
| description: Enter the account id to track the asset's depreciation over time. | |
| type: string | |
| example: '3640355000000000367' | |
| depreciation_account_name: | |
| description: Name of the depreciation account | |
| type: string | |
| example: Furniture and Equipment | |
| depreciation_frequency: | |
| description: 'Enter the frequency of depreciation. The available frequencies | |
| are: <code>yearly</code> and <code>monthly</code>' | |
| type: string | |
| example: yearly | |
| depreciation_method: | |
| description: 'Enter the depreciation method for your asset.The available methods | |
| are: <code>declining_method</code> and <code>straight_line</code>. <br/><b>For | |
| US and GLobal Edition:</b> <code>declining_method</code>, <code>straight_line</code>, | |
| <code>200_declining_method</code> and <code>150_declining_method</code>' | |
| type: string | |
| example: declining_method | |
| depreciation_percentage: | |
| description: Enter the depreciation percentage only if the entered depreciation | |
| method is a declining method. The entered percentage should be within the | |
| range of 0 to 100 | |
| type: number | |
| format: double | |
| example: 12 | |
| depreciation_start_date: | |
| description: Enter the depreciation start date of the asset | |
| type: string | |
| example: '2024-12-17' | |
| depth: | |
| type: string | |
| description: | |
| description: Description of the Account | |
| type: string | |
| example: Salary details. | |
| designation: | |
| description: designation of a person. Max-length [50] | |
| type: string | |
| example: Sales Engineer | |
| destination_of_supply: | |
| description: State code where goods/services are delivered. Used for GST calculations | |
| in India. Defaults to organization home state if not specified. Supports 2-letter | |
| state codes (e.g., AP for Andhra Pradesh, TN for Tamil Nadu). | |
| type: string | |
| example: TN | |
| x-node_available_in: | |
| - in | |
| x-node_unavailable_in: [] | |
| destination_of_supply_state: | |
| description: State to where goods/services are supplied | |
| type: string | |
| example: TN | |
| x-node_available_in: | |
| - in | |
| x-node_unavailable_in: [] | |
| details-of-a-refund-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The details of the refund are displayed successfully. | |
| readOnly: true | |
| payment_refunds: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| payment_refund_id: | |
| $ref: '#/components/schemas/payment_refund_id' | |
| payment_id: | |
| $ref: '#/components/schemas/payment_id' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| refund_mode: | |
| $ref: '#/components/schemas/refund_mode' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| payment_form: | |
| $ref: '#/components/schemas/payment_form' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| disable-payment-reminder-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Reminders stopped. | |
| readOnly: true | |
| disable-payment-reminders-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: All reminders associated with this contact have been stopped. | |
| readOnly: true | |
| discount: | |
| description: Enter discount percentage. | |
| type: number | |
| format: double | |
| example: 10 | |
| discount_account_id: | |
| description: Unique identifier of the accounting account where the discount | |
| amount will be recorded. This account is used to track and categorize discount | |
| expenses in your general ledger. The discount account should be configured | |
| as an expense or contra-revenue account to properly reflect the impact of | |
| discounts on your financial statements. | |
| type: string | |
| example: '460000000011105' | |
| discount_amount: | |
| description: Amount of discount in the Invoice | |
| type: number | |
| format: double | |
| example: 20 | |
| discount_applied_on_amount: | |
| type: integer | |
| example: 0 | |
| discount_type: | |
| description: 'How the discount is specified. Allowed values are entity_level | |
| or item_level.Allowed Values: <code>entity_level</code> and <code>item_level</code>' | |
| type: string | |
| example: item_level | |
| distance: | |
| description: Distance Covered | |
| type: number | |
| format: double | |
| example: 4 | |
| doc: | |
| description: Document that is to be attached | |
| type: string | |
| document_id: | |
| description: Unique ID of the attached file. | |
| document_ids: | |
| type: integer | |
| format: int64 | |
| documents: | |
| description: List of files to be attached to a particular transaction. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| file_name: | |
| $ref: '#/components/schemas/file_name' | |
| document_id: | |
| $ref: '#/components/schemas/document_id' | |
| due_by_days: | |
| description: Days by which Bill is Due | |
| type: string | |
| due_date: | |
| description: Date when payment is due for the bill. Used for payment tracking, | |
| aging reports, and overdue calculations. Calculated based on bill date and | |
| payment terms. Bills become overdue after this date, affecting vendor relationships | |
| and cash flow planning. | |
| type: string | |
| example: '2013-09-26' | |
| due_days: | |
| type: string | |
| due_in_days: | |
| description: Days in which Bill will be Due | |
| type: integer | |
| example: 0 | |
| edit-additional-address-request: | |
| required: | |
| - address_id | |
| type: object | |
| properties: | |
| attention: | |
| $ref: '#/components/schemas/attention' | |
| address: | |
| $ref: '#/components/schemas/address' | |
| street2: | |
| $ref: '#/components/schemas/street2' | |
| city: | |
| $ref: '#/components/schemas/city' | |
| state: | |
| $ref: '#/components/schemas/state' | |
| zip: | |
| $ref: '#/components/schemas/zip' | |
| country: | |
| $ref: '#/components/schemas/country' | |
| fax: | |
| $ref: '#/components/schemas/fax' | |
| phone: | |
| description: The contact phone number associated with the address. Max-length | |
| [50] | |
| type: string | |
| example: +1-925-921-9201 | |
| address_id: | |
| description: Address id of the address | |
| type: string | |
| example: 1053791000000186000 | |
| edit-additional-address-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The address has been updated. | |
| readOnly: true | |
| address_info: | |
| $ref: '#/components/schemas/address_info' | |
| editpage-criteria-response: | |
| type: object | |
| properties: | |
| message: | |
| type: string | |
| example: success | |
| dependent_tags: | |
| $ref: '#/components/schemas/dependent_tags' | |
| is_class: | |
| $ref: '#/components/schemas/is_class' | |
| is_draft: | |
| $ref: '#/components/schemas/is_draft' | |
| tag_id: | |
| $ref: '#/components/schemas/tag_id' | |
| tag_name: | |
| $ref: '#/components/schemas/tag_name' | |
| tags: | |
| $ref: '#/components/schemas/possible_filter_tags' | |
| options: | |
| $ref: '#/components/schemas/criteria_options_response' | |
| example: | |
| - code: 0 | |
| message: success | |
| tag_id: '460000000038055' | |
| tag_name: Department | |
| is_class: false | |
| is_draft: false | |
| dependent_tags: | |
| - dependent_id: '' | |
| dependent_name: Location | |
| dependent_order: '' | |
| dependent_type: location | |
| dependent_options: | |
| - dependent_option_id: '460000000039786' | |
| dependent_option_name: Head Office | |
| dependent_option_order: '' | |
| - dependent_option_id: '460000000039788' | |
| dependent_option_name: Central Warehouse | |
| dependent_option_order: '' | |
| - dependent_id: '460000000038081' | |
| dependent_name: Business Unit | |
| dependent_order: '1' | |
| dependent_type: tag | |
| dependent_options: | |
| - dependent_option_id: '460000000038038' | |
| dependent_option_name: Public | |
| dependent_option_order: '1' | |
| - dependent_option_id: '460000000038083' | |
| dependent_option_name: Private | |
| dependent_option_order: '1' | |
| - dependent_option_id: '460000000038085' | |
| dependent_option_name: NGO | |
| dependent_option_order: '2' | |
| tags: | |
| - tag_id: '' | |
| tag_name: Location | |
| type: location | |
| is_restricted: false | |
| is_associated: true | |
| restricted_reason: '' | |
| - tag_id: '460000000038080' | |
| tag_name: Business Unit | |
| type: tag | |
| is_restricted: false | |
| is_associated: true | |
| restricted_reason: '' | |
| - tag_id: '460000000038057' | |
| tag_name: Feedback | |
| type: tag | |
| is_restricted: true | |
| is_associated: false | |
| restricted_reason: The modules associated with this reporting tag are not | |
| set at the appropriate level compared to the current tag. Kindly refer | |
| to the requirements for a filter tag. | |
| options: | |
| - option_id: '460000000054012' | |
| option_name: Sales | |
| children: | |
| - option_id: '460000000054014' | |
| option_name: Sales - East | |
| children: [] | |
| is_active: true | |
| is_default: false | |
| depth: 0 | |
| option_order: 1 | |
| parent_id: '' | |
| parent_name: '' | |
| criteria: | |
| - options: | |
| - '460000000038083' | |
| - untagged | |
| tag_id: '' | |
| type: location | |
| is_active: true | |
| is_default: false | |
| depth: 0 | |
| option_order: 1 | |
| parent_id: '' | |
| parent_name: '' | |
| criteria: | |
| - options: | |
| - all | |
| tag_id: '' | |
| type: location | |
| - option_id: '460000000054016' | |
| option_name: Marketing | |
| children: [] | |
| is_active: true | |
| is_default: false | |
| depth: 0 | |
| option_order: 2 | |
| parent_id: '' | |
| parent_name: '' | |
| criteria: | |
| - options: | |
| - '460000000038038' | |
| - untagged | |
| tag_id: '' | |
| type: location | |
| locations: | |
| - location_name: Head Office | |
| depth: 0 | |
| location_id: '460000000039786' | |
| - location_name: Central Warehouse | |
| depth: 1 | |
| location_id: '460000000039788' | |
| - location_name: East Hill | |
| depth: 2 | |
| location_id: '460000000039790' | |
| editpage-segmentation-response: | |
| type: object | |
| properties: | |
| is_class: | |
| $ref: '#/components/schemas/is_class' | |
| is_draft: | |
| $ref: '#/components/schemas/is_draft' | |
| tag_id: | |
| $ref: '#/components/schemas/tag_id' | |
| tag_name: | |
| $ref: '#/components/schemas/tag_name' | |
| effective_date: | |
| description: Date which the exchange rate is applicable for the currency. | |
| type: string | |
| example: '2013-09-04' | |
| email: | |
| description: Email address of the contact person. Max-length [100] | |
| type: string | |
| example: willsmith@bowmanfurniture.com | |
| email-a-credit-note-request: | |
| required: | |
| - to_mail_ids | |
| - subject | |
| - body | |
| type: object | |
| properties: | |
| to_mail_ids: | |
| $ref: '#/components/schemas/to_mail_ids' | |
| cc_mail_ids: | |
| $ref: '#/components/schemas/cc_mail_ids' | |
| subject: | |
| $ref: '#/components/schemas/subject' | |
| body: | |
| $ref: '#/components/schemas/body' | |
| email-a-credit-note-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Your creditnote has been sent. | |
| readOnly: true | |
| email-a-purchase-order-request: | |
| required: | |
| - to_mail_ids | |
| - body | |
| type: object | |
| properties: | |
| send_from_org_email_id: | |
| $ref: '#/components/schemas/send_from_org_email_id' | |
| from_address_id: | |
| $ref: '#/components/schemas/from_address_id' | |
| to_mail_ids: | |
| $ref: '#/components/schemas/to_mail_ids' | |
| cc_mail_ids: | |
| $ref: '#/components/schemas/cc_mail_ids' | |
| bcc_mail_ids: | |
| $ref: '#/components/schemas/bcc_mail_ids' | |
| subject: | |
| $ref: '#/components/schemas/subject' | |
| body: | |
| $ref: '#/components/schemas/body' | |
| mail_documents: | |
| $ref: '#/components/schemas/mail_documents' | |
| email-a-purchase-order-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Your purchase order has been sent. | |
| readOnly: true | |
| email-a-retainer-invoice-request: | |
| required: | |
| - to_mail_ids | |
| type: object | |
| properties: | |
| send_from_org_email_id: | |
| $ref: '#/components/schemas/send_from_org_email_id' | |
| to_mail_ids: | |
| $ref: '#/components/schemas/to_mail_ids' | |
| cc_mail_ids: | |
| $ref: '#/components/schemas/cc_mail_ids' | |
| subject: | |
| $ref: '#/components/schemas/subject' | |
| body: | |
| $ref: '#/components/schemas/body' | |
| email-a-retainer-invoice-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Your retainer invoice has been sent. | |
| readOnly: true | |
| email-a-sales-order-request: | |
| required: | |
| - to_mail_ids | |
| - subject | |
| - body | |
| type: object | |
| properties: | |
| from_address_id: | |
| $ref: '#/components/schemas/from_address_id' | |
| send_from_org_email_id: | |
| $ref: '#/components/schemas/send_from_org_email_id' | |
| to_mail_ids: | |
| $ref: '#/components/schemas/to_mail_ids' | |
| cc_mail_ids: | |
| $ref: '#/components/schemas/cc_mail_ids' | |
| bcc_mail_ids: | |
| $ref: '#/components/schemas/bcc_mail_ids' | |
| subject: | |
| $ref: '#/components/schemas/subject' | |
| documents: | |
| description: Documents of the Sales Order | |
| type: string | |
| format: binary | |
| invoice_id: | |
| $ref: '#/components/schemas/invoice_id' | |
| body: | |
| $ref: '#/components/schemas/body' | |
| email-a-sales-order-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Your Sales Order has been sent. | |
| readOnly: true | |
| email-a-sales-receipt-request: | |
| required: | |
| - to_mail_ids | |
| - subject | |
| - body | |
| type: object | |
| properties: | |
| to_mail_ids: | |
| description: Array of email addresses of the recipients | |
| type: array | |
| items: | |
| type: string | |
| example: | |
| - john@safinstruments.com | |
| subject: | |
| description: Subject of the mail | |
| type: string | |
| example: Sales Receipt from Zillium Inc | |
| body: | |
| description: Body of the mail | |
| type: string | |
| example: Please find the sales receipt attached. | |
| email-a-sales-receipt-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Your Sales Receipt has been sent. | |
| readOnly: true | |
| email-a-vendor-payment-request: | |
| required: | |
| - to_mail_ids | |
| - subject | |
| - body | |
| type: object | |
| properties: | |
| send_from_org_email_id: | |
| description: Boolean to trigger the email from the organization's email | |
| address | |
| type: boolean | |
| example: false | |
| from_address_id: | |
| description: From email address id | |
| type: string | |
| example: '2000000011993' | |
| to_mail_ids: | |
| description: Array of email address of the recipients. | |
| type: array | |
| items: | |
| type: string | |
| example: | |
| - vendor@example.com | |
| cc_mail_ids: | |
| description: Array of email address of the recipients to be CC'd. | |
| type: array | |
| items: | |
| type: string | |
| example: | |
| - manager@example.com | |
| subject: | |
| description: Subject of the email | |
| type: string | |
| example: 'Vendor Payment Receipt from Your Company (Payment#: VP-00001)' | |
| body: | |
| description: Body of the email | |
| type: string | |
| example: 'Dear Vendor,<br><br>Thank you for your services.<br><br>Please | |
| find attached the payment receipt for Payment#: VP-00001.<br><br>Payment | |
| Details:<br>Payment Number: VP-00001<br>Date: 2024-01-15<br>Amount: $1,500.00<br><br>Best | |
| regards,<br>Your Company' | |
| email_template_id: | |
| description: Get the email content based on a specific email template. If | |
| this param is not inputted, then the content will be based on the email | |
| template associated with the vendor. If no template is associated with | |
| the vendor, then default template will be used. | |
| type: string | |
| email-a-vendor-payment-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Your vendor payment receipt has been sent. | |
| readOnly: true | |
| email-an-estimate-request: | |
| required: | |
| - to_mail_ids | |
| type: object | |
| properties: | |
| send_from_org_email_id: | |
| $ref: '#/components/schemas/send_from_org_email_id' | |
| to_mail_ids: | |
| $ref: '#/components/schemas/to_mail_ids' | |
| cc_mail_ids: | |
| $ref: '#/components/schemas/cc_mail_ids' | |
| subject: | |
| $ref: '#/components/schemas/subject' | |
| body: | |
| $ref: '#/components/schemas/body' | |
| mail_documents: | |
| $ref: '#/components/schemas/mail_documents' | |
| email-an-estimate-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Your estimate has been sent. | |
| readOnly: true | |
| email-an-invoice-request: | |
| required: | |
| - to_mail_ids | |
| type: object | |
| properties: | |
| send_from_org_email_id: | |
| $ref: '#/components/schemas/send_from_org_email_id' | |
| from_address_id: | |
| $ref: '#/components/schemas/from_address_id' | |
| to_mail_ids: | |
| $ref: '#/components/schemas/to_mail_ids' | |
| cc_mail_ids: | |
| $ref: '#/components/schemas/cc_mail_ids' | |
| subject: | |
| $ref: '#/components/schemas/subject' | |
| body: | |
| $ref: '#/components/schemas/body' | |
| email-an-invoice-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Your invoice has been sent. | |
| readOnly: true | |
| email-contact-request: | |
| required: | |
| - to_mail_ids | |
| - subject | |
| - body | |
| type: object | |
| properties: | |
| to_mail_ids: | |
| $ref: '#/components/schemas/to_mail_ids' | |
| subject: | |
| description: Subject of an email has to be sent. Max-length [1000] | |
| type: string | |
| example: Welcome to Zillium Inc . | |
| body: | |
| $ref: '#/components/schemas/body' | |
| attachments: | |
| $ref: '#/components/schemas/attachments' | |
| email-contact-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Email has been sent. | |
| readOnly: true | |
| email-history-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| email_history: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| mailhistory_id: | |
| $ref: '#/components/schemas/mailhistory_id' | |
| from: | |
| $ref: '#/components/schemas/from' | |
| to_mail_ids: | |
| $ref: '#/components/schemas/to_mail_ids' | |
| subject: | |
| $ref: '#/components/schemas/subject' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| email-invoices-request: | |
| required: | |
| - contact_id | |
| - snail_mail | |
| type: object | |
| properties: | |
| contacts: | |
| $ref: '#/components/schemas/contacts' | |
| email-invoices-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Your mails are scheduled to be sent in a few minutes. We will notify | |
| you once it is done. | |
| readOnly: true | |
| email-multiple-estimates-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Mission accomplished! We've sent all the estimates. | |
| readOnly: true | |
| email-statement-request: | |
| required: | |
| - to_mail_ids | |
| - subject | |
| - body | |
| type: object | |
| properties: | |
| send_from_org_email_id: | |
| $ref: '#/components/schemas/send_from_org_email_id' | |
| to_mail_ids: | |
| $ref: '#/components/schemas/to_mail_ids' | |
| cc_mail_ids: | |
| $ref: '#/components/schemas/cc_mail_ids' | |
| subject: | |
| $ref: '#/components/schemas/subject' | |
| body: | |
| $ref: '#/components/schemas/body' | |
| email-statement-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Statement has been sent to the Customer. | |
| readOnly: true | |
| email_ids: | |
| type: array | |
| items: | |
| type: string | |
| email_template_id: | |
| description: Get the email content based on a specific email template. If this | |
| param is not inputted, then the content will be based on the email template | |
| associated with the customer. If no template is associated with the customer, | |
| then default template will be used. | |
| type: string | |
| example: ' ' | |
| emailtemplate_documents: | |
| type: array | |
| items: | |
| type: string | |
| emailtemplates: | |
| description: The email template information | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| selected: | |
| $ref: '#/components/schemas/selected' | |
| name: | |
| $ref: '#/components/schemas/name' | |
| email_template_id: | |
| $ref: '#/components/schemas/email_template_id' | |
| employee_id: | |
| description: ID of the Employee | |
| type: integer | |
| format: int64 | |
| enable-location-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: We're enabling locations for your organization. | |
| readOnly: true | |
| enable-payment-reminder-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Reminders enabled. | |
| readOnly: true | |
| enable-payment-reminders-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: All reminders associated with this contact have been enabled. | |
| readOnly: true | |
| enable-portal-access-request: | |
| required: | |
| - contact_persons | |
| type: object | |
| properties: | |
| contact_persons: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| contact_person_id: | |
| $ref: '#/components/schemas/contact_person_id' | |
| enable-portal-access-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: Client Portal preferences have been updated | |
| readOnly: true | |
| enable_portal: | |
| description: option to enable the portal access. allowed values <code>true</code>,<code>false</code> | |
| type: boolean | |
| example: true | |
| end_date: | |
| description: Greatest date in the transaction set | |
| type: string | |
| example: '2019-01-02' | |
| end_reading: | |
| description: End Reading of the Odometer | |
| type: string | |
| end_time: | |
| type: string | |
| example: 04:00 | |
| engine_capacity_range: | |
| description: 'Type of Fuel Used. Allowed Values : <code>less_than_1400cc</code>, | |
| <code>between_1401cc_and_1600cc</code>, <code>between_1601cc_and_2000cc</code> | |
| and <code>more_than_2000cc</code>' | |
| type: string | |
| x-node_available_in: | |
| - uk | |
| - eu | |
| x-node_unavailable_in: [] | |
| entities: | |
| description: Entities that can only be enabled or disabled which can also be | |
| called as mono-preference entities. <br><i>Note:</i>If you have Payroll joined | |
| then <code>journal</code> will be sent in this list instead of <code>multiple_preference_entities</code> | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| entity_name: | |
| description: 'Entity Name<br>Possible Values: <br>Customer - <code>customers</code>, <br>Vendor | |
| - <code>vendors</code>, <br>Item - <code>items</code>, <br>Banking | |
| - <code>banking</code> <br>Fixed Asset - <code>fixed_asset</code>' | |
| type: string | |
| enum: | |
| - customers | |
| - vendors | |
| - items | |
| - banking | |
| is_enabled: | |
| description: Is Enabled | |
| type: boolean | |
| example: true | |
| example: | |
| - entity_name: customers | |
| is_enabled: true | |
| - entity_name: vendors | |
| is_enabled: true | |
| - entity_name: items | |
| is_enabled: true | |
| - entity_name: fixed_asset | |
| is_enabled: true | |
| - entity_name: banking | |
| is_enabled: true | |
| entity_id: | |
| type: string | |
| example: '2000000007037' | |
| entity_level: | |
| example: null | |
| entity_number: | |
| type: integer | |
| entity_type: | |
| description: Name of the Entity | |
| type: string | |
| example: journal | |
| entry_number: | |
| type: string | |
| example: INV-00004 | |
| error_list: | |
| description: Error list | |
| type: array | |
| items: | |
| type: string | |
| example: [] | |
| estimate-response: | |
| type: object | |
| properties: | |
| estimate_id: | |
| $ref: '#/components/schemas/estimate_id' | |
| estimate_number: | |
| $ref: '#/components/schemas/estimate_number' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| is_pre_gst: | |
| $ref: '#/components/schemas/is_pre_gst' | |
| place_of_supply: | |
| $ref: '#/components/schemas/place_of_supply' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| gst_treatment: | |
| $ref: '#/components/schemas/gst_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| is_reverse_charge_applied: | |
| $ref: '#/components/schemas/is_reverse_charge_applied' | |
| status: | |
| $ref: '#/components/schemas/status' | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| customer_name: | |
| $ref: '#/components/schemas/customer_name' | |
| contact_persons_associated: | |
| $ref: '#/components/schemas/contact_persons_associated' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| currency_code: | |
| $ref: '#/components/schemas/currency_code' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| expiry_date: | |
| $ref: '#/components/schemas/expiry_date' | |
| discount: | |
| $ref: '#/components/schemas/discount' | |
| is_discount_before_tax: | |
| $ref: '#/components/schemas/is_discount_before_tax' | |
| discount_type: | |
| $ref: '#/components/schemas/discount_type' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| line_items: | |
| $ref: '#/components/schemas/line_items' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| location_name: | |
| $ref: '#/components/schemas/location_name' | |
| shipping_charge: | |
| $ref: '#/components/schemas/shipping_charge' | |
| adjustment: | |
| $ref: '#/components/schemas/adjustment' | |
| adjustment_description: | |
| $ref: '#/components/schemas/adjustment_description' | |
| sub_total: | |
| $ref: '#/components/schemas/sub_total' | |
| total: | |
| $ref: '#/components/schemas/total' | |
| tax_total: | |
| $ref: '#/components/schemas/tax_total' | |
| price_precision: | |
| $ref: '#/components/schemas/price_precision' | |
| taxes: | |
| $ref: '#/components/schemas/taxes' | |
| billing_address: | |
| $ref: '#/components/schemas/billing_address' | |
| shipping_address: | |
| $ref: '#/components/schemas/shipping_address' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| terms: | |
| $ref: '#/components/schemas/terms' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| template_id: | |
| $ref: '#/components/schemas/template_id' | |
| template_name: | |
| $ref: '#/components/schemas/template_name' | |
| created_time: | |
| $ref: '#/components/schemas/created_time' | |
| last_modified_time: | |
| $ref: '#/components/schemas/last_modified_time' | |
| salesperson_id: | |
| $ref: '#/components/schemas/salesperson_id' | |
| salesperson_name: | |
| $ref: '#/components/schemas/salesperson_name' | |
| project: | |
| $ref: '#/components/schemas/project' | |
| tags: | |
| $ref: '#/components/schemas/tags_response' | |
| estimate_email_template_id: | |
| description: Default estimate email template id used for this customer while | |
| sending estimates. | |
| type: string | |
| example: 460000000052073 | |
| estimate_email_template_name: | |
| type: string | |
| example: Custom Estimate Notification | |
| estimate_id: | |
| description: The unique id of a particular estimate | |
| type: string | |
| example: 982000000567011 | |
| estimate_ids: | |
| description: Comma separated estimate ids which are to be emailed. | |
| type: string | |
| estimate_number: | |
| description: Search estimates by estimate number.Variants<code>estimate_number_startswith</code> | |
| and <code>estimate_number_contains</code> | |
| type: string | |
| example: EST-00002 | |
| estimate_template_id: | |
| description: Default estimate template id used for this customer while creating | |
| estimate. | |
| type: string | |
| example: 460000000000179 | |
| estimate_template_name: | |
| type: string | |
| example: Service - Professional | |
| estimates: | |
| description: The list of all estimates | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| estimate_id: | |
| $ref: '#/components/schemas/estimate_id' | |
| customer_name: | |
| $ref: '#/components/schemas/customer_name' | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| status: | |
| $ref: '#/components/schemas/status' | |
| estimate_number: | |
| $ref: '#/components/schemas/estimate_number' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| currency_code: | |
| $ref: '#/components/schemas/currency_code' | |
| total: | |
| $ref: '#/components/schemas/total' | |
| created_time: | |
| $ref: '#/components/schemas/created_time' | |
| accepted_date: | |
| $ref: '#/components/schemas/accepted_date' | |
| declined_date: | |
| $ref: '#/components/schemas/declined_date' | |
| expiry_date: | |
| $ref: '#/components/schemas/expiry_date' | |
| project_id: | |
| $ref: '#/components/schemas/project_id' | |
| project_name: | |
| $ref: '#/components/schemas/project_name' | |
| exchange_rate: | |
| description: The foreign currency exchange rate value. | |
| type: integer | |
| example: 1 | |
| exchange_rate_id: | |
| description: ID of the exchange rate | |
| type: string | |
| example: '460000000038035' | |
| exclude-a-transaction-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: The transaction has been excluded. | |
| readOnly: true | |
| expected_delivery_date: | |
| description: The expected delivery date when the goods or services ordered in | |
| this purchase order should be received. This date is used for planning, scheduling, | |
| and tracking deliveries. It helps in managing inventory, coordinating with | |
| vendors, and ensuring timely receipt of ordered items. The date should be | |
| in YYYY-MM-DD format. | |
| type: string | |
| expense-response: | |
| type: object | |
| properties: | |
| expense_id: | |
| $ref: '#/components/schemas/expense_id' | |
| transaction_id: | |
| $ref: '#/components/schemas/transaction_id' | |
| transaction_type: | |
| $ref: '#/components/schemas/transaction_type' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| gst_treatment: | |
| $ref: '#/components/schemas/gst_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| destination_of_supply: | |
| $ref: '#/components/schemas/destination_of_supply' | |
| destination_of_supply_state: | |
| $ref: '#/components/schemas/destination_of_supply_state' | |
| place_of_supply: | |
| $ref: '#/components/schemas/place_of_supply' | |
| hsn_or_sac: | |
| $ref: '#/components/schemas/hsn_or_sac' | |
| source_of_supply: | |
| $ref: '#/components/schemas/source_of_supply' | |
| paid_through_account_name: | |
| $ref: '#/components/schemas/paid_through_account_name' | |
| vat_reg_no: | |
| $ref: '#/components/schemas/vat_reg_no' | |
| reverse_charge_tax_id: | |
| $ref: '#/components/schemas/reverse_charge_tax_id' | |
| reverse_charge_tax_name: | |
| $ref: '#/components/schemas/reverse_charge_tax_name' | |
| reverse_charge_tax_percentage: | |
| $ref: '#/components/schemas/reverse_charge_tax_percentage' | |
| reverse_charge_tax_amount: | |
| $ref: '#/components/schemas/reverse_charge_tax_amount' | |
| tax_amount: | |
| $ref: '#/components/schemas/tax_amount' | |
| is_itemized_expense: | |
| $ref: '#/components/schemas/is_itemized_expense' | |
| is_pre_gst: | |
| $ref: '#/components/schemas/is_pre_gst' | |
| trip_id: | |
| $ref: '#/components/schemas/trip_id' | |
| trip_number: | |
| $ref: '#/components/schemas/trip_number' | |
| reverse_charge_vat_total: | |
| $ref: '#/components/schemas/reverse_charge_vat_total' | |
| acquisition_vat_total: | |
| $ref: '#/components/schemas/acquisition_vat_total' | |
| acquisition_vat_summary: | |
| $ref: '#/components/schemas/acquisition_vat_summary' | |
| reverse_charge_vat_summary: | |
| $ref: '#/components/schemas/reverse_charge_vat_summary' | |
| taxes: | |
| $ref: '#/components/schemas/taxes' | |
| expense_item_id: | |
| $ref: '#/components/schemas/expense_item_id' | |
| account_id: | |
| $ref: '#/components/schemas/account_id' | |
| account_name: | |
| $ref: '#/components/schemas/account_name' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| tax_id: | |
| $ref: '#/components/schemas/tax_id' | |
| tax_name: | |
| $ref: '#/components/schemas/tax_name' | |
| tax_percentage: | |
| $ref: '#/components/schemas/tax_percentage' | |
| currency_id: | |
| $ref: '#/components/schemas/currency_id' | |
| currency_code: | |
| $ref: '#/components/schemas/currency_code' | |
| exchange_rate: | |
| $ref: '#/components/schemas/exchange_rate' | |
| sub_total: | |
| $ref: '#/components/schemas/sub_total' | |
| total: | |
| $ref: '#/components/schemas/total' | |
| bcy_total: | |
| $ref: '#/components/schemas/bcy_total' | |
| amount: | |
| $ref: '#/components/schemas/amount' | |
| is_inclusive_tax: | |
| $ref: '#/components/schemas/is_inclusive_tax' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| is_billable: | |
| $ref: '#/components/schemas/is_billable' | |
| is_personal: | |
| $ref: '#/components/schemas/is_personal' | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| customer_name: | |
| $ref: '#/components/schemas/customer_name' | |
| expense_receipt_name: | |
| $ref: '#/components/schemas/expense_receipt_name' | |
| expense_receipt_type: | |
| $ref: '#/components/schemas/expense_receipt_type' | |
| last_modified_time: | |
| $ref: '#/components/schemas/last_modified_time' | |
| status: | |
| $ref: '#/components/schemas/status' | |
| invoice_id: | |
| $ref: '#/components/schemas/invoice_id' | |
| invoice_number: | |
| $ref: '#/components/schemas/invoice_number' | |
| location_id: | |
| $ref: '#/components/schemas/location_id' | |
| location_name: | |
| $ref: '#/components/schemas/location_name' | |
| project_id: | |
| $ref: '#/components/schemas/project_id' | |
| project_name: | |
| $ref: '#/components/schemas/project_name' | |
| mileage_rate: | |
| $ref: '#/components/schemas/mileage_rate' | |
| mileage_type: | |
| $ref: '#/components/schemas/mileage_type' | |
| expense_type: | |
| $ref: '#/components/schemas/expense_type' | |
| start_reading: | |
| $ref: '#/components/schemas/start_reading' | |
| end_reading: | |
| $ref: '#/components/schemas/end_reading' | |
| tags: | |
| $ref: '#/components/schemas/tags_response' | |
| expense_account_id: | |
| description: Enter the account id to track the expenses associated with the | |
| asset's depreciation.The available account types are <b>Expense</b> and <b>Other | |
| Expense</b> | |
| type: string | |
| example: '3640355000000000421' | |
| expense_account_name: | |
| description: Name of the expense account | |
| type: string | |
| example: Telephone Expense | |
| expense_id: | |
| type: string | |
| example: 982000000030049 | |
| expense_item_id: | |
| type: string | |
| example: 982000000567220 | |
| expense_receipt_name: | |
| type: string | |
| example: ' ' | |
| expense_receipt_type: | |
| type: string | |
| example: ' ' | |
| expense_type: | |
| description: Type of Expense | |
| type: string | |
| example: non_mileage | |
| expiry_date: | |
| description: The date of expiration of the estimates | |
| type: string | |
| example: '2013-11-30' | |
| expiry_month: | |
| description: Expiry month of the card. | |
| type: integer | |
| example: 9 | |
| expiry_year: | |
| description: Expiry year of the card. | |
| type: integer | |
| example: 2030 | |
| facebook: | |
| description: Facebook profile URL for the contact. Max-length [100]. | |
| type: string | |
| example: zoho | |
| fax: | |
| description: Fax Number of the Contact | |
| type: string | |
| fcy_balance: | |
| description: Balance in Foreign Currency | |
| type: number | |
| format: double | |
| example: 139.41 | |
| feeds_last_refresh_date: | |
| description: Last Refreshed Date of the Feeds | |
| type: string | |
| fetchTaxInfo: | |
| description: Check if tax information should be fetched | |
| type: boolean | |
| example: false | |
| fetchstatementlineinfo: | |
| description: Check is Statement Line Information for Vendor Payment be fetched | |
| type: boolean | |
| example: true | |
| field: | |
| description: Field involved in the Criteria | |
| type: string | |
| example: amount | |
| field_id: | |
| description: Field ID | |
| type: string | |
| example: 1 | |
| field_separator: | |
| description: Separator used to classify fields | |
| type: string | |
| example: ' ' | |
| file_name: | |
| description: Name of the attached file. | |
| file_name_without_extension: | |
| type: string | |
| example: INV-000004 | |
| file_size: | |
| type: string | |
| example: '5447' | |
| file_size_formatted: | |
| type: string | |
| example: 5.3 KB | |
| file_type: | |
| description: Type of the attached file. | |
| type: string | |
| example: pdf | |
| filed_in_vat_return_id: | |
| description: ID of the VAT Return the Vendor Credit is filed in | |
| type: string | |
| x-node_available_in: | |
| - uk | |
| x-node_unavailable_in: [] | |
| filed_in_vat_return_name: | |
| description: Name of the VAT Return the Vendor Credit is filed in | |
| type: string | |
| x-node_available_in: | |
| - uk | |
| x-node_unavailable_in: [] | |
| filed_in_vat_return_type: | |
| description: Type of the VAT Return the Vendor Credit is filed in | |
| type: string | |
| x-node_available_in: | |
| - uk | |
| x-node_unavailable_in: [] | |
| filter_by: | |
| description: 'Filter the account by their status. Allowed Values: <code>Status.All</code>, | |
| <code>Status.Active</code> and <code>Status.Inactive</code>.' | |
| type: string | |
| example: Status.All | |
| filter_option_id: | |
| description: 'Option ID for the filter. It can be an option ID or flags. <br>Allowed | |
| flags: <code>all</code> - Instead of selecting all options, you can send this | |
| flag to denote all options of the filter tag or location are selected for | |
| the filter to the respective tag. <code>untagged</code> - When you want to | |
| show an option when no option is selected for the filter tag. <b>Note: This | |
| flag cannot be used for location filter.</b>' | |
| type: string | |
| example: '460000000038081' | |
| filter_option_name: | |
| description: 'Option Name for the filter. It can be an option name or flags. <br>Allowed | |
| flags: <code>All</code> - Instead of selecting all options, you can send this | |
| flag to denote all options of the filter tag or location are selected for | |
| the filter to the respective tag. <code>Untagged</code> - When you want to | |
| show an option when no option is selected for the filter tag. <b>Note: This | |
| flag cannot be used for location filter.</b>' | |
| type: string | |
| example: Sales | |
| filter_tag_id: | |
| type: string | |
| description: Filter tag ID. If the filter 'type' is location, <code>null</code> | |
| should be passed | |
| example: '460000000038081' | |
| filter_type: | |
| description: 'Type of filter entity. <br>Allowed values: Tag <code>tag</code> | |
| and Location <code>location</code>. <br>' | |
| type: string | |
| example: tag | |
| first_name: | |
| description: First name of the contact person. Max-length [100] | |
| type: string | |
| example: Will | |
| fiscal_year_start_month: | |
| description: Starting month of teh financial year | |
| type: number | |
| format: double | |
| example: 0 | |
| fixed_asset: | |
| type: object | |
| properties: | |
| fixed_asset_id: | |
| $ref: '#/components/schemas/fixed_asset_id' | |
| asset_name: | |
| $ref: '#/components/schemas/asset_name' | |
| status: | |
| $ref: '#/components/schemas/status' | |
| asset_number: | |
| $ref: '#/components/schemas/asset_number' | |
| asset_number_prefix: | |
| $ref: '#/components/schemas/asset_number_prefix' | |
| asset_number_suffix: | |
| $ref: '#/components/schemas/asset_number_suffix' | |
| description: | |
| $ref: '#/components/schemas/description' | |
| total_life: | |
| $ref: '#/components/schemas/total_life' | |
| fixed_asset_type_id: | |
| $ref: '#/components/schemas/fixed_asset_type_id' | |
| fixed_asset_type_name: | |
| $ref: '#/components/schemas/fixed_asset_type_name' | |
| depreciation_method: | |
| $ref: '#/components/schemas/depreciation_method' | |
| depreciation_percentage: | |
| $ref: '#/components/schemas/depreciation_percentage' | |
| depreciation_frequency: | |
| $ref: '#/components/schemas/depreciation_frequency' | |
| asset_cost: | |
| $ref: '#/components/schemas/asset_cost' | |
| dep_start_value: | |
| $ref: '#/components/schemas/dep_start_value' | |
| salvage_value: | |
| $ref: '#/components/schemas/salvage_value' | |
| asset_purchase_date: | |
| $ref: '#/components/schemas/asset_purchase_date' | |
| current_asset_value: | |
| $ref: '#/components/schemas/current_asset_value' | |
| accumulated_dep_value: | |
| $ref: '#/components/schemas/accumulated_dep_value' | |
| serial_no: | |
| $ref: '#/components/schemas/serial_no' | |
| depreciation_start_date: | |
| $ref: '#/components/schemas/depreciation_start_date' | |
| last_depreciation_date: | |
| $ref: '#/components/schemas/last_depreciation_date' | |
| asset_account_id: | |
| $ref: '#/components/schemas/asset_account_id' | |
| asset_account_name: | |
| $ref: '#/components/schemas/asset_account_name' | |
| expense_account_id: | |
| $ref: '#/components/schemas/expense_account_id' | |
| expense_account_name: | |
| $ref: '#/components/schemas/expense_account_name' | |
| depreciation_account_id: | |
| $ref: '#/components/schemas/depreciation_account_id' | |
| depreciation_account_name: | |
| $ref: '#/components/schemas/depreciation_account_name' | |
| computation_type: | |
| $ref: '#/components/schemas/computation_type' | |
| warranty_expiry_date: | |
| $ref: '#/components/schemas/warranty_expiry_date' | |
| notes: | |
| $ref: '#/components/schemas/notes' | |
| tags: | |
| $ref: '#/components/schemas/tags_response' | |
| associated_transactions: | |
| $ref: '#/components/schemas/associated_transactions' | |
| comments: | |
| $ref: '#/components/schemas/comments' | |
| custom_fields: | |
| $ref: '#/components/schemas/custom_fields' | |
| fixed_asset_id: | |
| description: ID of the fixed asset | |
| type: string | |
| example: '3640355000000319008' | |
| fixed_asset_type: | |
| type: object | |
| properties: | |
| fixed_asset_type_id: | |
| $ref: '#/components/schemas/fixed_asset_type_id' | |
| fixed_asset_type_name: | |
| $ref: '#/components/schemas/fixed_asset_type_name' | |
| expense_account_id: | |
| $ref: '#/components/schemas/expense_account_id' | |
| expense_account_name: | |
| $ref: '#/components/schemas/expense_account_name' | |
| depreciation_account_id: | |
| $ref: '#/components/schemas/depreciation_account_id' | |
| depreciation_account_name: | |
| $ref: '#/components/schemas/depreciation_account_name' | |
| depreciation_method: | |
| $ref: '#/components/schemas/depreciation_method' | |
| depreciation_percentage: | |
| $ref: '#/components/schemas/depreciation_percentage' | |
| total_life: | |
| $ref: '#/components/schemas/total_life' | |
| depreciation_frequency: | |
| $ref: '#/components/schemas/depreciation_frequency' | |
| computation_type: | |
| $ref: '#/components/schemas/computation_type' | |
| fixed_asset_type_id: | |
| description: Associate the fixed asset with a fixed asset type by specifying | |
| fixed asset type id. | |
| type: string | |
| example: '3640355000000319008' | |
| fixed_asset_type_name: | |
| description: Enter the name of fixed asset type | |
| type: string | |
| example: Machines | |
| fixed_asset_type_param: | |
| type: object | |
| properties: | |
| fixed_asset_type_name: | |
| $ref: '#/components/schemas/fixed_asset_type_name' | |
| expense_account_id: | |
| $ref: '#/components/schemas/expense_account_id' | |
| depreciation_account_id: | |
| $ref: '#/components/schemas/depreciation_account_id' | |
| depreciation_method: | |
| $ref: '#/components/schemas/depreciation_method' | |
| depreciation_frequency: | |
| $ref: '#/components/schemas/depreciation_frequency' | |
| depreciation_percentage: | |
| $ref: '#/components/schemas/depreciation_percentage' | |
| total_life: | |
| $ref: '#/components/schemas/total_life' | |
| salvage_value: | |
| $ref: '#/components/schemas/salvage_value' | |
| computation_type: | |
| $ref: '#/components/schemas/computation_type' | |
| from: | |
| description: The email ID from which the credit note is to be mailed. | |
| type: string | |
| example: gator@zillum.com | |
| from_account_id: | |
| description: 'The account ID from which money will be transferred(Mandatory | |
| for specific type of transactions). These accounts differ with respect to | |
| transaction_type. Ex: To a bank account, from-account can be: bank , card, | |
| income, refund. To a card account, from account can be: bank, card, refund.' | |
| type: string | |
| example: '460000000070003' | |
| from_account_name: | |
| description: The account Name from which money will be transferred | |
| type: string | |
| example: Sales | |
| from_address: | |
| type: string | |
| example: '' | |
| from_address_id: | |
| description: From email address id | |
| type: string | |
| example: 2000000011993 | |
| from_date: | |
| description: From Date of the Last Import | |
| type: string | |
| example: '2012-01-12' | |
| from_email: | |
| type: string | |
| example: '' | |
| from_emails: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| user_name: | |
| $ref: '#/components/schemas/user_name' | |
| selected: | |
| $ref: '#/components/schemas/selected' | |
| email: | |
| $ref: '#/components/schemas/email' | |
| from_mail_id_alias: | |
| description: The email ID from which the credit note is to be mailed. | |
| type: string | |
| example: true | |
| fuel_type: | |
| description: 'Type of Fuel Used. Allowed Values : <code>petrol</code>, <code>lpg</code>, | |
| <code>diesel</code>' | |
| type: string | |
| x-node_available_in: | |
| - uk | |
| - eu | |
| x-node_unavailable_in: [] | |
| gain_or_loss: | |
| description: Amount in Total Gain/Loss | |
| type: number | |
| format: double | |
| example: 37.65 | |
| gateway_error_message: | |
| description: Gateway error message for a failed transaction. | |
| type: string | |
| example: Gateway error message for a failed transaction. | |
| gateway_name: | |
| description: 'Name of the payment gateway associated with the invoice. E.g. | |
| paypal, stripe.Allowed Values: <code>paypal</code>, <code>authorize_net</code>, | |
| <code>payflow_pro</code>, <code>stripe</code>, <code>2checkout</code> and | |
| <code>braintree</code>' | |
| type: string | |
| example: paypal | |
| gateway_transaction_id: | |
| description: Transaction ID provided by the gateway for the transaction. | |
| type: string | |
| example: B10E6E0F31BD | |
| gateways_associated: | |
| type: boolean | |
| example: true | |
| gateways_configured: | |
| type: boolean | |
| example: true | |
| gendoc-attributes-schema: | |
| $ref: '#/components/schemas/bankaccount' | |
| get-a-base-currency-adjustment-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| data: | |
| $ref: '#/components/schemas/data' | |
| get-a-bill-attachment-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| get-a-bill-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| bill: | |
| $ref: '#/components/schemas/bill' | |
| get-a-contact-person-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| contact_person: | |
| type: object | |
| properties: | |
| contact_id: | |
| $ref: '#/components/schemas/contact_id' | |
| contact_person_id: | |
| $ref: '#/components/schemas/contact_person_id' | |
| salutation: | |
| $ref: '#/components/schemas/salutation' | |
| first_name: | |
| $ref: '#/components/schemas/first_name' | |
| last_name: | |
| $ref: '#/components/schemas/last_name' | |
| email: | |
| $ref: '#/components/schemas/email' | |
| phone: | |
| $ref: '#/components/schemas/phone' | |
| mobile: | |
| $ref: '#/components/schemas/mobile' | |
| is_primary_contact: | |
| $ref: '#/components/schemas/is_primary_contact' | |
| skype: | |
| $ref: '#/components/schemas/skype' | |
| designation: | |
| $ref: '#/components/schemas/designation' | |
| department: | |
| $ref: '#/components/schemas/department' | |
| is_added_in_portal: | |
| $ref: '#/components/schemas/is_added_in_portal' | |
| communication_preference: | |
| $ref: '#/components/schemas/communication_preference' | |
| get-a-credit-note-response: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| example: 0 | |
| readOnly: true | |
| message: | |
| type: string | |
| example: success | |
| readOnly: true | |
| creditnote: | |
| type: object | |
| properties: | |
| creditnote_id: | |
| $ref: '#/components/schemas/creditnote_id' | |
| creditnote_number: | |
| $ref: '#/components/schemas/creditnote_number' | |
| date: | |
| $ref: '#/components/schemas/date' | |
| is_pre_gst: | |
| $ref: '#/components/schemas/is_pre_gst' | |
| place_of_supply: | |
| $ref: '#/components/schemas/place_of_supply' | |
| vat_treatment: | |
| $ref: '#/components/schemas/vat_treatment' | |
| vat_reg_no: | |
| $ref: '#/components/schemas/vat_reg_no' | |
| gst_no: | |
| $ref: '#/components/schemas/gst_no' | |
| cfdi_usage: | |
| $ref: '#/components/schemas/cfdi_usage' | |
| cfdi_reference_type: | |
| $ref: '#/components/schemas/cfdi_reference_type' | |
| gst_treatment: | |
| $ref: '#/components/schemas/gst_treatment' | |
| tax_treatment: | |
| $ref: '#/components/schemas/tax_treatment' | |
| is_reverse_charge_applied: | |
| $ref: '#/components/schemas/is_reverse_charge_applied' | |
| status: | |
| $ref: '#/components/schemas/status' | |
| customer_id: | |
| $ref: '#/components/schemas/customer_id' | |
| customer_name: | |
| $ref: '#/components/schemas/customer_name' | |
| contact_persons_associated: | |
| $ref: '#/components/schemas/contact_persons_associated' | |
| custom_fields: | |
| description: Additional fields for the Credit-Notes. | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| index: | |
| $ref: '#/components/schemas/index' | |
| value: | |
| $ref: '#/components/schemas/value' | |
| label: | |
| $ref: '#/components/schemas/label' | |
| data_type: | |
| $ref: '#/components/schemas/data_type' | |
| reference_number: | |
| $ref: '#/components/schemas/reference_number' | |
| email: | |
| $ref: '#/c |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment