General
Server Side SDKs
Core API
- Companies
- Invite Links
- Sync
- Passthrough
- Real Time
- Webhooks
Unified API
- Accounting
- Accounts
- Bank Accounts
- Bank Transactions
- Bills
- Bill Payments
- Bill Credit Notes
- Contacts
- Company Info
- Currencies
- Documents
- Expenses
- Invoice Credit Notes
- Invoices
- Invoice Payments
- Items
- Journal Entries
- Purchase Orders
- Sales Orders
- Goods Receipt Notes
- Projects
- Tax Rates
- Tracking Categories
- Balance Sheet
- Cash Flow Statements
- Income Statements
- Payments
- Ecommerce
- CRM
Create Invoice Credit Note
Create a new invoice credit note.
An Invoice Credit Note is a financial transaction representing a reduction that can be applied against one or multiple invoices issued to Customers.
Additional Required Fields
To successfully create an invoice credit note, certain fields must be included in the raw_data object of the request body. The required fields are as follows:
| Integration | Field | Description |
|---|---|---|
| SAGE_CLOUD_ACCOUNTING | currency_rate | The exchange rate to be used for the invoice credit note. |
| FRESH_BOOKS | currency_rate | The exchange rate between the currency of the invoice credit note and the base currency of the company. |
Authorizations
Body
The ID of the company in the accounting platform
The data of the invoice credit note to create
The contact id of the invoice credit note
The currency id of the invoice credit note
The document number of the invoice credit note
The invoice ids of the invoice credit note
The line items of the invoice credit note
The account of the line item
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
The category of the account
ASSET, EXPENSE, LIABILITY, EQUITY, INCOME, BANK, UNKNOWN The currency of the account.
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
The currency code.
The hash of the data
The exchange rate for the currency.
Whether the currency is the base currency for the company.
The name of the currency
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
The symbol that represents the currency. Not applicable for many currencies.
The last ISO 8601 timestamp that the data was updated at.
The currency id of the account
The current balance of the account
The hash of the data
Description of the account
Name of the account
The nominal code of the account
The parent account of the account.
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
The category of the account
ASSET, EXPENSE, LIABILITY, EQUITY, INCOME, BANK, UNKNOWN The currency id of the account
The current balance of the account
The hash of the data
Description of the account
Name of the account
The nominal code of the account
The parent account id of the account
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
The status of the account
The sub category of the account
The date the account was last updated
The parent account id of the account
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
The status of the account
The sub category of the account
The date the account was last updated
The account id of the line item
The description of the line item
The item of the line item
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
Item details of this item getting purchased
Reference code of the item
The hash of the data
Description of the item
Item details of this item getting sold
Check if there are details (bill_item) of this item getting purchased
Check if there are details (invoice_item) of this item getting sold
Name of the item
The ID of the data in the accounting platform.
Quantity on hand
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
Status of the item. Values are ACTIVE, ARCHIVED, UNKNOWN
ACTIVE, ARCHIVED, UNKNOWN Type of the item. Values are INVENTORY, NON_INVENTORY, SERVICE, UNKNOWN
INVENTORY, NON_INVENTORY, SERVICE, UNKNOWN The date the item was last updated
The item id of the line item
The line item type of the line item
BILLS, INVOICES, BILL_CREDIT_NOTES, INVOICE_CREDIT_NOTES, EXPENSES, PURCHASE_ORDERS, SALES_ORDERS The line item type id of the line item
The platform id of the line item
The project id of the line item
The quantity of the line item
The unique ID we assign for that data's information
The sub total of the line item
The tax of the line item
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
Simple ID for the tax rate
The list of tax rate components
Whether the tax rate component is compound
Display name
The total tax rate after accounting for the compounding effects of the all tax components
The tax agency of the tax rate component
The hash of the data
The total tax rate after accounting for the compounding effects of the all tax components
Display name
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
The type of tax as mentioned in the accounting platform
The sum of all the tax rate components
The last time the tax rate was updated
The tax amount of the line item
The tax id of the line item
The total amount of the line item
The total discount of the line item
The tracking category ids of the line item
The unit amount of the line item
The last ISO 8601 timestamp that the data was updated at
The memo of the invoice credit note
The posted date of the invoice credit note
The remaining credit of the invoice credit note
The status of the invoice credit note
The tax amount of the invoice credit note
The total amount of the invoice credit note
The updated at of the invoice credit note
Run the request asynchronously
Response
The data of the created invoice credit note
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
The contact of the invoice credit note
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
Addresses for the contact
The city of the address
The country of the address
The locality of the address
The pincode of the address
The platform ID of the contact
The RootFi ID of the contact
The state of the address
The street of the address
Name of the contact person for the contact
The type of contact. Values are either CUSTOMER or VENDOR
CUSTOMER, VENDOR The ISO-4217 currency code
The hash of the data
External links for the contact
The link to the contact
The platform ID of the contact
The RootFi ID of the contact
The type of the link.
EMAIL, WEBSITE Name of the contact
Phone numbers for the contact
The number to the contact
The platform ID of the contact
The RootFi ID of the contact
The type of the link.
MOBILE, TELEPHONE, FAX The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
Contact’s identifying number
The date at which the data was deleted in the accounting platform
The status of the contact. Values are ACTIVE, ARCHIVED, UNKNOWN
ACTIVE, ARCHIVED, UNKNOWN Contact’s tax number
The date the contact was last updated
The contact id of the invoice credit note
The currency of the invoice credit note
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
The currency code.
The hash of the data
The exchange rate for the currency.
Whether the currency is the base currency for the company.
The name of the currency
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
The symbol that represents the currency. Not applicable for many currencies.
The last ISO 8601 timestamp that the data was updated at.
The currency id of the invoice credit note
The hash of the data
The document number of the invoice credit note
The invoice ids of the invoice credit note
The line items of the invoice credit note
The account of the line item
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
The category of the account
ASSET, EXPENSE, LIABILITY, EQUITY, INCOME, BANK, UNKNOWN The currency of the account.
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
The currency code.
The hash of the data
The exchange rate for the currency.
Whether the currency is the base currency for the company.
The name of the currency
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
The symbol that represents the currency. Not applicable for many currencies.
The last ISO 8601 timestamp that the data was updated at.
The currency id of the account
The current balance of the account
The hash of the data
Description of the account
Name of the account
The nominal code of the account
The parent account of the account.
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
The category of the account
ASSET, EXPENSE, LIABILITY, EQUITY, INCOME, BANK, UNKNOWN The currency id of the account
The current balance of the account
The hash of the data
Description of the account
Name of the account
The nominal code of the account
The parent account id of the account
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
The status of the account
The sub category of the account
The date the account was last updated
The parent account id of the account
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
The status of the account
The sub category of the account
The date the account was last updated
The account id of the line item
The description of the line item
The item of the line item
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
Item details of this item getting purchased
Reference code of the item
The hash of the data
Description of the item
Item details of this item getting sold
Check if there are details (bill_item) of this item getting purchased
Check if there are details (invoice_item) of this item getting sold
Name of the item
The ID of the data in the accounting platform.
Quantity on hand
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
Status of the item. Values are ACTIVE, ARCHIVED, UNKNOWN
ACTIVE, ARCHIVED, UNKNOWN Type of the item. Values are INVENTORY, NON_INVENTORY, SERVICE, UNKNOWN
INVENTORY, NON_INVENTORY, SERVICE, UNKNOWN The date the item was last updated
The item id of the line item
The line item type of the line item
BILLS, INVOICES, BILL_CREDIT_NOTES, INVOICE_CREDIT_NOTES, EXPENSES, PURCHASE_ORDERS, SALES_ORDERS The line item type id of the line item
The platform id of the line item
The project id of the line item
The quantity of the line item
The unique ID we assign for that data's information
The sub total of the line item
The tax of the line item
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
Simple ID for the tax rate
The list of tax rate components
Whether the tax rate component is compound
Display name
The total tax rate after accounting for the compounding effects of the all tax components
The tax agency of the tax rate component
The hash of the data
The total tax rate after accounting for the compounding effects of the all tax components
Display name
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
The type of tax as mentioned in the accounting platform
The sum of all the tax rate components
The last time the tax rate was updated
The tax amount of the line item
The tax id of the line item
The total amount of the line item
The total discount of the line item
The tracking category ids of the line item
The unit amount of the line item
The last ISO 8601 timestamp that the data was updated at
The memo of the invoice credit note
The payments of the invoice credit note being applied to invoices
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
The account object of the invoice payments
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
The category of the account
ASSET, EXPENSE, LIABILITY, EQUITY, INCOME, BANK, UNKNOWN The currency of the account.
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
The currency code.
The hash of the data
The exchange rate for the currency.
Whether the currency is the base currency for the company.
The name of the currency
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
The symbol that represents the currency. Not applicable for many currencies.
The last ISO 8601 timestamp that the data was updated at.
The currency id of the account
The current balance of the account
The hash of the data
Description of the account
Name of the account
The nominal code of the account
The parent account of the account.
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
The category of the account
ASSET, EXPENSE, LIABILITY, EQUITY, INCOME, BANK, UNKNOWN The currency id of the account
The current balance of the account
The hash of the data
Description of the account
Name of the account
The nominal code of the account
The parent account id of the account
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
The status of the account
The sub category of the account
The date the account was last updated
The parent account id of the account
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
The status of the account
The sub category of the account
The date the account was last updated
The account id of the invoice payments
The amount of the invoice payments
The contact object of the invoice payments
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
Addresses for the contact
The city of the address
The country of the address
The locality of the address
The pincode of the address
The platform ID of the contact
The RootFi ID of the contact
The state of the address
The street of the address
Name of the contact person for the contact
The type of contact. Values are either CUSTOMER or VENDOR
CUSTOMER, VENDOR The ISO-4217 currency code
The hash of the data
External links for the contact
The link to the contact
The platform ID of the contact
The RootFi ID of the contact
The type of the link.
EMAIL, WEBSITE Name of the contact
Phone numbers for the contact
The number to the contact
The platform ID of the contact
The RootFi ID of the contact
The type of the link.
MOBILE, TELEPHONE, FAX The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
Contact’s identifying number
The date at which the data was deleted in the accounting platform
The status of the contact. Values are ACTIVE, ARCHIVED, UNKNOWN
ACTIVE, ARCHIVED, UNKNOWN Contact’s tax number
The date the contact was last updated
The contact id of the invoice payments
The credit note id of the invoice payments
The currency object of the invoice payments
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
The currency code.
The hash of the data
The exchange rate for the currency.
Whether the currency is the base currency for the company.
The name of the currency
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
The symbol that represents the currency. Not applicable for many currencies.
The last ISO 8601 timestamp that the data was updated at.
The currency id of the invoice payments
The currency rate of the invoice payments
The hash of the data
The document number of the invoice payments
The invoice object of the invoice payments
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
The amount due of the invoice
The contact of the invoice
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
Addresses for the contact
Name of the contact person for the contact
The type of contact. Values are either CUSTOMER or VENDOR
CUSTOMER, VENDOR The ISO-4217 currency code
The hash of the data
External links for the contact
Name of the contact
Phone numbers for the contact
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
Contact’s identifying number
The date at which the data was deleted in the accounting platform
The status of the contact. Values are ACTIVE, ARCHIVED, UNKNOWN
ACTIVE, ARCHIVED, UNKNOWN Contact’s tax number
The date the contact was last updated
The contact ID of the invoice
The currency of the invoice
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
The currency code.
The hash of the data
The exchange rate for the currency.
Whether the currency is the base currency for the company.
The name of the currency
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
The symbol that represents the currency. Not applicable for many currencies.
The last ISO 8601 timestamp that the data was updated at.
The currency ID of the invoice
The currency rate of the invoice
The hash of the data
The document number of the invoice
The documents of the invoice
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
The hash of the data
The document type of the document
The platform_id of the voucher to which the file will be linked to.
The document uploaded of the document
The file name of the document
The file size of the document
The file type of the document
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
The updated date of the document
The due date of the invoice
The invoice payments of the invoice
An unique custom RootFi ID made from platform's unique_id.
The ID of the company in the accounting platform
The date at which RootFi first synced this data
The unique ID we assign for that data's information
The latest date at which RootFi updated this data
The account id of the invoice payments
The amount of the invoice payments
The contact id of the invoice payments
The credit note id of the invoice payments
The currency id of the invoice payments
The currency rate of the invoice payments
The hash of the data
The document number of the invoice payments
The invoice id of the invoice payments
The memo of the invoice payments
The payment date of the invoice payments
The payment id of the invoice payments
The payment mode of the invoice payments
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
The updated date of the invoice payments
The line items of the invoice
The account of the line item
The account id of the line item
The description of the line item
The item of the line item
The item id of the line item
The line item type of the line item
BILLS, INVOICES, BILL_CREDIT_NOTES, INVOICE_CREDIT_NOTES, EXPENSES, PURCHASE_ORDERS, SALES_ORDERS The line item type id of the line item
The platform id of the line item
The project id of the line item
The quantity of the line item
The unique ID we assign for that data's information
The sub total of the line item
The tax of the line item
The tax amount of the line item
The tax id of the line item
The total amount of the line item
The total discount of the line item
The tracking category ids of the line item
The unit amount of the line item
The last ISO 8601 timestamp that the data was updated at
The memo of the invoice
The ID of the data in the accounting platform.
The posted date of the invoice
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
The sales order IDs of the invoice
The status of the invoice
The sub total of the invoice
The tax amount of the invoice
The total amount of the invoice
The total discount of the invoice
The updated at of the invoice
The invoice id of the invoice payments
The memo of the invoice payments
The payment date of the invoice payments
The payment id of the invoice payments
The payment mode of the invoice payments
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The date at which the data was deleted in the accounting platform
The updated date of the invoice payments
The ID of the data in the accounting platform.
The posted date of the invoice credit note
A JSON containing fields that you can directly get from the accounting platform.
The remaining credit of the invoice credit note
The date at which the data was deleted in the accounting platform
The status of the invoice credit note
The tax amount of the invoice credit note
The total amount of the invoice credit note
The updated at of the invoice credit note
The sync id of the request