Specifies the rounding precision for fractional numeric values (such as prices, taxes, and weights).
Supported values range from 1 to 6.
The default rounding precision may vary depending on the platform. You can retrieve the default value using the cart.info method in the default_rounding_precision field.
Values are rounded to the nearest number at the specified precision. Fractions of .5 or higher are rounded up, while fractions lower than .5 are rounded down.
","schema":{"type":"integer"},"example":3,"in":"query","required":false}]}},"/bill.add.json":{"post":{"tags":["bill"],"summary":"bill.add","description":"Use this method to create a new bill.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"BillAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillAdd"}}}}}},"/bill.update.json":{"put":{"tags":["bill"],"summary":"bill.update","description":"Use this method to update a bill.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"BillUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated":{"type":"boolean"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillUpdate"}}}}}},"/bill.credit_note.list.json":{"get":{"tags":["bill"],"summary":"bill.credit_note.list","description":"Use this method to retrieve one or more credit notes, as well as the total count of credit notes.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"BillCreditNoteList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Bill_CreditNote_List"}}}}},"parameters":[{"name":"ids","description":"Retrieves items specified by ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"organization_id","description":"Organization ID","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"contact_id","description":"Defines contact ID","schema":{"type":"string"},"example":"12345678","in":"query","required":false},{"name":"status","description":"Defines status","schema":{"type":"string"},"example":"active","in":"query","required":false},{"name":"issue_date_from","description":"Retrieve entities from their issue date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"issue_date_to","description":"Retrieve entities to their issue date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"due_date_from","description":"Retrieve entities from their due date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"due_date_to","description":"Retrieve entities to their due date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"find_value","description":"Search entities by a specific value. Allowed values may vary depending on the integration.","schema":{"type":"string"},"example":"test","in":"query","required":false},{"name":"find_where","description":"Search entities by comma-separated unique fields. Allowed values may vary depending on the integration.","schema":{"type":"string"},"example":"name","in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count = 250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"{return_code,return_message,pagination,result}"},"example":"{result}","in":"query","required":false},{"name":"rounding_precision","description":"Specifies the rounding precision for fractional numeric values (such as prices, taxes, and weights).
Supported values range from 1 to 6.
The default rounding precision may vary depending on the platform. You can retrieve the default value using the cart.info method in the default_rounding_precision field.
Values are rounded to the nearest number at the specified precision. Fractions of .5 or higher are rounded up, while fractions lower than .5 are rounded down.
","schema":{"type":"integer"},"example":3,"in":"query","required":false}]}},"/bill.credit_note.add.json":{"post":{"tags":["bill"],"summary":"bill.credit_note.add","description":"Use this method to create a new bill credit note.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"BillCreditNoteAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillCreditNoteAdd"}}}}}},"/bill.credit_note.update.json":{"put":{"tags":["bill"],"summary":"bill.credit_note.update","description":"Use this method to update a bill credit note.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"BillCreditNoteUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated":{"type":"boolean"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillCreditNoteUpdate"}}}}}},"/bill.credit_note.delete.json":{"delete":{"tags":["bill"],"summary":"bill.credit_note.delete","description":"Use this method to delete a bill credit note.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"BillCreditNoteDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"boolean"}}}}}}}}},"parameters":[{"name":"id","description":"Defines ID","schema":{"type":"string"},"example":true,"in":"query","required":true},{"name":"organization_id","description":"Organization ID","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/bill.payment.list.json":{"get":{"tags":["bill"],"summary":"bill.payment.list","description":"Use this method to retrieve bill payments, prepayments, or overpayments. For platforms that support multiple payment types, use thetype parameter to retrieve payments of a specific type. The response also includes the total count.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"BillPaymentList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Bill_Payment_List"}}}}},"parameters":[{"name":"type","description":"Defines the type of bill payments to retrieve","schema":{"type":"string","default":"payment"},"example":"payment","in":"query","required":false},{"name":"ids","description":"Retrieves items specified by ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"organization_id","description":"Organization ID","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"contact_id","description":"Defines contact ID","schema":{"type":"string"},"example":"12345678","in":"query","required":false},{"name":"status","description":"Filters bill payments by their status","schema":{"type":"string"},"example":"active","in":"query","required":false},{"name":"issue_date_from","description":"Retrieve entities from their issue date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"issue_date_to","description":"Retrieve entities to their issue date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"find_value","description":"Search entities by a specific value. Allowed values may vary depending on the integration.","schema":{"type":"string"},"example":"test","in":"query","required":false},{"name":"find_where","description":"Search entities by comma-separated unique fields. Allowed values may vary depending on the integration.","schema":{"type":"string"},"example":"name","in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count = 250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"{return_code,return_message,pagination,result}"},"example":"{result}","in":"query","required":false},{"name":"rounding_precision","description":"Specifies the rounding precision for fractional numeric values (such as prices, taxes, and weights).
Supported values range from 1 to 6.
The default rounding precision may vary depending on the platform. You can retrieve the default value using the cart.info method in the default_rounding_precision field.
Values are rounded to the nearest number at the specified precision. Fractions of .5 or higher are rounded up, while fractions lower than .5 are rounded down.
","schema":{"type":"integer"},"example":3,"in":"query","required":false}]}},"/bill.payment.add.json":{"post":{"tags":["bill"],"summary":"bill.payment.add","description":"Use this method to create a bill payment, prepayment, or overpayment. Use thetype parameter to define the payment type to create.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"BillPaymentAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillPaymentAdd"}}}}}},"/bill.payment.update.json":{"put":{"tags":["bill"],"summary":"bill.payment.update","description":"Use this method to update a bill payment, prepayment, or overpayment.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"BillPaymentUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated":{"type":"boolean"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillPaymentUpdate"}}}}}},"/bill.payment.delete.json":{"delete":{"tags":["bill"],"summary":"bill.payment.delete","description":"Use this method to delete a bill payment, prepayment, or overpayment.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"BillPaymentDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"boolean"}}}}}}}}},"parameters":[{"name":"id","description":"Defines ID","schema":{"type":"string"},"example":true,"in":"query","required":true},{"name":"organization_id","description":"Organization ID","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/connection.validate.json":{"get":{"tags":["connection"],"summary":"connection.validate","description":"This method clears the integration cache for a specific platform and verifies the current connection status. Use this method if there have been any changes to the external system's settings, such as the installation or removal of new plugins or modules.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"ConnectionValidate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"status":{"type":"string"}}}}}}}}},"parameters":[]}},"/connection.list.json":{"get":{"tags":["connection"],"summary":"connection.list","description":"This method allows you to retrieve a list of all external platforms integrated with your account.","security":[{"ApiKeyAuth":[]}],"operationId":"ConnectionList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Connection_List"}}}}},"parameters":[{"name":"ids","description":"Retrieves items specified by ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"integration_id","description":"Integration\u2019s identifier which you can get from connection.supported_integrations method","schema":{"type":"string"},"example":"Xero","in":"query","required":false},{"name":"custom_label","description":"Defines a custom label for the connected integration","schema":{"type":"string"},"example":"This is test store","in":"query","required":false},{"name":"connection_key","description":"Find connection by connection key","schema":{"type":"string"},"example":"ab37fc230bc5df63a5be1b11220949be","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count = 250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"{return_code,return_message,pagination,result}"},"example":"{return_code,return_message,pagination,result}","in":"query","required":false}]}},"/connection.supported_integrations.json":{"get":{"tags":["connection"],"summary":"connection.supported_integrations","description":"Use this method to retrieve a list of supported platforms integrations and the sets of parameters required for connecting to each of them. Note: some platforms may have multiple connection methods so that the response will contain multiple sets of parameters.","security":[{"ApiKeyAuth":[]}],"operationId":"ConnectionSupportedIntegrations","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"supported_integrations_count":{"type":"integer"},"supported_integrations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"versions":{"type":"string"},"method":{"type":"string"},"params":{"type":"object","properties":{"required":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}},"additional":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}}}}}}}}}}}}}}},"parameters":[]}},"/connection.add.json":{"post":{"tags":["connection"],"summary":"connection.add","description":"Use this method to automate the process of integrating external platforms with our API. The list of parameters will vary depending on the platform type. To get a list of parameters specific to a particular integration, you need to execute the connection.supported_integrations method.","security":[{"ApiKeyAuth":[]}],"operationId":"ConnectionAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"connection_key":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionAdd"}}}}}},"/connection.update.json":{"put":{"tags":["connection"],"summary":"connection.update","description":"Use this method to automate the update of credentials used for platform integrations. The list of supported parameters differs depending on the specific platform.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"ConnectionUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated":{"type":"boolean"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionUpdate"}}}}}},"/connection.delete.json":{"delete":{"tags":["connection"],"summary":"connection.delete","description":"Use this method to remove an existing platform integration from your account and stops all data synchronization for this specific connection.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"ConnectionDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"boolean"}}}}}}}}},"parameters":[]}},"/contact.list.json":{"get":{"tags":["contact"],"summary":"contact.list","description":"Use this method to retrieve one or more contacts, as well as the total count of contacts.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"ContactList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Contact_List"}}}}},"parameters":[{"name":"ids","description":"Retrieves items specified by ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"organization_id","description":"Organization ID","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"status","description":"Filters contacts by their status","schema":{"type":"string"},"example":"active","in":"query","required":false},{"name":"type","description":"Filters contacts by their type","schema":{"type":"string"},"example":"service","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"find_value","description":"Search entities by a specific value. Allowed values may vary depending on the integration.","schema":{"type":"string"},"example":"test","in":"query","required":false},{"name":"find_where","description":"Search entities by comma-separated unique fields. Allowed values may vary depending on the integration.","schema":{"type":"string"},"example":"name","in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count = 250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"{return_code,return_message,pagination,result}"},"example":"{result}","in":"query","required":false}]}},"/contact.add.json":{"post":{"tags":["contact"],"summary":"contact.add","description":"Use this method to create a new contact.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"ContactAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactAdd"}}}}}},"/contact.update.json":{"put":{"tags":["contact"],"summary":"contact.update","description":"Use this method to update a contact.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"ContactUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated":{"type":"boolean"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactUpdate"}}}}}},"/contact.delete.json":{"delete":{"tags":["contact"],"summary":"contact.delete","description":"Use this method to delete a contact.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"ContactDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"boolean"}}}}}}}}},"parameters":[{"name":"id","description":"Defines ID","schema":{"type":"string"},"example":true,"in":"query","required":true},{"name":"organization_id","description":"Organization ID","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"type","description":"Disambiguates the contact to delete when its id belongs to a customer and a supplier at the same time. Required only when the integration reports that ambiguity","schema":{"type":"string"},"example":"customer","in":"query","required":false}]}},"/invoice.list.json":{"get":{"tags":["invoice"],"summary":"invoice.list","description":"Use this method to retrieve one or more invoices, as well as the total count of invoices.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"InvoiceList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Invoice_List"}}}}},"parameters":[{"name":"ids","description":"Retrieves invoices specified by ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"organization_id","description":"Organization ID","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"contact_id","description":"Defines contact ID","schema":{"type":"string"},"example":"12345678","in":"query","required":false},{"name":"status","description":"Filters invoices by their status","schema":{"type":"string"},"example":"active","in":"query","required":false},{"name":"issue_date_from","description":"Retrieve entities from their issue date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"issue_date_to","description":"Retrieve entities to their issue date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"due_date_from","description":"Retrieve entities from their due date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"due_date_to","description":"Retrieve entities to their due date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"find_value","description":"Search entities by a specific value. Allowed values may vary depending on the integration.","schema":{"type":"string"},"example":"test","in":"query","required":false},{"name":"find_where","description":"Search entities by comma-separated unique fields. Allowed values may vary depending on the integration.","schema":{"type":"string"},"example":"name","in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count = 250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"{return_code,return_message,pagination,result}"},"example":"{result}","in":"query","required":false},{"name":"rounding_precision","description":"Specifies the rounding precision for fractional numeric values (such as prices, taxes, and weights).
Supported values range from 1 to 6.
The default rounding precision may vary depending on the platform. You can retrieve the default value using the cart.info method in the default_rounding_precision field.
Values are rounded to the nearest number at the specified precision. Fractions of .5 or higher are rounded up, while fractions lower than .5 are rounded down.
","schema":{"type":"integer"},"example":3,"in":"query","required":false}]}},"/invoice.add.json":{"post":{"tags":["invoice"],"summary":"invoice.add","description":"Use this method to create a new invoice.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"InvoiceAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceAdd"}}}}}},"/invoice.update.json":{"put":{"tags":["invoice"],"summary":"invoice.update","description":"Use this method to update an invoice.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"InvoiceUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated":{"type":"boolean"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceUpdate"}}}}}},"/invoice.delete.json":{"delete":{"tags":["invoice"],"summary":"invoice.delete","description":"Use this method to delete an invoice.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"InvoiceDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"boolean"}}}}}}}}},"parameters":[{"name":"id","description":"Defines ID","schema":{"type":"string"},"example":true,"in":"query","required":true},{"name":"organization_id","description":"Organization ID","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/item.list.json":{"get":{"tags":["item"],"summary":"item.list","description":"Use this method to retrieve one or multiple items, as well as the total count of items.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"ItemList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Item_List"}}}}},"parameters":[{"name":"ids","description":"Retrieves items specified by ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"organization_id","description":"Organization ID","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"type","description":"Filters items by their type","schema":{"type":"string"},"example":"service","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"find_value","description":"Search entities by a specific value. Allowed values may vary depending on the integration.","schema":{"type":"string"},"example":"test","in":"query","required":false},{"name":"find_where","description":"Search entities by comma-separated unique fields. Allowed values may vary depending on the integration.","schema":{"type":"string"},"example":"name","in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count = 250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"{return_code,return_message,pagination,result}"},"example":"{return_code,return_message,pagination,result}","in":"query","required":false}]}},"/item.add.json":{"post":{"tags":["item"],"summary":"item.add","description":"Use this method to create a new item.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"ItemAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemAdd"}}}}}},"/item.update.json":{"put":{"tags":["item"],"summary":"item.update","description":"Use this method to update an existing item.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"ItemUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated":{"type":"boolean"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemUpdate"}}}}}},"/item.delete.json":{"delete":{"tags":["item"],"summary":"item.delete","description":"Use this method to delete an item.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"ItemDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"boolean"}}}}}}}}},"parameters":[{"name":"id","description":"Defines ID","schema":{"type":"string"},"example":true,"in":"query","required":true},{"name":"organization_id","description":"Organization ID","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/organization.list.json":{"get":{"tags":["organization"],"summary":"organization.list","description":"This method allows you to retrieve a list of all organizations connected to the account in the corresponding accounting platform.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"OrganizationList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_Organization_List"}}}}},"parameters":[{"name":"ids","description":"Retrieves items specified by ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"created_from","description":"Retrieve entities from their creation date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"created_to","description":"Retrieve entities to their creation date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count = 250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"{return_code,return_message,pagination,result}"},"example":"{result}","in":"query","required":false}]}},"/purchase_order.list.json":{"get":{"tags":["purchase_order"],"summary":"purchase_order.list","description":"Use this method to retrieve one or more purchase orders, as well as the total count of purchase orders.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"PurchaseOrderList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_PurchaseOrder_List"}}}}},"parameters":[{"name":"ids","description":"Retrieves purchase orders specified by ids. Max allowed count = 20","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"organization_id","description":"Organization ID","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"contact_id","description":"Defines contact ID","schema":{"type":"string"},"example":"12345678","in":"query","required":false},{"name":"status","description":"Filters purchase orders by their status","schema":{"type":"string"},"example":"active","in":"query","required":false},{"name":"issue_date_from","description":"Retrieve entities from their issue date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"issue_date_to","description":"Retrieve entities to their issue date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"delivery_date_from","description":"Retrieve entities from their delivery date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"delivery_date_to","description":"Retrieve entities to their delivery date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"modified_from","description":"Retrieve entities from their modification date","schema":{"type":"string"},"example":"2010-07-29 13:45:52","in":"query","required":false},{"name":"modified_to","description":"Retrieve entities to their modification date","schema":{"type":"string"},"example":"2100-08-29 13:45:52","in":"query","required":false},{"name":"find_value","description":"Search entities by a specific value. Allowed values may vary depending on the integration.","schema":{"type":"string"},"example":"test","in":"query","required":false},{"name":"find_where","description":"Search entities by comma-separated unique fields. Allowed values may vary depending on the integration.","schema":{"type":"string"},"example":"name","in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count = 250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"{return_code,return_message,pagination,result}"},"example":"{result}","in":"query","required":false},{"name":"rounding_precision","description":"Specifies the rounding precision for fractional numeric values (such as prices, taxes, and weights).
Supported values range from 1 to 6.
The default rounding precision may vary depending on the platform. You can retrieve the default value using the cart.info method in the default_rounding_precision field.
Values are rounded to the nearest number at the specified precision. Fractions of .5 or higher are rounded up, while fractions lower than .5 are rounded down.
","schema":{"type":"integer"},"example":3,"in":"query","required":false}]}},"/purchase_order.add.json":{"post":{"tags":["purchase_order"],"summary":"purchase_order.add","description":"Use this method to create a new purchase order.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"PurchaseOrderAdd","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"id":{"type":"string"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderAdd"}}}}}},"/purchase_order.update.json":{"put":{"tags":["purchase_order"],"summary":"purchase_order.update","description":"Use this method to update a purchase order.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"PurchaseOrderUpdate","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"updated":{"type":"boolean"}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderUpdate"}}}}}},"/purchase_order.delete.json":{"delete":{"tags":["purchase_order"],"summary":"purchase_order.delete","description":"Use this method to delete a purchase order.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"PurchaseOrderDelete","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"return_code":{"type":"integer"},"return_message":{"type":"string"},"result":{"type":"object","properties":{"deleted":{"type":"boolean"}}}}}}}}},"parameters":[{"name":"id","description":"Defines ID","schema":{"type":"string"},"example":true,"in":"query","required":true},{"name":"organization_id","description":"Organization ID","schema":{"type":"string"},"example":"1","in":"query","required":false}]}},"/tax.rate.list.json":{"get":{"tags":["tax"],"summary":"tax.rate.list","description":"Use this method to retrieve one or more tax rates, as well as the total count of tax rates.","security":[{"ApiKeyAuth":[],"ConnectionKeyAuth":[]}],"operationId":"TaxRateList","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model_Response_TaxRate_List"}}}}},"parameters":[{"name":"ids","description":"Retrieves items specified by ids","schema":{"type":"string"},"example":"24,25","in":"query","required":false},{"name":"organization_id","description":"Organization ID","schema":{"type":"string"},"example":"1","in":"query","required":false},{"name":"status","description":"Filters tax rates by their status","schema":{"type":"string"},"example":"active","in":"query","required":false},{"name":"count","description":"This parameter sets the entity amount that has to be retrieved. Max allowed count = 250","schema":{"type":"integer","default":10},"example":20,"in":"query","required":false},{"name":"find_value","description":"Search entities by a specific value. Allowed values may vary depending on the integration.","schema":{"type":"string"},"example":"test","in":"query","required":false},{"name":"find_where","description":"Search entities by comma-separated unique fields. Allowed values may vary depending on the integration.","schema":{"type":"string"},"example":"name","in":"query","required":false},{"name":"page_cursor","description":"Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)","schema":{"type":"string"},"example":"","in":"query","required":false},{"name":"response_fields","description":"Set this parameter in order to choose which entity fields you want to retrieve","schema":{"type":"string","default":"{return_code,return_message,pagination,result}"},"example":"{result}","in":"query","required":false}]}}}, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "name": "x-api-key", "in": "header" }, "ConnectionKeyAuth": { "type": "apiKey", "name": "x-connection-key", "in": "header" } }, "schemas": {"Model_Response_Account_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Account_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Pagination":{"type":"object","properties":{"previous":{"type":["string","null"]},"next":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Account_List_Result":{"type":"object","properties":{"total_count":{"type":["integer","null"]},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/Account"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Account":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":["string","null"]},"code":{"type":["string","null"]},"parent_account_id":{"type":["string","null"]},"description":{"type":["string","null"]},"status":{"type":["string","null"]},"created_at":{"type":["string","null"]},"modified_at":{"type":["string","null"]},"currency":{"anyOf":[{"$ref":"#/components/schemas/Currency"},{"type":"null"}]},"balance":{"type":["number","null"]},"bank_account_number":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Currency":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"iso3":{"type":"string"},"symbol_left":{"type":"string"},"symbol_right":{"type":["string","null"]},"rate":{"type":["number","null"]},"avail":{"type":["boolean","null"]},"default":{"type":["boolean","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"AccountAdd":{"type":"object","properties":{"name":{"type":"string","description":"Defines name"},"type":{"description":"Defines type","type":"string"},"code":{"type":"string","description":"Defines code"},"description":{"type":"string","description":"Defines description"},"organization_id":{"type":"string","description":"Defines organization ID"},"parent_id":{"type":"string","description":"Defines parent account ID"},"status":{"type":"string","description":"Defines status"},"currency_code":{"type":"string","description":"Defines currency code"},"bank_account_number":{"type":"string","description":"Defines bank account number"},"tax_rate_id":{"type":"string","description":"Defines bank tax rate ID"},"idempotency_key":{"type":"string","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes."}}},"AccountUpdate":{"type":"object","properties":{"id":{"type":"string","description":"Defines ID"},"name":{"type":"string","description":"Defines name"},"type":{"description":"Defines type","type":"string"},"code":{"type":"string","description":"Defines code"},"description":{"type":"string","description":"Defines description"},"organization_id":{"type":"string","description":"Defines organization ID"},"parent_id":{"type":"string","description":"Defines parent account ID"},"status":{"type":"string","description":"Defines status"},"currency_code":{"type":"string","description":"Defines currency code"},"bank_account_number":{"type":"string","description":"Defines bank account number"},"tax_rate_id":{"type":"string","description":"Defines bank tax rate ID"},"idempotency_key":{"type":"string","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes."}},"required":["id"]},"Model_Response_Bill_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Bill_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Bill_List_Result":{"type":"object","properties":{"total_count":{"type":["integer","null"]},"bills":{"type":"array","items":{"$ref":"#/components/schemas/Bill"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Bill":{"type":"object","properties":{"id":{"type":"string"},"contact_id":{"type":"string"},"number":{"type":["string","null"]},"reference":{"type":["string","null"]},"status":{"type":["string","null"]},"issue_date":{"type":["string","null"]},"modified_at":{"type":["string","null"]},"due_date":{"type":["string","null"]},"currency":{"anyOf":[{"$ref":"#/components/schemas/Currency"},{"type":"null"}]},"exchange_rate":{"type":["number","null"]},"tax_calculation":{"type":["string","null"]},"totals":{"anyOf":[{"$ref":"#/components/schemas/Bill_Totals"},{"type":"null"}]},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/Bill_LineItem"}},"purchase_order_ids":{"type":"array","items":{"type":"string"}},"linked_documents":{"type":"array","items":{"$ref":"#/components/schemas/LinkedDocument"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Bill_Totals":{"type":"object","properties":{"subtotal":{"type":"number"},"tax":{"type":"number"},"total_amount":{"type":"number"},"balance_due":{"type":"number"},"total_paid":{"type":"number"},"applied_credits":{"type":"number"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Bill_LineItem":{"type":"object","properties":{"id":{"type":"string"},"item_id":{"type":["string","null"]},"account_id":{"type":["string","null"]},"description":{"type":["string","null"]},"quantity":{"type":["number","null"]},"location_id":{"type":["string","null"]},"unit_price_ex_tax":{"type":["number","null"]},"tax_value":{"type":["number","null"]},"tax_rate_id":{"type":["string","null"]},"total_amount":{"type":["number","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"LinkedDocument":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"date":{"type":["string","null"]},"amount":{"type":["number","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"BillAdd":{"type":"object","properties":{"organization_id":{"type":"string","description":"Defines organization ID"},"contact_id":{"description":"Defines contact ID","type":"string"},"number":{"description":"Defines number","type":"string"},"reference":{"description":"Defines reference","type":"string"},"status":{"description":"Defines status","type":"string"},"issue_date":{"type":"string","description":"Defines issue date"},"due_date":{"type":"string","description":"Defines due date"},"currency_code":{"type":"string","description":"Defines currency code"},"line_items":{"type":"array","description":"Defines line items"},"idempotency_key":{"type":"string","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes."}}},"BillUpdate":{"type":"object","properties":{"id":{"type":"string","description":"Defines ID"},"organization_id":{"type":"string","description":"Defines organization ID"},"contact_id":{"description":"Defines contact ID","type":"string"},"number":{"description":"Defines number","type":"string"},"reference":{"description":"Defines reference","type":"string"},"status":{"description":"Defines status","type":"string"},"issue_date":{"type":"string","description":"Defines issue date"},"due_date":{"type":"string","description":"Defines due date"},"currency_code":{"type":"string","description":"Defines currency code"},"line_items":{"type":"array","description":"Defines line items"},"idempotency_key":{"type":"string","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes."}},"required":["id"]},"Model_Response_Bill_CreditNote_List":{"type":"object","properties":{"return_code":{"type":["integer","null"]},"return_message":{"type":["string","null"]},"pagination":{"anyOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"null"}]},"result":{"anyOf":[{"$ref":"#/components/schemas/Response_Bill_CreditNote_List_Result"},{"type":"null"}]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Response_Bill_CreditNote_List_Result":{"type":"object","properties":{"total_count":{"type":["integer","null"]},"credit_notes":{"type":"array","items":{"$ref":"#/components/schemas/Bill_CreditNote"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Bill_CreditNote":{"type":"object","properties":{"id":{"type":"string"},"contact_id":{"type":"string"},"number":{"type":["string","null"]},"reference":{"type":["string","null"]},"status":{"type":["string","null"]},"issue_date":{"type":["string","null"]},"due_date":{"type":["string","null"]},"modified_at":{"type":["string","null"]},"currency":{"anyOf":[{"$ref":"#/components/schemas/Currency"},{"type":"null"}]},"exchange_rate":{"type":["number","null"]},"tax_calculation":{"type":["string","null"]},"totals":{"anyOf":[{"$ref":"#/components/schemas/Bill_CreditNote_Totals"},{"type":"null"}]},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/Bill_LineItem"}},"bill_allocations":{"type":"array","items":{"$ref":"#/components/schemas/Allocation"}},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Bill_CreditNote_Totals":{"type":"object","properties":{"subtotal":{"type":"number"},"tax":{"type":"number"},"total_amount":{"type":"number"},"remaining_amount":{"type":"number"},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"Allocation":{"type":"object","properties":{"id":{"type":"string"},"bill_id":{"type":"string"},"amount":{"type":["number","null"]},"date":{"type":["string","null"]},"additional_fields":{"type":["object","null"]},"custom_fields":{"type":["object","null"]}}},"BillCreditNoteAdd":{"type":"object","properties":{"organization_id":{"type":"string","description":"Defines organization ID"},"contact_id":{"description":"Defines contact ID","type":"string"},"number":{"description":"Defines number","type":"string"},"reference":{"description":"Defines reference","type":"string"},"status":{"description":"Defines status","type":"string"},"issue_date":{"type":"string","description":"Defines issue date"},"currency_code":{"type":"string","description":"Defines currency code"},"line_items":{"type":"array","description":"Defines line items"},"bill_allocations":{"type":"array","description":"Defines bill allocations"},"idempotency_key":{"type":"string","description":"A unique identifier associated with a specific request. Repeated requests with the same idempotency_key return a cached response without re-executing the business logic. Please note that the cache lifetime is 15 minutes."}}},"BillCreditNoteUpdate":{"type":"object","properties":{"id":{"type":"string","description":"Defines ID"},"organization_id":{"type":"string","description":"Defines organization ID"},"contact_id":{"description":"Defines contact ID","type":"string"},"number":{"description":"Defines number","type":"string"},"reference":{"description":"Defines reference","type":"string"},"status":{"description":"Defines status","type":"string"},"issue_date":{"type":"string","description":"Defines issue date"},"currency_code":{"type":"string","description":"Defines currency code"},"line_items":{"type":"array","description":"Defines line items"},"bill_allocations":{"type":"array","description":"Defines bill allocations"},"nested_items_update_behaviour":{"type":"string","default":"replace","description":" Determines how updates to nested items should be handled.