Invoices

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.

Attribute

• invoice_idstring

  The ID of the invoice

• ach_payment_initiatedboolean

  To check initiation of ACH Payment

• invoice_numberstring

  An unique number given to the invoice. Maximum length [100]

• datestring

  invoice date. Default date format is yyyy-mm-dd.

• statusstring

  Search invoices by invoice status.Allowed Values: sent, draft, overdue, paid, void, unpaid, partially_paid and viewed

• payment_termsinteger

  Payment terms in days e.g. 15, 30, 60. Invoice due date will be calculated based on this. Maximum length [100]

• payment_terms_labelstring

  Used to override the default payment terms label. Default value for 15 days is "Net 15 Days". Maximum length [100]

• due_datestring

  due date of the invoices. Default date format is yyyy-mm-dd.

• payment_expected_datestring

  The expected date of payment

• last_payment_datestring

  The last payment date of the invoice

• reference_numberstring

  The reference number of the invoice

• customer_idstring

  ID of the customer the invoice has to be created.

• customer_namestring

  The name of the customer. Maximum length [100]

• contact_personsarray

  Show Sub-Attributes

  • contact_person_idstring

    Unique ID of the contact person

  • salutationstring

    Salutation to the contact

  • first_namestring

    First name of the contact

  • last_namestring

    Last name of the contact

  • email 

    contact's email id. Maximum length [100]

  • phonestring

    Phone number of the contact

  • mobilestring

    Mobile number of the contact person

  • is_primary_contact 

    To mark contact person as primary for contact

• currency_idstring

  The currenct id of the currency

• currency_codestring

  The currency code in which the invoice is created.

• exchange_ratefloat

  Exchange rate of the currency.

• discountfloat

  Discount applied to the invoice. It can be either in % or in amount. e.g. 12.5% or 190. Maximum length [100]

• is_discount_before_taxboolean

  Check if discount is exclusive of tax

• discount_typestring

  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.

• is_inclusive_taxboolean

  To check if discount is inclusive of tax

• recurring_invoice_idstring

  ID of the recurring invoice from which the invoice is created.

• is_viewed_by_clientboolean

  Check if invoice is viewed by client

• has_attachmentboolean

  To check if invoice has an attachment

• client_viewed_timestring

  Time when client viewed the statement

• line_itemsarray

  Items listed in invoice

  Show Sub-Attributes

  • line_item_idstring

    The line item ID

  • item_idstring

    Unique item id.

  • project_idstring

    Unique ID of the projet associated to an invoice

  • time_entry_idsstring

    Unique ID's of all the time entries associated to the linked project

  • expense_idstring

    Unique ID of the expenses associated

  • expense_receipt_namestring

    Name of the expense receipt associated

  • namestring

    The name of the line item. Maximum length [100]

  • descriptionstring

    The description of the line items. Maximum length [2000]

  • item_orderinteger

    The order of the line item_order

  • bcy_ratefloat

    base currency rate

  • ratedouble

    Rate of the line item.

  • quantityfloat

    The quantity of line item

  • unitstring

    Unit of the line item e.g. kgs, Nos. Maximum length [100]

  • discount_amountfloat

    The discount amount on the line item

  • discountfloat

    Discount applied to the invoice. It can be either in % or in amount. e.g. 12.5% or 190. Maximum length [100]

  • tax_idstring

    ID of the tax or tax group applied to the estimate

  • tax_namestring

    The name of the tax

  • tax_typestring

    The type of the tax

  • tax_percentagefloat

    The percentage of tax levied

  • item_totalfloat

    The total amount of the line items

  • warehouse_idlong

    Unique ID generated by the server for the ware houses

  • hsn_or_sacstring

    Add HSN/SAC code for your goods/services

• shipping_chargestring

  Shipping charges applied to the invoice. Maximum length [100]

• adjustmentdouble

  Adjustments made to the invoice.

• adjustment_descriptionstring

  Customize the adjustment description. E.g. Rounding off.

• sub_totalfloat

  The sub total of the all items

• tax_totaldouble

  The total amount of the tax levied

• totalstring

  The total amount to be paid

• taxesarray

  List of the taxes levied

  Show Sub-Attributes

  • tax_namestring

    The name of the tax

  • tax_amountfloat

    The amount of the tax levied

