{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Invoices",
"description": "An invoice is a statement of items sold by a seller. It includes all the details of sale including units of goods, price of goods sold, shipping details, etc.",
"definitions": {
"gendoc-attributes-schema": {
"$ref": "#/components/schemas/invoice-response"
},
"invoice-response": {
"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"
},
"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": {
"description": "Items listed in invoice",
"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"
},
"time_entry_ids": {
"$ref": "#/components/schemas/time_entry_ids"
},
"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"
},
"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"
},
"item_total": {
"$ref": "#/components/schemas/item_total"
},
"location_id": {
"$ref": "#/components/schemas/location_id"
},
"location_name": {
"$ref": "#/components/schemas/location_name"
},
"hsn_or_sac": {
"$ref": "#/components/schemas/hsn_or_sac"
},
"is_combo_product": {
"$ref": "#/components/schemas/is_combo_product"
},
"combo_type": {
"$ref": "#/components/schemas/combo_type"
},
"mapped_items": {
"$ref": "#/components/schemas/mapped_items"
},
"serial_numbers": {
"$ref": "#/components/schemas/serial_numbers"
},
"batches": {
"$ref": "#/components/schemas/batches-response"
},
"storages": {
"$ref": "#/components/schemas/storages-response"
},
"item_custom_fields": {
"$ref": "#/components/schemas/item_custom_fields"
}
}
}
},
"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"
},
"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"
},
"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/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"
},
"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"
},
"invoice_url": {
"$ref": "#/components/schemas/invoice_url"
},
"is_pre_gst": {
"$ref": "#/components/schemas/is_pre_gst"
},
"gst_no": {
"$ref": "#/components/schemas/gst_no"
},
"gst_treatment": {
"$ref": "#/components/schemas/gst_treatment"
},
"place_of_supply": {
"$ref": "#/components/schemas/place_of_supply"
},
"tax_treatment": {
"$ref": "#/components/schemas/tax_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": []
}
}
},
"show_comment_to_clients": {
"description": "Boolean to check if the comment to be shown to the clients",
"type": "boolean",
"example": true
},
"ignore_auto_number_generation": {
"description": "Ignore auto invoice number generation for this invoice. This mandates the invoice number. Allowed values true and false",
"type": "boolean"
},
"send": {
"description": "Send the invoice to the contact person(s) associated with the invoice. Allowed values true and false.",
"type": "boolean"
},
"location_id": {
"description": "Location ID",
"type": "string",
"example": "460000000038080"
},
"location_name": {
"description": "Name of the location",
"type": "string"
},
"organization_contact_id": {
"description": "ID of the contact's organisation",
"type": "string",
"example": "2000000002266"
},
"is_org_email_id": {
"description": "To check if the email ID belongs to the organisation",
"type": "boolean",
"example": true
},
"comments": {
"description": "The details of the comments",
"type": "array",
"items": {
"type": "string"
}
},
"commented_by_id": {
"description": "Sorting by ID of the comment",
"type": "string",
"example": 982000000554041
},
"comment_type": {
"description": "Type of the comment",
"type": "string",
"example": "system"
},
"commented_by": {
"description": "Individual who made a comment",
"type": "string",
"example": "John David"
},
"date_description": {
"description": "Number of days since the comment was made",
"type": "string",
"example": "yesterday"
},
"time": {
"description": "Time of the comment",
"type": "string",
"example": "2:02 AM"
},
"operation_type": {
"description": "Type of operation done on the invoice",
"type": "string",
"example": "Added"
},
"transaction_id": {
"description": "Unique ID of the transaction",
"type": "string",
"example": " "
},
"transaction_type": {
"description": "Type of the transaction",
"type": "string",
"example": "invoice"
},
"online_transaction_id": {
"description": "Unique ID of an online transaction",
"type": "string",
"example": ""
},
"comment_id": {
"description": "The ID of the comment",
"type": "string",
"example": 982000000567019
},
"invoice_payments": {
"description": "Invoice payment list",
"type": "array",
"items": {
"type": "string"
}
},
"apply_creditnotes": {
"description": "Apply existing credit note of a customer against the invoice",
"type": "array",
"items": {
"type": "string"
}
},
"preview": {
"description": "Get the thumbnail of the attachment.",
"type": "boolean"
},
"credits": {
"description": "The list of credits",
"type": "array",
"items": {
"type": "string"
}
},
"creditnote_id": {
"description": "The ID of creditnote",
"type": "string",
"example": 982000000567134
},
"creditnotes_invoice_id": {
"description": "The creditnotes invoice ID",
"type": "string",
"example": "982000000567172"
},
"creditnotes_number": {
"description": "The creditnotes Number",
"type": "string",
"example": "CN-00001"
},
"credited_date": {
"description": "The date of credit",
"type": "string",
"example": "2013-11-18"
},
"amount_applied": {
"description": "The amount applied to a creditnote",
"type": "number",
"format": "float",
"example": 12.2
},
"payments": {
"description": "The list of payments",
"type": "array",
"items": {
"type": "string"
}
},
"payment_id": {
"description": "The ID of the payment",
"type": "string",
"example": 982000000567190
},
"payment_number": {
"description": "The payment Serial Number",
"type": "integer",
"example": 7
},
"invoice_payment_id": {
"description": "The invoice payment ID",
"type": "string",
"example": 982000000567192
},
"payment_mode": {
"description": "The mode of payment for the invoice",
"type": "string",
"example": "cash"
},
"amount": {
"description": "The amount in the payment of invoice",
"type": "number",
"format": "float",
"example": 10.57
},
"is_single_invoice_payment": {
"description": "To check if invoice is paid in a single payment or multiple payments",
"type": "boolean",
"example": true
},
"to_mails_str": {
"description": "Mail recepients",
"type": "string",
"example": ""
},
"cc_mails_str": {
"description": "Mail recepients who need to be CC'd",
"type": "string",
"example": ""
},
"from_email": {
"description": "Mail sender",
"type": "string",
"example": ""
},
"from_address": {
"description": "Sender's email address",
"type": "string",
"example": ""
},
"emailtemplate_documents": {
"description": "Email templates used",
"type": "array",
"items": {
"type": "string"
}
},
"file_name_without_extension": {
"description": "Name of file included",
"type": "string",
"example": "INV-000004"
},
"print": {
"description": "Print the exported pdf.",
"type": "boolean"
},
"accept": {
"description": "Get the details of a particular invoice in formats such as json/ pdf/ html. Default format is json. Allowed values json pdf and html",
"type": "string"
},
"templates": {
"type": "array",
"items": {
"type": "string"
}
},
"template_type": {
"description": "The type of template type",
"type": "string",
"example": "classic"
},
"error_list": {
"description": "Error List",
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"file_name": {
"description": "Name of the file attached",
"type": "string",
"example": "INV-00001.pdf"
},
"to_contacts": {
"description": "Email recepients",
"type": "array",
"items": {
"type": "string"
}
},
"contact_person_name": {
"description": "Name of the Contact Person",
"type": "string",
"example": "David"
},
"first_name": {
"description": "First Name of the Contact Person",
"type": "string",
"example": "David"
},
"phone": {
"description": "Phone Number of the Contact Person",
"type": "string",
"example": "+1-925-921-9201"
},
"last_name": {
"description": "Last Name of the Contact Person",
"type": "string",
"example": "John"
},
"salutation": {
"description": "Salutation of the Contact Person",
"type": "string",
"example": "Mr"
},
"contact_person_id": {
"description": "Unique ID of the Contact Person",
"type": "string",
"example": 982000000567003
},
"contact_person_email": {
"description": "Email ID of the Contact Person.",
"type": "string",
"example": "willsmith@bowmanfurniture.com"
},
"mobile": {
"description": "Mobile Number of the Contact Person",
"type": "string",
"example": "+1-4054439562"
},
"from_emails": {
"description": "Email sender address",
"type": "array",
"items": {
"type": "string"
}
},
"user_name": {
"description": "User name of the contact",
"type": "string",
"example": "David John"
},
"emailtemplates": {
"description": "Email template used to send invoice",
"type": "array",
"items": {
"type": "string"
}
},
"gateways_configured": {
"description": "List of payment gateways configured",
"type": "boolean",
"example": true
},
"deprecated_placeholders_used": {
"description": "List of placeholders used in invoice",
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"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"
},
"invoice_ids": {
"description": "Comma separated invoice ids which are to be emailed.",
"type": "string"
},
"contacts": {
"description": "Contacts to whom email or snail mail has to be sent.",
"type": "array",
"items": {
"type": "string"
}
},
"contact_id": {
"description": "ID of the contact. Can specify if email or snail mail has to be sent for each contact.",
"type": "string",
"example": 460000000026049
},
"snail_mail": {
"description": "the boolean check for snail mail",
"type": "boolean",
"example": false
},
"attachment": {
"description": "The file to be attached",
"type": "string",
"format": "binary"
},
"send_customer_statement": {
"description": "Send customer statement pdf a with email.",
"type": "boolean",
"example": " "
},
"send_attachment": {
"description": "Send the invoice attachment a with the email.",
"type": "boolean",
"example": " "
},
"cc_mail_ids": {
"description": "Array of email addresses of the recipients to be CC'd.",
"type": "array",
"items": {
"type": "string"
},
"example": [
"peterparker@bowmanfurniture.com"
]
},
"to_mail_ids": {
"description": "Array of email addresses of the recipients.",
"type": "array",
"items": {
"type": "string"
},
"example": [
"willsmith@bowmanfurniture.com"
]
},
"subject": {
"description": "The subject of the mail",
"type": "string",
"example": "Invoice from Zillium Inc (Invoice#: INV-00001)"
},
"body": {
"description": "The body/content of the mail",
"type": "string",
"example": "Dear Customer,
Thanks for your business.
The invoice INV-00001 is attached with this email. You can choose the easy way out and pay online for this invoice.
Here's an overview of the invoice for your reference.
Invoice Overview:
Invoice : INV-00001
Date : 05 Aug 2013
Amount : $541.82
It was great working with you. Looking forward to working with you again.
\\nRegards
\\nZillium Inc
\\n\","
},
"send_from_org_email_id": {
"description": "Boolean to trigger the email from the organization's email address",
"type": "boolean",
"example": false
},
"attachments": {
"description": "Files to be attached to the email",
"type": "string",
"format": "binary"
},
"reason": {
"description": "Description of the attachment",
"type": "string",
"example": " "
},
"custom_subject": {
"description": "Customized Subject line",
"type": "string",
"example": " "
},
"custom_body": {
"description": "Customized email content",
"type": "string",
"example": " "
},
"invoiced_estimate_id": {
"description": "ID of the invoice from which the invoice is created.",
"type": "string",
"example": " "
},
"can_send_in_mail": {
"description": "To check if attachment can be sent in email",
"type": "boolean",
"example": true
},
"invoice_url": {
"description": "Url of invoice as a link",
"type": "string",
"example": "https://invoice.zoho.com/SecurePayment?CInvoiceID=23d84d0cf64f9a72ea0c66fded25a08c8bafd0ab508aff05323a9f80e2cd03fdc5dd568d3d6407bbda969d3e870d740b6fce549a9438c4ea"
},
"attachment_name": {
"description": "Name of the file attached",
"type": "string",
"example": " "
},
"last_modified_time": {
"description": "Date of last modification of the invoice",
"type": "string",
"example": "2013-11-18"
},
"salesperson_id": {
"description": "ID of the salesperson linked to invoice",
"type": "string",
"example": " "
},
"salesperson_name": {
"description": "Name of the salesperson. Maximum length [200]",
"type": "string",
"example": " "
},
"created_time": {
"description": "The time of creation of the invoices",
"type": "string",
"example": "2013-11-18"
},
"template_id": {
"description": "ID of the pdf template associated with the invoice.",
"type": "string",
"example": 982000000000143
},
"template_name": {
"description": "Name of the invoice template used",
"type": "string",
"example": "Service - Classic"
},
"bcc_mails": {
"description": "Bcc mail details",
"type": "array",
"items": {
"type": "string"
},
"example": ""
},
"gateways_associated": {
"description": "List of Payment gateways associated",
"type": "boolean",
"example": true
},
"bcc_mails_str": {
"description": "Bcc mails content",
"type": "string",
"example": ""
},
"attach_pdf": {
"description": "check if PDF attachment",
"type": "boolean",
"example": true
},
"entity_id": {
"description": "Unique ID of the entity associated",
"type": "string",
"example": "2000000007037"
},
"show_on_pdf": {
"description": "Boolean value to check if the custom field is to be dispplayed on the pdf.",
"type": "boolean",
"example": false
},
"value": {
"description": "Value of the custom field like VAT Id etc.",
"type": "string",
"example": "The value of the custom field"
},
"label": {
"description": "The label of the custom field.",
"type": "string",
"example": "Delivery Date"
},
"billing_address_id": {
"description": "Unique Id generated by the server for address in contacts page. To add a billing address to invoice, send the address_id using this node. Else, the default billing address for that contact is used",
"type": "string",
"example": 4815000000017005
},
"shipping_address_id": {
"description": "Unique Id generated by the server for address in contacts page. To add a shipping address to invoice, send the address_id using this node. Else, the default shipping address for that contact is used",
"type": "string",
"example": 4815000000017005
},
"address": {
"description": "Billing address for the invoice",
"type": "string",
"example": "4900 Hopyard Rd, Suite 310"
},
"city": {
"description": "City of the customer's billing address.",
"type": "string",
"example": "Pleasanton"
},
"state": {
"description": "State of the customer's billing address.",
"type": "string",
"example": "CA"
},
"zip": {
"description": "Zip code of the customer's billing address.",
"type": "string",
"example": 94588
},
"country": {
"description": "Country of the customer's billing address.",
"type": "string",
"example": "U.S.A"
},
"fax": {
"description": "Customer's fax number.",
"type": "string",
"example": "+1-925-924-9600"
},
"notes": {
"description": "The notes added below expressing gratitude or for conveying some information.",
"type": "string",
"example": "Looking forward for your business."
},
"terms": {
"description": "The terms added below expressing gratitude or for conveying some information.",
"type": "string",
"example": "Terms & Conditions apply"
},
"is_emailed": {
"description": "Boolean check to see if the mail has been sent",
"type": "boolean",
"example": false
},
"reminders_sent": {
"description": "The number of reminders sent",
"type": "integer",
"example": 1
},
"last_reminder_sent_date": {
"description": "The date the last email was sent",
"type": "string",
"example": " "
},
"salesorder_item_id": {
"description": "Pass the unique ID(line_item_id) generated by the server for the line item in sales order for this node to associate this invoice with the sales order",
"type": "string",
"example": 4815000000017009
},
"shipping_charge": {
"description": "Shipping charges applied to the invoice. Maximum length [100]",
"type": "string",
"example": 0
},
"adjustment": {
"description": "Adjustments made to the invoice.",
"type": "number",
"format": "double",
"example": 0
},
"adjustment_description": {
"description": "Customize the adjustment description. E.g. Rounding off.",
"type": "string",
"example": " "
},
"sub_total": {
"description": "The sub total of the all items",
"type": "number",
"format": "float",
"example": 153
},
"tax_total": {
"description": "The total amount of the tax levied",
"type": "number",
"format": "double",
"example": 22.6
},
"price_precision": {
"description": "The precision value on the price",
"type": "integer",
"example": 2
},
"taxes": {
"description": "List of the taxes levied",
"type": "array",
"items": {
"type": "object",
"properties": {
"tax_name": {
"$ref": "#/components/schemas/tax_name"
},
"tax_amount": {
"$ref": "#/components/schemas/tax_amount"
}
}
}
},
"payment_reminder_enabled": {
"description": "Boolean to check if reminders have been enabled",
"type": "boolean",
"example": true
},
"payment_made": {
"description": "The amount paid",
"type": "number",
"format": "float",
"example": 26.91
},
"credits_applied": {
"description": "The credits applied",
"type": "number",
"format": "float",
"example": 22.43
},
"tax_amount_withheld": {
"description": "The tax amount which has been withheld",
"type": "number",
"format": "float",
"example": 0
},
"write_off_amount": {
"description": "The write off amount. i.e. the amount which is not expected to be returned. Like a bad debt",
"type": "number",
"format": "float",
"example": 0
},
"allow_partial_payments": {
"description": "Boolean to check if partial payments are allowed for the contact",
"type": "boolean",
"example": true
},
"configured": {
"description": "Boolean check to see if a payment gateway has been configured",
"type": "boolean",
"example": true
},
"additional_field1": {
"description": "Paypal payment method. Allowed Values: standard and adaptive",
"type": "string",
"example": "standard"
},
"gateway_name": {
"description": "Name of the payment gateway associated with the invoice. E.g. paypal, stripe.Allowed Values: paypal, authorize_net, payflow_pro, stripe, 2checkout and braintree",
"type": "string",
"example": "paypal"
},
"payment_terms": {
"description": "Payment terms in days e.g. 15, 30, 60. Invoice due date will be calculated based on this. Maximum length [100]",
"type": "integer",
"example": 15
},
"payment_terms_label": {
"description": "Used to override the default payment terms label. Default value for 15 days is \"Net 15 Days\". Maximum length [100]",
"type": "string",
"example": "Net 15"
},
"email": {
"description": "contact's email id. Maximum length [100]",
"type": "string",
"example": "willsmith@bowmanfurniture.com"
},
"is_primary_contact": {
"description": "To mark contact person as primary for contact"
},
"is_email_enabled": {
"description": "Used to check if Email communication preference is enabled for the contact person at transaction level.",
"type": "boolean",
"example": true
},
"is_sms_enabled": {
"description": "Used to check if SMS communication preference is enabled for the contact person at transaction level.",
"type": "boolean",
"example": true,
"x-node_available_in": [
"SMS integration"
]
},
"is_whatsapp_enabled": {
"description": "Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.",
"type": "boolean",
"example": true,
"x-node_available_in": [
"WhatsApp integration"
]
},
"communication_preference": {
"description": "Preferred modes of communication for the contact person at transaction level.",
"type": "object",
"properties": {
"is_email_enabled": {
"$ref": "#/components/schemas/is_email_enabled"
},
"is_sms_enabled": {
"$ref": "#/components/schemas/is_sms_enabled"
},
"is_whatsapp_enabled": {
"$ref": "#/components/schemas/is_whatsapp_enabled"
}
}
},
"contact_persons_associated": {
"description": "Contact Persons associated with the invoice.",
"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 invoice.",
"type": "array",
"items": {
"type": "object",
"properties": {
"contact_person_id": {
"$ref": "#/components/schemas/contact_person_id"
},
"communication_preference": {
"$ref": "#/components/schemas/communication_preference"
}
}
}
},
"tax_id": {
"description": "ID of the tax or tax group applied to the estimate",
"type": "string",
"example": 982000000557028
},
"tds_tax_id": {
"description": "ID of the TDS tax.",
"type": "string",
"example": 982000000557012,
"x-node_available_in": [
"mx"
],
"x-node_unavailable_in": []
},
"tax_authority_id": {
"description": "ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.",
"type": "string",
"example": 11149000000061052,
"x-node_available_in": [
"us"
],
"x-node_unavailable_in": []
},
"tax_exemption_id": {
"description": "ID of the tax exemption.",
"type": "string",
"example": 11149000000061054,
"x-node_available_in": [
"us",
"in"
],
"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. Maximum length [25]",
"type": "string",
"x-node_available_in": [
"Avalara Integration"
],
"x-node_unavailable_in": []
},
"avatax_exempt_no": {
"description": "Exemption certificate number of the customer. Maximum length [25]",
"type": "string",
"x-node_available_in": [
"Avalara Integration"
],
"x-node_unavailable_in": []
},
"vat_treatment": {
"description": "VAT treatment for the invoice. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered and if he resides outside the EU then his VAT treatment is overseas (For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu).",
"type": "string",
"x-node_available_in": [
"uk"
],
"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. Maximum length [25]",
"type": "string",
"x-node_available_in": [
"Avalara Integration"
],
"x-node_unavailable_in": []
},
"exchange_rate": {
"description": "Exchange rate of the currency.",
"type": "number",
"format": "float",
"example": 1
},
"discount": {
"description": "Discount applied to the invoice, which can be either a percentage or a flat amount. For percentage discounts, the value should include the % symbol (e.g., 10%). For example, on Rs.1000, a 10% discount results in Rs.900, while a flat Rs.200 discount results in Rs.800. Maximum length [100]",
"type": "number",
"format": "float",
"example": 0
},
"is_discount_before_tax": {
"description": "Check if discount is exclusive of tax",
"type": "boolean",
"example": true
},
"discount_type": {
"description": "Type of discount. Allowed values are entity_level,item_level. For entity_level type, discount is applied at entity level and the node discount resides outside the line_items node.For item_level type, discount is applied at item level and the node discount resides inside each line_item under the line_items node.",
"type": "string",
"example": "item_level"
},
"is_inclusive_tax": {
"description": "To check if discount is inclusive of tax",
"type": "boolean",
"example": false
},
"item_custom_fields": {
"type": "array",
"description": "List of custom fields associated with the line item",
"items": {
"type": "object",
"properties": {
"label": {
"$ref": "#/components/schemas/label"
},
"value": {
"$ref": "#/components/schemas/value"
}
}
}
},
"line_items": {
"description": "Line items of an invoice.",
"type": "array",
"items": {
"type": "string"
}
},
"project_id": {
"description": "Unique ID of the projet associated to an invoice",
"type": "string",
"example": " "
},
"time_entry_ids": {
"description": "Unique ID's of all the time entries associated to the linked project",
"type": "string",
"example": " "
},
"expense_id": {
"description": "Unique ID of the expenses associated",
"type": "string",
"example": " "
},
"expense_receipt_name": {
"description": "Name of the expense receipt associated",
"type": "string"
},
"line_item_id": {
"description": "The line item ID",
"type": "string",
"example": 982000000567021
},
"name": {
"description": "The name of the line item. Maximum length [100]",
"type": "string",
"example": "Hard Drive"
},
"description": {
"description": "The description of the line items. Maximum length [2000]",
"type": "string",
"example": "500GB, USB 2.0 interface 1400 rpm, protective hard case."
},
"item_order": {
"description": "The order of the line item_order",
"type": "integer",
"example": 1
},
"bcy_rate": {
"description": "base currency rate",
"type": "number",
"format": "float",
"example": 120
},
"rate": {
"description": "Rate of the line item.",
"type": "number",
"format": "double",
"example": 120
},
"quantity": {
"description": "The quantity of line item",
"type": "number",
"format": "float",
"example": 1
},
"unit": {
"description": "Unit of the line item e.g. kgs, Nos. Maximum length [100]",
"type": "string",
"example": " "
},
"discount_amount": {
"description": "The discount amount on the line item",
"type": "number",
"format": "float",
"example": 0
},
"tax_name": {
"description": "The name of the tax",
"type": "string",
"example": "VAT"
},
"tax_amount": {
"description": "The amount of the tax levied",
"type": "number",
"format": "float",
"example": 19.13
},
"tax_type": {
"description": "The type of the tax",
"type": "string",
"example": "tax"
},
"tax_percentage": {
"description": "The percentage of tax levied",
"type": "number",
"format": "float",
"example": 12.5
},
"item_total": {
"description": "The total amount of the line items",
"type": "number",
"format": "float",
"example": 120
},
"is_combo_product": {
"description": "Indicates whether the line item is a composite product.",
"type": "boolean",
"example": true
},
"combo_type": {
"description": "Type of the composite item. Allowed values are assembly and kit.",
"type": "string",
"example": "kit"
},
"mapped_items": {
"description": "Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.",
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"line_item_id": {
"$ref": "#/components/schemas/line_item_id"
},
"item_order": {
"$ref": "#/components/schemas/item_order"
},
"name": {
"$ref": "#/components/schemas/name"
},
"description": {
"$ref": "#/components/schemas/description"
},
"quantity": {
"$ref": "#/components/schemas/quantity"
},
"combo_type": {
"$ref": "#/components/schemas/combo_type"
},
"warehouse_id": {
"description": "Unique ID of the warehouse from which the mapped item is fulfilled.",
"type": "string",
"example": "460000000038080"
},
"location_id": {
"$ref": "#/components/schemas/location_id"
},
"mapped_items": {
"description": "Nested mapped items for kit within kit scenarios.",
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"line_item_id": {
"$ref": "#/components/schemas/line_item_id"
},
"item_order": {
"$ref": "#/components/schemas/item_order"
},
"name": {
"$ref": "#/components/schemas/name"
},
"description": {
"$ref": "#/components/schemas/description"
},
"quantity": {
"$ref": "#/components/schemas/quantity"
},
"combo_type": {
"$ref": "#/components/schemas/combo_type"
},
"warehouse_id": {
"description": "Unique ID of the warehouse from which the mapped item is fulfilled.",
"type": "string",
"example": "460000000038080"
},
"location_id": {
"$ref": "#/components/schemas/location_id"
}
}
}
}
}
}
},
"mapped_items_create": {
"description": "Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.",
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"salesorder_item_id": {
"$ref": "#/components/schemas/salesorder_item_id"
},
"item_order": {
"$ref": "#/components/schemas/item_order"
},
"name": {
"$ref": "#/components/schemas/name"
},
"description": {
"$ref": "#/components/schemas/description"
},
"quantity": {
"$ref": "#/components/schemas/quantity"
},
"warehouse_id": {
"description": "Unique ID of the warehouse from which the mapped item is fulfilled.",
"type": "string",
"example": "460000000038080"
},
"location_id": {
"$ref": "#/components/schemas/location_id"
},
"mapped_items": {
"description": "Nested mapped items for kit within kit scenarios.",
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"salesorder_item_id": {
"$ref": "#/components/schemas/salesorder_item_id"
},
"item_order": {
"$ref": "#/components/schemas/item_order"
},
"name": {
"$ref": "#/components/schemas/name"
},
"description": {
"$ref": "#/components/schemas/description"
},
"quantity": {
"$ref": "#/components/schemas/quantity"
},
"warehouse_id": {
"description": "Unique ID of the warehouse from which the mapped item is fulfilled.",
"type": "string",
"example": "460000000038080"
},
"location_id": {
"$ref": "#/components/schemas/location_id"
}
}
}
}
}
}
},
"mapped_items_update": {
"description": "Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.",
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"line_item_id": {
"$ref": "#/components/schemas/line_item_id"
},
"salesorder_item_id": {
"$ref": "#/components/schemas/salesorder_item_id"
},
"item_order": {
"$ref": "#/components/schemas/item_order"
},
"name": {
"$ref": "#/components/schemas/name"
},
"description": {
"$ref": "#/components/schemas/description"
},
"quantity": {
"$ref": "#/components/schemas/quantity"
},
"warehouse_id": {
"description": "Unique ID of the warehouse from which the mapped item is fulfilled.",
"type": "string",
"example": "460000000038080"
},
"location_id": {
"$ref": "#/components/schemas/location_id"
},
"mapped_items": {
"description": "Nested mapped items for kit within kit scenarios.",
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"line_item_id": {
"$ref": "#/components/schemas/line_item_id"
},
"salesorder_item_id": {
"$ref": "#/components/schemas/salesorder_item_id"
},
"item_order": {
"$ref": "#/components/schemas/item_order"
},
"name": {
"$ref": "#/components/schemas/name"
},
"description": {
"$ref": "#/components/schemas/description"
},
"quantity": {
"$ref": "#/components/schemas/quantity"
},
"warehouse_id": {
"description": "Unique ID of the warehouse from which the mapped item is fulfilled.",
"type": "string",
"example": "460000000038080"
},
"location_id": {
"$ref": "#/components/schemas/location_id"
}
}
}
}
}
}
},
"item_name": {
"description": "item name.Maximum length [100]",
"type": "string",
"example": "Desktop Units"
},
"item_id": {
"description": "Unique item id.",
"type": "string",
"example": 982000000030049
},
"item_description": {
"description": "Search invoices by item description.Variants: item_description_startswith and item_description_contains. Maximum length [100]",
"type": "string",
"example": " "
},
"recurring_invoice_id": {
"description": "ID of the recurring invoice from which the invoice is created.",
"type": "string",
"example": " "
},
"page_context": {
"description": "The context of a particular page.",
"type": "array",
"items": {
"type": "string"
}
},
"applied_filter": {
"description": "The filer applied for sorting",
"type": "string",
"example": "Status.All"
},
"page": {
"description": "Number of pages",
"type": "integer",
"example": 1
},
"per_page": {
"description": "Per page values",
"type": "integer",
"example": 200
},
"report_name": {
"description": "The report name",
"type": "string",
"example": "Invoices"
},
"has_more_page": {
"description": "Check if has more pages",
"type": "boolean",
"example": false
},
"sort_order": {
"description": "The order for sorting",
"type": "string",
"example": "D"
},
"sort_column": {
"description": "Sort invoices.Allowed Values: customer_name, invoice_number, date, due_date, total, balance and created_time",
"type": "string",
"example": "created_time"
},
"invoices": {
"description": "The invoices created by the user",
"type": "array",
"items": {
"type": "string"
}
},
"invoice_number": {
"description": "An unique number given to the invoice. Maximum length [100]",
"type": "string",
"example": "INV-00003"
},
"invoice_id": {
"description": "The ID of the invoice",
"type": "string",
"example": 982000000567114
},
"customer_name": {
"description": "The name of the customer. Maximum length [100]",
"type": "string",
"example": "Bowman & Co"
},
"customer_id": {
"description": "ID of the customer the invoice has to be created.",
"type": "string",
"example": 982000000567001
},
"status": {
"description": "Search invoices by invoice status.Allowed Values: sent, draft, overdue, paid, void, unpaid, partially_paid and viewed",
"type": "string",
"example": "draft"
},
"reference_number": {
"description": "The reference number of the invoice",
"type": "string",
"example": " "
},
"date": {
"description": "invoice date. Default date format is yyyy-mm-dd.",
"type": "string",
"example": "2013-11-17"
},
"due_date": {
"description": "due date of the invoices. Default date format is yyyy-mm-dd.",
"type": "string",
"example": "2013-12-03"
},
"due_days": {
"description": "Specifies the number of day in which the invoice would become overdue",
"type": "string",
"example": "Due in 14 day(s)"
},
"currency_id": {
"description": "The currenct id of the currency",
"type": "string",
"example": 982000000000190
},
"currency_code": {
"description": "The currency code in which the invoice is created.",
"type": "string",
"example": "USD"
},
"total": {
"description": "The total amount to be paid",
"type": "string",
"example": 40.6
},
"custom_field": {
"description": "custom fields for invoice.",
"type": "string",
"example": " "
},
"filter_by": {
"description": "Filter invoices by any status or payment expected date.Allowed Values: Status.All, Status.Sent, Status.Draft, Status.OverDue, Status.Paid, Status.Void, Status.Unpaid, Status.PartiallyPaid, Status.Viewed and Date.PaymentExpectedDate",
"type": "string",
"example": " "
},
"search_text": {
"description": "Search invoices by invoice number or purchase order or customer name. Maximum length [100]",
"type": "string",
"example": " "
},
"balance": {
"description": "The unpaid amount",
"type": "string",
"example": 40.6
},
"payment_expected_date": {
"description": "The expected date of payment",
"type": "string",
"example": " "
},
"last_payment_date": {
"description": "The last payment date of the invoice",
"type": "string",
"example": " "
},
"selected": {
"description": "To check if invoice is selected or not",
"type": "boolean",
"example": true
},
"ach_payment_initiated": {
"description": "To check initiation of ACH Payment",
"type": "boolean",
"example": false
},
"schedule_time": {
"description": "Schedule time for payment",
"type": "string",
"example": ""
},
"is_viewed_by_client": {
"description": "Check if invoice is viewed by client",
"type": "boolean",
"example": false
},
"has_attachment": {
"description": "To check if invoice has an attachment",
"type": "boolean",
"example": false
},
"client_viewed_time": {
"description": "Time when client viewed the statement",
"type": "string",
"example": ""
},
"documents": {
"description": "Documents send along with invoice",
"type": "string",
"example": ""
},
"customfield_id": {
"type": "string",
"description": "Unique ID of the custom field."
},
"custom_fields": {
"description": "Additional fields added to the invoice",
"type": "array",
"items": {
"type": "object",
"properties": {
"customfield_id": {
"$ref": "#/components/schemas/customfield_id"
},
"show_on_pdf": {
"$ref": "#/components/schemas/show_on_pdf"
},
"value": {
"$ref": "#/components/schemas/value"
},
"label": {
"$ref": "#/components/schemas/label"
}
}
}
},
"custom_fields_update": {
"description": "Custom fields for an invoice.",
"type": "array",
"items": {
"type": "object",
"properties": {
"customfield_id": {
"type": "string",
"description": "Unique ID of the custom field.",
"example": "46000000012845"
},
"value": {
"$ref": "#/components/schemas/value"
}
}
}
},
"update-an-invoice-customfield-response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0,
"readOnly": true
},
"message": {
"type": "string",
"example": "Custom Fields Updated Successfully",
"readOnly": true
}
}
},
"billing_address": {
"description": "Billing address of the contact",
"type": "object",
"properties": {
"address": {
"$ref": "#/components/schemas/address"
},
"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": {
"description": "Shipping address of the contact",
"type": "object",
"properties": {
"address": {
"$ref": "#/components/schemas/address"
},
"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"
}
}
},
"payment_gateways": {
"description": "Payment gateways integrated and supported",
"type": "array",
"items": {
"type": "object",
"properties": {
"configured": {
"$ref": "#/components/schemas/configured"
},
"additional_field1": {
"$ref": "#/components/schemas/additional_field1"
},
"gateway_name": {
"$ref": "#/components/schemas/gateway_name"
}
}
}
},
"payment_options": {
"description": "Payment options available for payment",
"type": "object",
"properties": {
"payment_gateways": {
"$ref": "#/components/schemas/payment_gateways"
}
}
},
"place_of_supply": {
"description": "Place where the goods/services are supplied to. (If not given, place of contact given for the contact will be taken)",
"type": "string",
"example": "TN",
"x-node_available_in": [
"in"
],
"x-node_unavailable_in": []
},
"tax_treatment": {
"description": "VAT treatment for the invoice .Choose whether the contact falls under:home_country_mexico,border_region_mexico,non_mexico supported only for MX.",
"type": "string",
"example": "vat_registered",
"x-node_available_in": [
"mx"
],
"x-node_unavailable_in": []
},
"gst_no": {
"description": "15 digit GST identification number of the customer.",
"type": "string",
"example": "22AAAAA0000A1Z5",
"x-node_available_in": [
"in"
],
"x-node_unavailable_in": []
},
"cfdi_usage": {
"description": "Choose CFDI Usage. Allowed values:acquisition_of_merchandise, return_discount_bonus, general_expense, buildings, furniture_office_equipment, transport_equipment, computer_equipmentdye_molds_tools, telephone_communication, satellite_communication, other_machinery_equipment, hospital_expense, medical_expense_disability, funeral_expense, donation, interest_mortage_loans, contribution_sar, medical_expense_insurance_pormium, school_transportation_expense, deposit_saving_account, payment_educational_service, no_tax_effect, payment, payroll.",
"type": "string",
"example": "acquisition_of_merchandise",
"x-node_available_in": [
"mx"
],
"x-node_unavailable_in": []
},
"cfdi_reference_type": {
"description": "Choose CFDI Reference Type. Allowed values:return_of_merchandise, substitution_previous_cfdi, transfer_of_goods, invoice_generated_from_order, cfdi_for_advance.",
"type": "string",
"example": "return_of_merchandise",
"x-node_available_in": [
"mx"
],
"x-node_unavailable_in": []
},
"reference_invoice_id": {
"description": "Associate the reference invoice.",
"type": "string",
"example": "132738000000126013",
"x-node_available_in": [
"mx"
],
"x-node_unavailable_in": []
},
"gst_treatment": {
"description": "Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .",
"type": "string",
"example": "business_gst",
"x-node_available_in": [
"in"
],
"x-node_unavailable_in": []
},
"is_pre_gst": {
"description": "Applicable for transactions that fall before july 1, 2017",
"type": "boolean",
"example": false,
"x-node_available_in": [
"in"
],
"x-node_unavailable_in": []
},
"hsn_or_sac": {
"description": "Add HSN/SAC code for your goods/services",
"type": "string",
"example": 80540,
"x-node_available_in": [
"in"
],
"x-node_unavailable_in": []
},
"sat_item_key_code": {
"description": "Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.",
"type": "string",
"example": 71121206,
"x-node_available_in": [
"mx"
],
"x-node_unavailable_in": []
},
"unitkey_code": {
"description": "Add SAT Unit Key Code for your goods/services. Download the CFDI Catalogs.",
"type": "string",
"example": "E48",
"x-node_available_in": [
"mx"
],
"x-node_unavailable_in": []
},
"serial_numbers": {
"description": "Serial numbers for the line item. Applicable only for items with serial tracking enabled.",
"type": "array",
"items": {
"type": "string",
"example": "ARMP-0078"
}
},
"batches": {
"description": "Batch details for the line item. Reference an existing batch using batch_id. Applicable only for items with batch tracking enabled.",
"type": "array",
"items": {
"type": "object",
"required": [
"batch_id",
"out_quantity"
],
"properties": {
"batch_id": {
"description": "Unique identifier of an existing batch.",
"type": "string",
"example": "6780203000000214019"
},
"out_quantity": {
"description": "Quantity removed from the batch.",
"type": "number",
"format": "float",
"example": 2
},
"storages": {
"description": "Bin/storage locations from which stock was issued for this batch.",
"type": "array",
"x-node_available_in": [
"Batch with Bin tracked items"
],
"items": {
"type": "object",
"required": [
"storage_id",
"out_quantity"
],
"properties": {
"storage_id": {
"description": "Unique identifier of the bin/storage location.",
"type": "string",
"example": "6780203000000093226"
},
"out_quantity": {
"description": "Quantity removed from the bin.",
"type": "number",
"format": "float",
"example": 2
}
}
}
}
}
}
},
"storages": {
"description": "Bin/storage locations allocated (or consumed, for assemblies) for the line item. Applicable only for items with bin tracking enabled.",
"type": "array",
"items": {
"type": "object",
"required": [
"storage_id",
"out_quantity"
],
"properties": {
"storage_id": {
"description": "Unique identifier of the bin/storage location.",
"type": "string",
"example": "6780203000000093225"
},
"out_quantity": {
"description": "Quantity removed from the bin.",
"type": "number",
"format": "float",
"example": 2
},
"serial_numbers": {
"description": "Serial numbers allocated to this bin.",
"type": "array",
"x-node_available_in": [
"Serial with Bin tracked items"
],
"items": {
"type": "string",
"example": "PKG-011"
}
}
}
}
},
"batches-update": {
"description": "Batch details for the line item. Reference an existing batch using batch_id. Applicable only for items with batch tracking enabled.",
"type": "array",
"items": {
"type": "object",
"required": [
"batch_id",
"out_quantity"
],
"properties": {
"batch_id": {
"description": "Unique identifier of an existing batch.",
"type": "string",
"example": "6780203000000214019"
},
"out_quantity": {
"description": "Quantity removed from the batch.",
"type": "number",
"format": "float",
"example": 2
},
"storages": {
"description": "Bin/storage locations from which stock was issued for this batch.",
"type": "array",
"x-node_available_in": [
"Batch with Bin tracked items"
],
"items": {
"type": "object",
"required": [
"storage_id",
"out_quantity"
],
"properties": {
"storage_id": {
"description": "Unique identifier of the bin/storage location.",
"type": "string",
"example": "6780203000000093226"
},
"out_quantity": {
"description": "Quantity removed from the bin.",
"type": "number",
"format": "float",
"example": 2
},
"storage_out_id": {
"description": "Unique identifier of the storage record. Applicable only when updating an existing storage entry.",
"type": "string",
"example": "6780203000000997441"
}
}
}
}
}
}
},
"storages-update": {
"description": "Bin/storage locations allocated (or consumed, for assemblies) for the line item. Applicable only for items with bin tracking enabled.",
"type": "array",
"items": {
"type": "object",
"required": [
"storage_id",
"out_quantity"
],
"properties": {
"storage_id": {
"description": "Unique identifier of the bin/storage location.",
"type": "string",
"example": "6780203000000093225"
},
"out_quantity": {
"description": "Quantity removed from the bin.",
"type": "number",
"format": "float",
"example": 2
},
"storage_out_id": {
"description": "Unique identifier of the storage record. Applicable only when updating an existing storage entry.",
"type": "string",
"example": "6780203000000997440"
},
"serial_numbers": {
"description": "Serial numbers allocated to this bin.",
"type": "array",
"x-node_available_in": [
"Serial with Bin tracked items"
],
"items": {
"type": "string",
"example": "PKG-011"
}
}
}
}
},
"batches-response": {
"description": "Batches tracked for the line item. Returned for items with batch tracking enabled.",
"type": "array",
"items": {
"type": "object",
"properties": {
"batch_id": {
"description": "Unique identifier of the batch.",
"type": "string",
"example": "6780203000000214019"
},
"batch_number": {
"description": "Batch number.",
"type": "string",
"example": "BTC-TL-890"
},
"external_batch_number": {
"description": "External batch number from the manufacturer.",
"type": "string",
"example": "MFR-TL-890"
},
"manufacturer_date": {
"description": "Manufacturing date of the batch.",
"type": "string",
"example": "2026-05-12"
},
"expiry_date": {
"description": "Expiration date of the batch.",
"type": "string",
"example": "2026-12-24"
},
"out_quantity": {
"description": "Quantity removed from the batch.",
"type": "number",
"format": "float",
"example": 2
},
"storages": {
"description": "Bin/storage locations from which stock was issued for this batch.",
"type": "array",
"x-node_available_in": [
"Batch with Bin tracked items"
],
"items": {
"type": "object",
"properties": {
"storage_id": {
"description": "Unique identifier of the bin/storage location.",
"type": "string",
"example": "6780203000000093226"
},
"storage_name": {
"description": "Display name of the bin/storage location.",
"type": "string",
"example": "Bin A1"
},
"out_quantity": {
"description": "Quantity removed from the bin.",
"type": "number",
"format": "float",
"example": 2
},
"storage_out_id": {
"description": "Unique identifier of the storage entry on the line item.",
"type": "string",
"example": "6780203000000997441"
}
}
}
}
}
}
},
"storages-response": {
"description": "Bin/storage locations tracked for the line item. Returned for items with bin tracking enabled.",
"type": "array",
"items": {
"type": "object",
"properties": {
"storage_id": {
"description": "Unique identifier of the bin/storage location.",
"type": "string",
"example": "6780203000000093225"
},
"storage_name": {
"description": "Display name of the bin/storage location.",
"type": "string",
"example": "Bin A2"
},
"out_quantity": {
"description": "Quantity removed from the bin.",
"type": "number",
"format": "float",
"example": 2
},
"storage_out_id": {
"description": "Unique identifier of the storage entry on the line item.",
"type": "string",
"example": "6780203000000997440"
},
"serial_numbers": {
"description": "Serial numbers allocated to this bin.",
"type": "array",
"x-node_available_in": [
"Serial with Bin tracked items"
],
"items": {
"type": "string",
"example": "PKG-011"
}
}
}
}
},
"create-an-invoice-request": {
"required": [
"customer_id",
"line_items"
],
"type": "object",
"properties": {
"customer_id": {
"$ref": "#/components/schemas/customer_id"
},
"contact_persons_associated": {
"$ref": "#/components/schemas/contact_persons_associated_payload"
},
"invoice_number": {
"$ref": "#/components/schemas/invoice_number"
},
"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"
},
"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"
},
"project_id": {
"$ref": "#/components/schemas/project_id"
},
"line_items": {
"description": "Line items of an invoice.",
"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"
},
"time_entry_ids": {
"$ref": "#/components/schemas/time_entry_ids"
},
"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"
},
"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"
},
"item_total": {
"$ref": "#/components/schemas/item_total"
},
"salesorder_item_id": {
"$ref": "#/components/schemas/salesorder_item_id"
},
"location_id": {
"$ref": "#/components/schemas/location_id"
},
"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"
},
"mapped_items": {
"$ref": "#/components/schemas/mapped_items_create"
},
"serial_numbers": {
"$ref": "#/components/schemas/serial_numbers"
},
"batches": {
"$ref": "#/components/schemas/batches"
},
"storages": {
"$ref": "#/components/schemas/storages"
},
"item_custom_fields": {
"$ref": "#/components/schemas/item_custom_fields"
}
}
}
},
"location_id": {
"$ref": "#/components/schemas/location_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"
},
"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"
},
"billing_address_id": {
"$ref": "#/components/schemas/billing_address_id"
},
"shipping_address_id": {
"$ref": "#/components/schemas/shipping_address_id"
},
"gst_no": {
"$ref": "#/components/schemas/gst_no"
},
"gst_treatment": {
"$ref": "#/components/schemas/gst_treatment"
},
"place_of_supply": {
"$ref": "#/components/schemas/place_of_supply"
},
"cfdi_usage": {
"$ref": "#/components/schemas/cfdi_usage"
}
}
},
"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"
}
}
},
"list-invoices-response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0,
"readOnly": true
},
"message": {
"type": "string",
"example": "success",
"readOnly": true
},
"invoices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"invoice_id": {
"$ref": "#/components/schemas/invoice_id"
},
"ach_payment_initiated": {
"$ref": "#/components/schemas/ach_payment_initiated"
},
"customer_name": {
"$ref": "#/components/schemas/customer_name"
},
"customer_id": {
"$ref": "#/components/schemas/customer_id"
},
"status": {
"$ref": "#/components/schemas/status"
},
"invoice_number": {
"$ref": "#/components/schemas/invoice_number"
},
"reference_number": {
"$ref": "#/components/schemas/reference_number"
},
"date": {
"$ref": "#/components/schemas/date"
},
"due_date": {
"$ref": "#/components/schemas/due_date"
},
"due_days": {
"$ref": "#/components/schemas/due_days"
},
"currency_id": {
"$ref": "#/components/schemas/currency_id"
},
"schedule_time": {
"$ref": "#/components/schemas/schedule_time"
},
"currency_code": {
"$ref": "#/components/schemas/currency_code"
},
"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"
},
"total": {
"$ref": "#/components/schemas/total"
},
"balance": {
"$ref": "#/components/schemas/balance"
},
"created_time": {
"$ref": "#/components/schemas/created_time"
},
"last_modified_time": {
"$ref": "#/components/schemas/last_modified_time"
},
"is_emailed": {
"$ref": "#/components/schemas/is_emailed"
},
"reminders_sent": {
"$ref": "#/components/schemas/reminders_sent"
},
"last_reminder_sent_date": {
"$ref": "#/components/schemas/last_reminder_sent_date"
},
"payment_expected_date": {
"$ref": "#/components/schemas/payment_expected_date"
},
"last_payment_date": {
"$ref": "#/components/schemas/last_payment_date"
},
"custom_fields": {
"$ref": "#/components/schemas/custom_fields"
},
"documents": {
"$ref": "#/components/schemas/documents"
},
"location_id": {
"$ref": "#/components/schemas/location_id"
},
"location_name": {
"$ref": "#/components/schemas/location_name"
},
"salesperson_id": {
"$ref": "#/components/schemas/salesperson_id"
},
"salesperson_name": {
"$ref": "#/components/schemas/salesperson_name"
},
"shipping_charge": {
"$ref": "#/components/schemas/shipping_charge"
},
"adjustment": {
"$ref": "#/components/schemas/adjustment"
},
"write_off_amount": {
"$ref": "#/components/schemas/write_off_amount"
},
"exchange_rate": {
"$ref": "#/components/schemas/exchange_rate"
}
}
}
}
}
},
"update-an-invoice-request": {
"required": [
"customer_id",
"line_items"
],
"type": "object",
"properties": {
"customer_id": {
"$ref": "#/components/schemas/customer_id"
},
"contact_persons_associated": {
"$ref": "#/components/schemas/contact_persons_associated_payload"
},
"invoice_number": {
"$ref": "#/components/schemas/invoice_number"
},
"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"
},
"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"
},
"project_id": {
"$ref": "#/components/schemas/project_id"
},
"line_items": {
"description": "Line items of an invoice.",
"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"
},
"time_entry_ids": {
"$ref": "#/components/schemas/time_entry_ids"
},
"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"
},
"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"
},
"item_total": {
"$ref": "#/components/schemas/item_total"
},
"location_id": {
"$ref": "#/components/schemas/location_id"
},
"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"
},
"mapped_items": {
"$ref": "#/components/schemas/mapped_items_update"
},
"serial_numbers": {
"$ref": "#/components/schemas/serial_numbers"
},
"batches": {
"$ref": "#/components/schemas/batches-update"
},
"storages": {
"$ref": "#/components/schemas/storages-update"
},
"item_custom_fields": {
"$ref": "#/components/schemas/item_custom_fields"
}
}
}
},
"location_id": {
"$ref": "#/components/schemas/location_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"
},
"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"
},
"billing_address_id": {
"$ref": "#/components/schemas/billing_address_id"
},
"shipping_address_id": {
"$ref": "#/components/schemas/shipping_address_id"
},
"gst_no": {
"$ref": "#/components/schemas/gst_no"
},
"gst_treatment": {
"$ref": "#/components/schemas/gst_treatment"
},
"place_of_supply": {
"$ref": "#/components/schemas/place_of_supply"
},
"cfdi_usage": {
"$ref": "#/components/schemas/cfdi_usage"
},
"cfdi_reference_type": {
"$ref": "#/components/schemas/cfdi_reference_type"
},
"reference_invoice_id": {
"$ref": "#/components/schemas/reference_invoice_id"
}
}
},
"update-an-invoice-response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0,
"readOnly": true
},
"message": {
"type": "string",
"example": "Invoice information has been updated.",
"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"
},
"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": {
"description": "Items listed in invoice",
"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"
},
"time_entry_ids": {
"$ref": "#/components/schemas/time_entry_ids"
},
"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"
},
"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"
},
"item_total": {
"$ref": "#/components/schemas/item_total"
},
"location_id": {
"$ref": "#/components/schemas/location_id"
},
"location_name": {
"$ref": "#/components/schemas/location_name"
},
"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_combo_product": {
"$ref": "#/components/schemas/is_combo_product"
},
"combo_type": {
"$ref": "#/components/schemas/combo_type"
},
"mapped_items": {
"$ref": "#/components/schemas/mapped_items"
},
"serial_numbers": {
"$ref": "#/components/schemas/serial_numbers"
},
"batches": {
"$ref": "#/components/schemas/batches-response"
},
"storages": {
"$ref": "#/components/schemas/storages-response"
},
"item_custom_fields": {
"$ref": "#/components/schemas/item_custom_fields"
}
}
}
},
"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"
},
"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"
},
"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/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"
},
"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"
},
"invoice_url": {
"$ref": "#/components/schemas/invoice_url"
},
"is_pre_gst": {
"$ref": "#/components/schemas/is_pre_gst"
},
"gst_no": {
"$ref": "#/components/schemas/gst_no"
},
"gst_treatment": {
"$ref": "#/components/schemas/gst_treatment"
},
"place_of_supply": {
"$ref": "#/components/schemas/place_of_supply"
},
"tax_treatment": {
"$ref": "#/components/schemas/tax_treatment"
},
"cfdi_usage": {
"$ref": "#/components/schemas/cfdi_usage"
},
"cfdi_reference_type": {
"$ref": "#/components/schemas/cfdi_reference_type"
},
"reference_invoice_id": {
"$ref": "#/components/schemas/reference_invoice_id"
}
}
}
}
},
"get-an-invoice-response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0,
"readOnly": true
},
"message": {
"type": "string",
"example": "success",
"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"
},
"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": {
"description": "Items listed in invoice",
"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"
},
"time_entry_ids": {
"$ref": "#/components/schemas/time_entry_ids"
},
"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"
},
"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"
},
"location_id": {
"$ref": "#/components/schemas/location_id"
},
"location_name": {
"$ref": "#/components/schemas/location_name"
},
"hsn_or_sac": {
"$ref": "#/components/schemas/hsn_or_sac"
},
"is_combo_product": {
"$ref": "#/components/schemas/is_combo_product"
},
"combo_type": {
"$ref": "#/components/schemas/combo_type"
},
"mapped_items": {
"$ref": "#/components/schemas/mapped_items"
},
"serial_numbers": {
"$ref": "#/components/schemas/serial_numbers"
},
"batches": {
"$ref": "#/components/schemas/batches-response"
},
"storages": {
"$ref": "#/components/schemas/storages-response"
},
"item_custom_fields": {
"$ref": "#/components/schemas/item_custom_fields"
}
}
}
},
"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"
},
"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"
},
"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/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"
},
"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"
},
"invoice_url": {
"$ref": "#/components/schemas/invoice_url"
},
"is_pre_gst": {
"$ref": "#/components/schemas/is_pre_gst"
},
"gst_no": {
"$ref": "#/components/schemas/gst_no"
},
"gst_treatment": {
"$ref": "#/components/schemas/gst_treatment"
},
"place_of_supply": {
"$ref": "#/components/schemas/place_of_supply"
},
"cfdi_usage": {
"$ref": "#/components/schemas/cfdi_usage"
},
"tax_treatment": {
"$ref": "#/components/schemas/tax_treatment"
}
}
}
}
},
"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
}
}
},
"mark-an-invoice-as-sent-response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0,
"readOnly": true
},
"message": {
"type": "string",
"example": "Invoice status has been changed to Sent.",
"readOnly": true
}
}
},
"void-an-invoice-response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0,
"readOnly": true
},
"message": {
"type": "string",
"example": "Invoice status has been changed to Void.",
"readOnly": true
}
}
},
"mark-as-draft-response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0,
"readOnly": true
},
"message": {
"type": "string",
"example": "Status of invoice changed from void to draft",
"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"
},
"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
}
}
},
"get-invoice-email-content-response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0,
"readOnly": true
},
"message": {
"type": "string",
"example": "success",
"readOnly": true
},
"data": {
"description": "content of the emails",
"type": "object",
"properties": {
"bcc_mails": {
"$ref": "#/components/schemas/bcc_mails"
},
"gateways_configured": {
"$ref": "#/components/schemas/gateways_configured"
},
"gateways_associated": {
"$ref": "#/components/schemas/gateways_associated"
},
"bcc_mails_str": {
"$ref": "#/components/schemas/bcc_mails_str"
},
"body": {
"$ref": "#/components/schemas/body"
},
"documents": {
"$ref": "#/components/schemas/documents"
},
"customer_name": {
"$ref": "#/components/schemas/customer_name"
},
"attach_pdf": {
"$ref": "#/components/schemas/attach_pdf"
},
"entity_id": {
"$ref": "#/components/schemas/entity_id"
},
"cc_mails_list": {
"description": "recepients of the mail who are CC'd",
"type": "array",
"items": {
"type": "object",
"properties": {
"user_name": {
"$ref": "#/components/schemas/user_name"
},
"email": {
"$ref": "#/components/schemas/email"
}
}
}
},
"file_name_without_extension": {
"$ref": "#/components/schemas/file_name_without_extension"
},
"to_mails_str": {
"$ref": "#/components/schemas/to_mails_str"
},
"cc_mails_str": {
"$ref": "#/components/schemas/cc_mails_str"
},
"from_email": {
"$ref": "#/components/schemas/from_email"
},
"from_address": {
"$ref": "#/components/schemas/from_address"
},
"deprecated_placeholders_used": {
"$ref": "#/components/schemas/deprecated_placeholders_used"
},
"error_list": {
"$ref": "#/components/schemas/error_list"
},
"subject": {
"$ref": "#/components/schemas/subject"
},
"emailtemplates": {
"description": "Templates used to mail",
"type": "array",
"items": {
"type": "object",
"properties": {
"selected": {
"description": "To check if invoice is selected",
"type": "boolean",
"example": true
},
"name": {
"description": "name of te invoice",
"type": "string",
"example": "Default"
},
"email_template_id": {
"description": "ID of the email template used",
"type": "string",
"example": "982000000000067"
}
}
}
},
"emailtemplate_documents": {
"$ref": "#/components/schemas/emailtemplate_documents"
},
"to_contacts": {
"description": "Recepients of the mail",
"type": "array",
"items": {
"type": "object",
"properties": {
"first_name": {
"$ref": "#/components/schemas/first_name"
},
"selected": {
"$ref": "#/components/schemas/selected"
},
"phone": {
"$ref": "#/components/schemas/phone"
},
"email": {
"$ref": "#/components/schemas/email"
},
"last_name": {
"$ref": "#/components/schemas/last_name"
},
"salutation": {
"$ref": "#/components/schemas/salutation"
},
"contact_person_id": {
"$ref": "#/components/schemas/contact_person_id"
},
"mobile": {
"$ref": "#/components/schemas/mobile"
}
}
}
},
"attachment_name": {
"$ref": "#/components/schemas/attachment_name"
},
"file_name": {
"$ref": "#/components/schemas/file_name"
},
"from_emails": {
"description": "Sender's email address",
"type": "array",
"items": {
"type": "object",
"properties": {
"user_name": {
"$ref": "#/components/schemas/user_name"
},
"selected": {
"$ref": "#/components/schemas/selected"
},
"email": {
"$ref": "#/components/schemas/email"
},
"organization_contact_id": {
"$ref": "#/components/schemas/organization_contact_id"
},
"is_org_email_id": {
"$ref": "#/components/schemas/is_org_email_id"
}
}
}
},
"customer_id": {
"$ref": "#/components/schemas/customer_id"
}
}
}
}
},
"email-invoices-response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0,
"readOnly": true
},
"message": {
"type": "string",
"example": "Mission accomplished! We've sent all the invoices.",
"readOnly": true
}
}
},
"get-payment-reminder-mail-content-response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0,
"readOnly": true
},
"message": {
"type": "string",
"example": "success",
"readOnly": true
},
"data": {
"description": "Date of the email",
"type": "object",
"properties": {
"bcc_mails": {
"$ref": "#/components/schemas/bcc_mails"
},
"gateways_configured": {
"$ref": "#/components/schemas/gateways_configured"
},
"gateways_associated": {
"$ref": "#/components/schemas/gateways_associated"
},
"bcc_mails_str": {
"$ref": "#/components/schemas/bcc_mails_str"
},
"body": {
"description": "content of email sent",
"type": "string",
"example": "
Dear Mr. John,
You might have missed the payment date and the invoice is now overdue by 1 days.
----------------------------------------------------------------------------------------
Variants: due_date_start, due_date_end, due_date_before and due_date_after.",
"type": "string",
"example": "2013-11-18"
},
"reference_number": {
"description": "Reference number of the invoice",
"type": "string",
"example": 99782374
},
"exchange_rate": {
"description": "Foreign exchange rate used",
"type": "number",
"format": "float",
"example": 1
},
"amount": {
"description": "Invoice amount",
"type": "number",
"format": "float",
"example": 10.57
},
"tax_amount_withheld": {
"description": "Amount of tax held",
"type": "number",
"format": "float",
"example": 0
},
"online_transaction_id": {
"$ref": "#/components/schemas/online_transaction_id"
},
"is_single_invoice_payment": {
"description": "To check if payment is single",
"type": "boolean",
"example": true
}
}
}
}
}
},
"list-credits-applied-response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0,
"readOnly": true
},
"message": {
"type": "string",
"example": "success",
"readOnly": true
},
"credits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"creditnote_id": {
"$ref": "#/components/schemas/creditnote_id"
},
"creditnotes_invoice_id": {
"$ref": "#/components/schemas/creditnotes_invoice_id"
},
"creditnotes_number": {
"$ref": "#/components/schemas/creditnotes_number"
},
"credited_date": {
"$ref": "#/components/schemas/credited_date"
},
"amount_applied": {
"$ref": "#/components/schemas/amount_applied"
}
}
}
}
}
},
"apply-credits-request": {
"type": "object",
"properties": {
"invoice_payments": {
"description": "Invoice payment list",
"type": "array",
"items": {
"type": "object",
"properties": {
"payment_id": {
"description": "ID of the payment from which credit has to be applied.",
"type": "string",
"example": 460000000031003
},
"amount_applied": {
"description": "Amount applied to the invoice.",
"type": "number",
"format": "float",
"example": 15
}
}
}
},
"apply_creditnotes": {
"description": "Apply existing credit note of a customer against the invoice",
"type": "array",
"items": {
"type": "object",
"properties": {
"creditnote_id": {
"description": "ID of the credit note from which credit has to be applied.",
"type": "string",
"example": 460000000029003
},
"amount_applied": {
"description": "Amount applied to the invoice.",
"type": "number",
"format": "float",
"example": 22.5
}
}
}
}
}
},
"apply-credits-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
}
}
},
"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-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
}
}
},
"get-an-invoice-attachment-response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0,
"readOnly": true
},
"message": {
"type": "string",
"example": "success",
"readOnly": true
}
}
},
"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
}
}
},
"update-attachment-preference-response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0,
"readOnly": true
},
"message": {
"type": "string",
"example": "Invoice information has been updated.",
"readOnly": true
}
}
},
"delete-an-attachment-response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0,
"readOnly": true
},
"message": {
"type": "string",
"example": "Your file is no longer attached to the invoice.",
"readOnly": true
}
}
},
"list-invoice-comments-and-history-response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0,
"readOnly": true
},
"message": {
"type": "string",
"example": "success",
"readOnly": true
},
"comments": {
"description": "Comments made",
"type": "array",
"items": {
"type": "object",
"properties": {
"comment_id": {
"description": "The ID of the comment",
"type": "string",
"example": 982000000567019
},
"invoice_id": {
"$ref": "#/components/schemas/invoice_id"
},
"description": {
"$ref": "#/components/schemas/description"
},
"commented_by_id": {
"description": "ID of comment made",
"type": "string",
"example": 982000000554041
},
"commented_by": {
"description": "User who added comment",
"type": "string",
"example": "John David"
},
"comment_type": {
"description": "type of comment made",
"type": "string",
"example": "system"
},
"operation_type": {
"description": "Tyoe of operation done on invoice",
"type": "string",
"example": "Added"
},
"date": {
"description": "Date of transaction",
"type": "string",
"example": "2013-11-18"
},
"date_description": {
"description": "Date of description",
"type": "string",
"example": "yesterday"
},
"time": {
"description": "Time of comment",
"type": "string",
"example": "2:38 AM"
},
"transaction_id": {
"description": "Unique ID of transaction made",
"type": "string",
"example": "982000000567204"
},
"transaction_type": {
"description": "Type of transaction",
"type": "string",
"example": "invoice"
}
}
}
}
}
},
"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"
}
}
},
"add-comment-response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0,
"readOnly": true
},
"message": {
"type": "string",
"example": "Comments added.",
"readOnly": true
}
}
},
"update-a-comment-request": {
"type": "object",
"properties": {
"description": {
"description": "The description of the comment.",
"type": "string",
"example": "This is a comment."
},
"show_comment_to_clients": {
"$ref": "#/components/schemas/show_comment_to_clients"
}
}
},
"update-comment-response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0,
"readOnly": true
},
"message": {
"type": "string",
"example": "success",
"readOnly": true
},
"comment_id": {
"$ref": "#/components/schemas/comment_id"
},
"invoice_id": {
"$ref": "#/components/schemas/invoice_id"
},
"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"
},
"comment_type": {
"$ref": "#/components/schemas/comment_type"
}
}
},
"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
}
}
},
"approval-action-response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 0,
"readOnly": true
},
"message": {
"type": "string",
"example": "success",
"readOnly": true
}
}
},
"reject-request": {
"type": "object",
"properties": {
"reason": {
"description": "Reason for rejecting the invoice. Max-length [500].",
"type": "string",
"example": "Invoice amount exceeds approved budget."
}
}
}
}
}