curl --request POST \
--url https://api.rootfi.dev/v3/accounting/invoice_credit_notes \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"company_id": 1,
"data": [
{
"contact_id": "123456",
"document_number": "ROOTFI01",
"posted_date": "2021-09-28T15:00:00.000Z",
"currency_id": "GBP",
"invoice_ids": [],
"memo": "Test Invoice",
"line_items": [
{
"account_id": "123456",
"quantity": 1,
"item_id": "123456",
"tax_id": "123456",
"unit_amount": 100,
"total_discount": 0,
"description": "Test Item"
}
]
}
]
}'
}'
{
"data": {
"rootfi_id": 123,
"rootfi_deleted_at": null,
"rootfi_created_at": "2024-01-25T09:00:00Z",
"rootfi_updated_at": "2024-01-25T09:00:00Z",
"rootfi_company_id": 456,
"platform_id": "123456_1",
"platform_unique_id": "123456",
"contact_id": "123456",
"document_number": "123456",
"total_amount": 1000,
"remaining_credit": 1000,
"posted_date": "2024-01-25T09:00:00Z",
"currency_id": "123456",
"memo": "Example Memo",
"status": "Example Status",
"invoice_ids": [
"123456"
],
"updated_at": "2024-01-25T09:00:00Z",
"tax_amount": 100,
"line_items": [
{
"rootfi_id": 157,
"platform_id": "123456",
"line_item_type": "INVOICES",
"line_item_type_id": "123456",
"tracking_category_ids": [
"123456"
],
"project_id": "123456",
"item_id": "123456",
"tax_id": "123456",
"account_id": "123456",
"description": "This is a description",
"quantity": 1,
"unit_amount": 100,
"total_amount": 100,
"sub_total": 100,
"tax_amount": 100,
"total_discount": 100,
"updated_at": "2024-01-22T05:07:31.000Z"
}
]
}
}
Create a new invoice credit note.
curl --request POST \
--url https://api.rootfi.dev/v3/accounting/invoice_credit_notes \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"company_id": 1,
"data": [
{
"contact_id": "123456",
"document_number": "ROOTFI01",
"posted_date": "2021-09-28T15:00:00.000Z",
"currency_id": "GBP",
"invoice_ids": [],
"memo": "Test Invoice",
"line_items": [
{
"account_id": "123456",
"quantity": 1,
"item_id": "123456",
"tax_id": "123456",
"unit_amount": 100,
"total_discount": 0,
"description": "Test Item"
}
]
}
]
}'
}'
{
"data": {
"rootfi_id": 123,
"rootfi_deleted_at": null,
"rootfi_created_at": "2024-01-25T09:00:00Z",
"rootfi_updated_at": "2024-01-25T09:00:00Z",
"rootfi_company_id": 456,
"platform_id": "123456_1",
"platform_unique_id": "123456",
"contact_id": "123456",
"document_number": "123456",
"total_amount": 1000,
"remaining_credit": 1000,
"posted_date": "2024-01-25T09:00:00Z",
"currency_id": "123456",
"memo": "Example Memo",
"status": "Example Status",
"invoice_ids": [
"123456"
],
"updated_at": "2024-01-25T09:00:00Z",
"tax_amount": 100,
"line_items": [
{
"rootfi_id": 157,
"platform_id": "123456",
"line_item_type": "INVOICES",
"line_item_type_id": "123456",
"tracking_category_ids": [
"123456"
],
"project_id": "123456",
"item_id": "123456",
"tax_id": "123456",
"account_id": "123456",
"description": "This is a description",
"quantity": 1,
"unit_amount": 100,
"total_amount": 100,
"sub_total": 100,
"tax_amount": 100,
"total_discount": 100,
"updated_at": "2024-01-22T05:07:31.000Z"
}
]
}
}
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. |
curl --request POST \
--url https://api.rootfi.dev/v3/accounting/invoice_credit_notes \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"company_id": 1,
"data": [
{
"contact_id": "123456",
"document_number": "ROOTFI01",
"posted_date": "2021-09-28T15:00:00.000Z",
"currency_id": "GBP",
"invoice_ids": [],
"memo": "Test Invoice",
"line_items": [
{
"account_id": "123456",
"quantity": 1,
"item_id": "123456",
"tax_id": "123456",
"unit_amount": 100,
"total_discount": 0,
"description": "Test Item"
}
]
}
]
}'
}'
The response is of type object
.