• payment_reminder_enabledboolean

  Boolean to check if reminders have been enabled

• payment_madefloat

  The amount paid

• credits_appliedfloat

  The credits applied

• tax_amount_withheldfloat

  The tax amount which has been withheld

• balancestring

  The unpaid amount

• write_off_amountfloat

  The write off amount. i.e. the amount which is not expected to be returned. Like a bad debt

• allow_partial_paymentsboolean

  Boolean to check if partial payments are allowed for the contact

• price_precisioninteger

  The precision value on the price

• payment_optionsobject

  Payment options available for payment

  Show Sub-Attributes

  • payment_gatewaysarray

    Payment gateways integrated and supported

    Show Sub-Attributes

    • configuredboolean

      Boolean check to see if a payment gateway has been configured

    • additional_field1string

      Paypal payment method. Allowed Values: standard and adaptive

    • gateway_namestring

      Name of the payment gateway associated with the invoice. E.g. paypal, stripe.Allowed Values: paypal, authorize_net, payflow_pro, stripe, 2checkout and braintree

• is_emailedboolean

  Boolean check to see if the mail has been sent

• reminders_sentinteger

  The number of reminders sent

• last_reminder_sent_datestring

  The date the last email was sent

• billing_addressobject

  Billing address of the contact

  Show Sub-Attributes

  • addressstring

    Billing address for the invoice

  • citystring

    City of the customer’s billing address.

  • statestring

    State of the customer’s billing address.

  • zipstring

    Zip code of the customer’s billing address.

  • faxstring

    Customer's fax number.

• shipping_addressobject

  Shipping address of the contact

  Show Sub-Attributes

  • addressstring

    Billing address for the invoice

  • citystring

    City of the customer’s billing address.

  • statestring

    State of the customer’s billing address.

  • zipstring

    Zip code of the customer’s billing address.

  • faxstring

    Customer's fax number.

• notesstring

  The notes added below expressing gratitude or for conveying some information.

• termsstring

  The terms added below expressing gratitude or for conveying some information.

• custom_fieldsarray

  Additional fields added to the invoice

  Show Sub-Attributes

  • indexinteger

    The index of the custom field

  • show_on_pdfboolean

    Boolean value to check if the custom field is to be dispplayed on the pdf.

  • valuestring

    Value of the custom field like VAT Id etc.

  • labelstring

    The label of the custom field.

• template_idstring

  ID of the pdf template associated with the invoice.

• template_namestring

  Name of the invoice template used

• created_timestring

  The time of creation of the invoices

• last_modified_timestring

  Date of last modification of the invoice

• attachment_namestring

  Name of the file attached

• can_send_in_mailboolean

  To check if attachment can be sent in email

• salesperson_idstring

  ID of the salesperson linked to invoice

• salesperson_namestring

  Name of the salesperson. Maximum length [200]

• invoice_urlstring

  Url of invoice as a link

• is_pre_gstboolean

  Applicable for transactions that fall before july 1, 2017

• gst_nostring

  15 digit GST identification number of the customer.

• gst_treatmentstring

  Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .

Create an invoice

Create an invoice for your customer.

OAuth Scope : ZakyaAPI.invoices.CREATE

Query Parameters

• customer_idstring (Required)

  ID of the customer the invoice has to be created.

• contact_personsarray

  Show Sub-Attributes

  • contact_person_idstring

    Unique ID of the contact person

  • salutationstring

    Salutation to the contact

  • first_namestring

    First name of the contact

  • last_namestring

    Last name of the contact

  • emailcontact's email id. Maximum length [100]

    phone

  • stringPhone number of the contact

    mobile

  • stringMobile number of the contact person

    undefined

• invoice_numberstring

  An unique number given to the invoice. Maximum length [100]

• reference_numberstring

  The reference number of the invoice

• template_idstring

  ID of the pdf template associated with the invoice.

• datestring

  invoice date. Default date format is yyyy-mm-dd.

• payment_termsinteger

  Payment terms in days e.g. 15, 30, 60. Invoice due date will be calculated based on this. Maximum length [100]

• payment_terms_labelstring

  Used to override the default payment terms label. Default value for 15 days is "Net 15 Days". Maximum length [100]

