Create Invoice Credit Note

curl --request POST \
  --url https://api.rootfi.dev/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": {
    "status": "SUCCESS",
    "upload_job_id": "<string>",
    "data": [
      {
        "job_id": "<string>",
        "status": "success",
        "response": {
          "platform_id": "<string>",
          "invoice_ids": [
            "<string>"
          ],
          "contact_id": "<string>",
          "currency_id": "<string>",
          "document_number": "<string>",
          "posted_date": "2023-11-07T05:31:56Z",
          "memo": "<string>",
          "status": "DRAFT",
          "tax_amount": 123,
          "total_amount": 123,
          "remaining_credit": 123,
          "updated_at": "2023-11-07T05:31:56Z",
          "raw_data": {}
        },
        "error": {
          "code": "<string>",
          "message": "<string>",
          "platform_error": "<string>",
          "raw_data": {}
        }
      }
    ]
  },
  "request_timestamp": "2023-11-07T05:31:56Z",
  "response_timestamp": "2023-11-07T05:31:56Z",
  "request_id": "<string>"
}

POST

accounting

invoice_credit_notes

curl --request POST \
  --url https://api.rootfi.dev/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": {
    "status": "SUCCESS",
    "upload_job_id": "<string>",
    "data": [
      {
        "job_id": "<string>",
        "status": "success",
        "response": {
          "platform_id": "<string>",
          "invoice_ids": [
            "<string>"
          ],
          "contact_id": "<string>",
          "currency_id": "<string>",
          "document_number": "<string>",
          "posted_date": "2023-11-07T05:31:56Z",
          "memo": "<string>",
          "status": "DRAFT",
          "tax_amount": 123,
          "total_amount": 123,
          "remaining_credit": 123,
          "updated_at": "2023-11-07T05:31:56Z",
          "raw_data": {}
        },
        "error": {
          "code": "<string>",
          "message": "<string>",
          "platform_error": "<string>",
          "raw_data": {}
        }
      }
    ]
  },
  "request_timestamp": "2023-11-07T05:31:56Z",
  "response_timestamp": "2023-11-07T05:31:56Z",
  "request_id": "<string>"
}

An Invoice Credit Note is a financial transaction representing a reduction that can be applied against one or multiple invoices issued to Customers.

curl --request POST \
  --url https://api.rootfi.dev/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"
        }
      ]
    }
  ]
}'
}'

Authorizations

api_key

string

header

required

Body

application/json

company_id

integer

required

Example:

1

data

accountingtypesInvoiceCreditNotesWriteRequest · object[]

required

Show child attributes

data.invoice_ids

string[] | null

An Array of Invoices associated with the credit note

data.contact_id

string | null

The accounting platform’s unique identifier for the contact associated with this credit note

data.currency_id

string | null

Currency ID of the credit note

data.document_number

string | null

Reference number for the credit note

data.posted_date

string<date-time> | null

Date on which the credit note was posted

data.memo

string | null

Description of the credit note

data.raw_data

object

A JSON containing fields that you can directly pass to the accounting platform.

data.line_items

LineItems · object[] | null

An array of Credit Note Line Items

Show child attributes

data.line_items.account_id

string | null

The ID of the account in the accounting platform

data.line_items.quantity

number<double> | null

The quantity of the item

data.line_items.item_id

string | null

The ID of the item in the accounting platform

data.line_items.tax_id

string | null

The ID of the tax in the accounting platform

data.line_items.unit_amount

number<double> | null

The unit amount of the item

data.line_items.total_discount

number<double> | null

The total discount on the item

data.line_items.description

string | null

The description of the item

data.line_items.tracking_category_ids

string[] | null

The IDs of the tracking categories in the accounting platform

Response

200 - application/json

data

accountingtypesCreateInvoiceCreditNotesResponseData · object

required

Show child attributes

data.status

enum<string>

required

The status of the job.

Available options:

SUCCESS,

FAILED,

CREATED,

RUNNING

data.upload_job_id

string

required

The ID of the job.

data.data

accountingtypesInvoiceCreditNotesResponse · object[]

required

Show child attributes

data.data.job_id

string

required

The ID of the job.

data.data.status

enum<string>

required

The status of the job.

Available options:

success,

failed

data.data.response

accountingtypesInvoiceCreditNotesWriteResponseFields · object

required

Show child attributes

data.data.response.platform_id

string

required

The ID that the accounting platform uses to identify this account

data.data.response.invoice_ids

string[] | null

An Array of Invoices associated with the credit note

data.data.response.contact_id

string | null

The accounting platform’s unique identifier for the contact associated with this credit note

data.data.response.currency_id

string | null

Currency ID of the credit note

data.data.response.document_number

string | null

Reference number for the credit note

data.data.response.posted_date

string<date-time> | null

Date on which the credit note was posted

data.data.response.memo

string | null

Description of the credit note

data.data.response.status

enum<string> | null

The status of the credit note.

Available options:

DRAFT,

SUBMITTED,

PARTIALLY_PAID,

PAID,

OVERDUE,

VOID,

UNKNOWN

data.data.response.tax_amount

integer | null

Total tax amount levied on the credit note

data.data.response.total_amount

integer | null

Total amount of the credit note

data.data.response.remaining_credit

integer | null

The balance amount remaining on the credit note

data.data.response.updated_at

string<date-time> | null

The last ISO 8601 timestamp that the data was updated at

data.data.response.raw_data

object

The raw JSON response we get from the accounting platform for that data.

data.data.error

ErrorObject · object

The error message if the job failed.

Show child attributes

data.data.error.code

string

required

data.data.error.message

string

required

data.data.error.platform_error

string

required

data.data.error.raw_data

object

request_timestamp

string<date-time>

required

The time at which the request was received by the server

response_timestamp

string<date-time>

required

The time at which the response was sent by the server

request_id

string

required

The unique ID of the request

Create Invoice Credit Note Overview

⌘I

General

Server Side SDKs

Core API

Unified API

Create Invoice Credit Note

Authorizations

Body

Response