Invoices
Invoices describe how much a customer owes for his subscription. Invoices are created for recurring charges, one time charges including any prorated adjustments.
Attribute
place of contact
given for the contact will be taken) business_gst
, business_none
, overseas
, consumer
.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX.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
.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
, if he resides outside of the UK then his VAT treatment is overseas
(For Pre Brexit, this can be split as eu_vat_registered
, eu_vat_not_registered
and non_eu
).paid
, sent
, overdue
, partially_paid
or void
.Maximum length [100]
Maximum length [100]
overdue
. If the invoice is only partially paid, its status will be partially_paid
.Maximum length [100]
entity_level
and item_level
.Maximum length [100]
Maximum length [100]
Maximum length [100]
standard
and adaptive
paypal
, authorize_net
, payflow_pro
, stripe
, 2checkout
and braintree
street
, city
, state
,zip
and country
.street
, city
, state
,zip
and country
.Create an invoice
Create an invoice for your customer.
OAuth Scope : ZohoSubscriptions.invoices.CREATE
Arguments
place of contact
given for the contact will be taken)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
, if he resides outside of the UK then his VAT treatment is overseas
(For Pre Brexit, this can be split as eu_vat_registered
, eu_vat_not_registered
and non_eu
). business_gst
, business_none
, overseas
, consumer
.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX.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
.Maximum length [100]
Maximum length [100]
overdue
. If the invoice is only partially paid, its status will be partially_paid
.Maximum length [100]
entity_level
and item_level
.Maximum length [100]
Maximum length [100]
Maximum length [25]
Maximum length [25]
standard
and adaptive
paypal
, authorize_net
, payflow_pro
, stripe
, 2checkout
and braintree
Maximum length [100]
Maximum length [25]
Maximum length [25]
Maximum length [25]
Query Parameters
true
and false
.true
and false
List all invoices
List of all invoices.
To list invoices for a particular subscription or customer append a param as subscription_id={subscription_id}
or customer_id={customer_id}
.
OAuth Scope : ZohoSubscriptions.invoices.READ
Query Parameters
filter_by
. Allowed values are Status.(All
, Sent
, Draft
, OverDue
, Paid
, PartiallyPaid
, Void
, Unpaid
).Update an invoice
Update an existing invoice. To delete a line item just remove it from the invoice_items list.
OAuth Scope : ZohoSubscriptions.invoices.UPDATE
Arguments
place of contact
given for the contact will be taken)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
, if he resides outside of the UK then his VAT treatment is overseas
(For Pre Brexit, this can be split as eu_vat_registered
, eu_vat_not_registered
and non_eu
). business_gst
, business_none
, overseas
, consumer
.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX.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
.Maximum length [100]
Maximum length [100]
overdue
. If the invoice is only partially paid, its status will be partially_paid
.Maximum length [100]
entity_level
and item_level
.Maximum length [100]
Maximum length [100]
Maximum length [25]
Maximum length [25]
standard
and adaptive
paypal
, authorize_net
, payflow_pro
, stripe
, 2checkout
and braintree
Maximum length [100]
Maximum length [25]
Maximum length [25]
Maximum length [25]
Query Parameters
true
and false
Retrieve an invoice
Details of an existing invoice.
OAuth Scope : ZohoSubscriptions.invoices.READ
Delete an invoice
Delete an existing invoice. Invoices which have payment or credits note applied cannot be deleted.
OAuth Scope : ZohoSubscriptions.invoices.DELETE
Update custom field in existing invoices
Update the value of the custom field in existing invoices.
OAuth Scope : ZohoSubscriptions.invoices.UPDATE
Arguments
Convert to open
Change the status of the invoice to open.
OAuth Scope : ZohoSubscriptions.invoices.CREATE
Void an invoice
Mark an invoice status as void. Upon voiding, the payments and credits associated with the invoices will be unassociated and will be under customer credits.
OAuth Scope : ZohoSubscriptions.invoices.CREATE
Email an invoice
Email an invoice.
OAuth Scope : ZohoSubscriptions.invoices.CREATE
Arguments
Collect charge via bank account / credit card
Charge a customer for an invoice using existing bank account.
OAuth Scope : ZohoSubscriptions.invoices.CREATE
Arguments
card_id
(Card ID of the card associated with the transaction)Write off
Write off a invoice.
OAuth Scope : ZohoSubscriptions.invoices.CREATE
Arguments
Update address
Update shipping and billing address of an invoice.
OAuth Scope : ZohoSubscriptions.invoices.UPDATE
Arguments
street
, city
, state
,zip
and country
.street
, city
, state
,zip
and country
.Update Custom Fields
Update the custom fields of an invoice.
OAuth Scope : ZohoSubscriptions.invoices.CREATE
Arguments
Apply Multiple Credits to Invoice
To associate multiple creditnotes to a particular invoice.
OAuth Scope : ZohoSubscriptions.invoices.CREATE
Arguments
Add items to a pending invoice
Editing a pending invoice to add usage charges.
OAuth Scope : ZohoSubscriptions.invoices.CREATE
Arguments
item_id
, name
, code
, price
, quantity
and item_total
.
description: Small description about the Invoice item.
example: "Charges for this duration (from 16-April-2016 to 8-June-2016)"Delete items from a pending invoice
Deleting an item from pending invoice.
OAuth Scope : ZohoSubscriptions.invoices.DELETE
Add attachment to an invoice
Attach a file to an invoice.
OAuth Scope : ZohoSubscriptions.invoices.CREATE
Arguments
gif
, png
, jpeg
, jpg
, bmp
and pdf
Cancel write off
Cancel the write off amount of an invoice.
OAuth Scope : ZohoSubscriptions.invoices.CREATE