• due_datestring

  due date of the invoices. Default date format is yyyy-mm-dd.

• discountfloat

  Discount applied to the invoice. It can be either in % or in amount. e.g. 12.5% or 190. Maximum length [100]

• is_discount_before_taxboolean

  Check if discount is exclusive of tax

• discount_typestring

  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.

• is_inclusive_taxboolean

  To check if discount is inclusive of tax

• exchange_ratefloat

  Exchange rate of the currency.

• recurring_invoice_idstring

  ID of the recurring invoice from which the invoice is created.

• invoiced_estimate_idstring

  ID of the invoice from which the invoice is created.

• salesperson_namestring

  Name of the salesperson. Maximum length [200]

• custom_fieldsarray

  Additional fields added to the invoice

  Show Sub-Attributes

  • indexinteger

    The index of the custom field

  • show_on_pdfboolean

    Boolean value to check if the custom field is to be dispplayed on the pdf.

  • valuestring

    Value of the custom field like VAT Id etc.

  • labelstring

    The label of the custom field.

• project_idstring

  Unique ID of the projet associated to an invoice

• line_itemsarray (Required)

  Line items of an invoice.

  Show Sub-Attributes

  • line_item_idstring

    The line item ID

  • item_idstring

    Unique item id.

  • project_idstring

    Unique ID of the projet associated to an invoice

  • time_entry_idsstring

    Unique ID's of all the time entries associated to the linked project

  • expense_idstring

    Unique ID of the expenses associated

  • expense_receipt_namestring

    Name of the expense receipt associated

  • namestring

    The name of the line item. Maximum length [100]

  • descriptionstring

    The description of the line items. Maximum length [2000]

  • item_orderinteger

    The order of the line item_order

  • bcy_ratefloat

    base currency rate

  • ratedouble

    Rate of the line item.

  • quantityfloat

    The quantity of line item

  • unitstring

    Unit of the line item e.g. kgs, Nos. Maximum length [100]

  • discount_amountfloat

    The discount amount on the line item

  • discountfloat

    Discount applied to the invoice. It can be either in % or in amount. e.g. 12.5% or 190. Maximum length [100]

  • tax_idstring

    ID of the tax or tax group applied to the estimate

  • tax_namestring

    The name of the tax

  • tax_typestring

    The type of the tax

  • tax_percentagefloat

    The percentage of tax levied

  • item_totalfloat

    The total amount of the line items

  • salesorder_item_idlong

    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

  • warehouse_idlong

    Unique ID generated by the server for the ware houses

  • hsn_or_sacstring

    Add HSN/SAC code for your goods/services

• payment_optionsobject

  Payment options available for payment

  Show Sub-Attributes

  • payment_gatewaysarray

    Payment gateways integrated and supported

    Show Sub-Attributes

    • configuredboolean

      Boolean check to see if a payment gateway has been configured

    • additional_field1string

      Paypal payment method. Allowed Values: standard and adaptive

    • gateway_namestring

      Name of the payment gateway associated with the invoice. E.g. paypal, stripe.Allowed Values: paypal, authorize_net, payflow_pro, stripe, 2checkout and braintree

• allow_partial_paymentsboolean

  Boolean to check if partial payments are allowed for the contact

• custom_bodystring

  Customized email content

• custom_subjectstring

  Customized Subject line

• notesstring

  The notes added below expressing gratitude or for conveying some information.

• termsstring

  The terms added below expressing gratitude or for conveying some information.

• shipping_chargestring

  Shipping charges applied to the invoice. Maximum length [100]

• adjustmentdouble

  Adjustments made to the invoice.

• adjustment_descriptionstring

  Customize the adjustment description. E.g. Rounding off.

• reasonstring

  Description of the attachment

• tax_exemption_idstring

  ID of the tax exemption.

• billing_address_idlong

  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

• shipping_address_idlong

  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

• gst_nostring

  15 digit GST identification number of the customer.

• gst_treatmentstring

  Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst, business_none, overseas, consumer.

Query Parameters

• send 

  Send the invoice to the contact person(s) associated with the invoice. Allowed values true and false.

• ignore_auto_number_generation 

  Ignore auto invoice number generation for this invoice. This mandates the invoice number. Allowed values true and false

List invoices

List all invoices with pagination.

OAuth Scope : ZakyaAPI.invoices.READ

Query Parameters

• nvoice_number 

  An unique number given to the invoice. Maximum length [100]

• item_name 

  item name.Variants: item_name_startswith and item_name_contains. Maximum length [100]

• item_id 

  Unique item id.

• item_description 

  Search invoices by item description.Variants: item_description_startswith and item_description_contains. Maximum length [100]

• reference_number 

  The reference number of the invoice

• customer_name 

  The name of the customer. Maximum length [100]

• recurring_invoice_id 

  ID of the recurring invoice from which the invoice is created.

• email 

  contact's email id. Maximum length [100]

• total 

  The total amount to be paid

• balance 

  The unpaid amount

• custom_field 

  custom fields for invoice. Variants: custom_field_startswith and custom_field_contains

• date 

  invoice date. Default date format is yyyy-mm-dd. Variants: due_date_start, due_date_end, due_date_before and due_date_after.

• due_date 

  due date of the invoices. Default date format is yyyy-mm-dd. Variants: due_date_start, due_date_end, due_date_before and due_date_after

• status 

  Search invoices by invoice status.Allowed Values: sent, draft, overdue, paid, void, unpaid, partially_paid and viewed

• customer_id 

  ID of the customer the invoice has to be created.

• filter_by 

  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

• search_text 

  Search invoices by invoice number or purchase order or customer name. Maximum length [100]

• sort_column 

  Sort invoices.Allowed Values: customer_name, invoice_number, date, due_date, total, balance and created_time

Update an invoice

Update an existing invoice. To delete a line item just remove it from the line_items list.

OAuth Scope : ZakyaAPI.invoices.UPDATE

Arguments

• customer_idstring (Required)

  ID of the customer the invoice has to be created.

• contact_personsarray

  Show Sub-Attributes

  • contact_person_idstring

    Unique ID of the contact person

  • salutationstring

    Salutation to the contact

  • first_namestring

    First name of the contact

  • last_namestring

    Last name of the contact

  • email 

    contact's email id. Maximum length [100]

  • phonestring

    Phone number of the contact

  • mobilestring

    Mobile number of the contact person

  • is_primary_contactTo mark contact person as primary for contact

    undefined

• invoice_numberstring

  An unique number given to the invoice. Maximum length [100]

• reference_numberstring

  The reference number of the invoice

• template_idstring

  ID of the pdf template associated with the invoice.

• datestring

  invoice date. Default date format is yyyy-mm-dd.

• payment_termsinteger

  Payment terms in days e.g. 15, 30, 60. Invoice due date will be calculated based on this. Maximum length [100]

• payment_terms_labelstring

  Used to override the default payment terms label. Default value for 15 days is "Net 15 Days". Maximum length [100]

• due_datestring

  due date of the invoices. Default date format is yyyy-mm-dd.

• discountfloat

  Discount applied to the invoice. It can be either in % or in amount. e.g. 12.5% or 190. Maximum length [100]

• is_discount_before_taxboolean

  Check if discount is exclusive of tax

• discount_typestring

  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.

• is_inclusive_taxboolean

  To check if discount is inclusive of tax

• exchange_ratefloat

  Exchange rate of the currency.

• recurring_invoice_idstring

  ID of the recurring invoice from which the invoice is created.

• invoiced_estimate_idstring

  ID of the invoice from which the invoice is created.

• salesperson_namestring

  Name of the salesperson. Maximum length [200]

• custom_fieldsarray

  Additional fields added to the invoice

  Show Sub-Attributes

  • indexinteger

    The index of the custom field

  • show_on_pdfboolean

    Boolean value to check if the custom field is to be dispplayed on the pdf.

  • valuestring

    Value of the custom field like VAT Id etc.

  • labelstring

    The label of the custom field.

• project_idstring

  Unique ID of the projet associated to an invoice

• line_itemsarray (Required)

  Line items of an invoice.

  Show Sub-Attributes

  • line_item_idstring

    The line item ID

  • item_idstring

    Unique item id.

  • project_idstring

    Unique ID of the projet associated to an invoice

  • time_entry_idsstring

    Unique ID's of all the time entries associated to the linked project

  • expense_idstring

    Unique ID of the expenses associated

  • expense_receipt_namestring

    Name of the expense receipt associated

  • namestring

    The name of the line item. Maximum length [100]

  • descriptionstring

    The description of the line items. Maximum length [2000]

  • item_orderinteger

    The order of the line item_order

  • bcy_ratefloat

    base currency rate

  • ratedouble

    Rate of the line item.

  • quantityfloat

    The quantity of line item

  • unitstring

    Unit of the line item e.g. kgs, Nos. Maximum length [100]

  • discount_amountfloat

    The discount amount on the line item

  • discountfloat

    Discount applied to the invoice. It can be either in % or in amount. e.g. 12.5% or 190. Maximum length [100]

  • tax_idstring

    ID of the tax or tax group applied to the estimate

  • tax_namestring

    The name of the tax

  • tax_typestring

    The type of the tax

  • tax_percentagefloat

    The percentage of tax levied

  • item_totalfloat

    The total amount of the line items

  • warehouse_idlong

    Unique ID generated by the server for the ware houses

  • hsn_or_sacstring

    Add HSN/SAC code for your goods/services

• payment_optionsobject

  Payment options available for payment

  Show Sub-Attributes

  • payment_gatewaysarray

    Payment gateways integrated and supported

    Show Sub-Attributes

    • configuredboolean

      Boolean check to see if a payment gateway has been configured

    • additional_field1string

      Paypal payment method. Allowed Values: standard and adaptive

    • gateway_namestring

      Name of the payment gateway associated with the invoice. E.g. paypal, stripe.Allowed Values: paypal, authorize_net, payflow_pro, stripe, 2checkout and braintree

• allow_partial_paymentsboolean

  Boolean to check if partial payments are allowed for the contact

• custom_bodystring

  Customized email content

• custom_subjectstring

  Customized Subject line

• notesstring

  The notes added below expressing gratitude or for conveying some information.

• termsstring

  The terms added below expressing gratitude or for conveying some information.

• shipping_chargestring

  Shipping charges applied to the invoice. Maximum length [100]

• adjustmentdouble

  Adjustments made to the invoice.

• adjustment_descriptionstring

  Customize the adjustment description. E.g. Rounding off.

• reasonstring

  Description of the attachment

• tax_exemption_idstring

  ID of the tax exemption.

• billing_address_idlong

  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

• shipping_address_idlong

  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

• gst_nostring

  15 digit GST identification number of the customer.

• gst_treatmentstring

  Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .

Query Parameters

• ignore_auto_number_generation 

  Ignore auto invoice number generation for this invoice. This mandates the invoice number. Allowed values true and false

Get an invoice

Get the details of an invoice.

OAuth Scope : ZakyaAPI.invoices.READ

Query Parameters

• print 

  Print the exported pdf.

• accept 

  Get the details of a particular invoice in formats such as json/ pdf/ html. Default format is json. Allowed values json pdf and html

Email an invoice

Email an invoice to the customer. Input json string is not mandatory. If input json string is empty, mail will be send with default mail content.

OAuth Scope : ZakyaAPI.invoices.CREATE

Arguments

• send_from_org_email_idboolean

  Boolean to trigger the email from the organization's email address

• to_mail_idsarray (Required)

  Array of email addresses of the recipients.

• cc_mail_idsarray

  Array of email addresses of the recipients to be CC'd.

• subjectstring

  The subject of the mail

• bodystring

  The body/content of the mail

Query Parameters

• send_customer_statement 

  Send customer statement pdf a with email.

• send_attachment 

  Send the invoice attachment a with the email.

• attachments 

  Files to be attached to the email

Get invoice email content

Get the email content of an invoice.

OAuth Scope : ZakyaAPI.invoices.READ

Query Parameters

• email_template_id 

  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.

Email invoices

Send invoices to your customers by email. Maximum of 10 invoices can be sent at once.

OAuth Scope : ZakyaAPI.invoices.CREATE

Query Parameters

• invoice_ids (Required) 

  Comma separated invoice ids which are to be emailed.

Get payment reminder mail content

Get the mail content of the payment reminder.

OAuth Scope : ZakyaAPI.invoices.READ