POST
/
accounting
/
invoice_credit_notes
/
all
curl --request POST \
  --url https://api.rootfi.dev/accounting/invoice_credit_notes/all \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "take": 10,
  "skip": 0,
  "orderBy": {
    "document_number": "asc"
  },
  "filter": {
    "contact_id": {
      "eq": "3770712000000080150"
    }
  }
}'

{
  "data": {
    "data": [
      {
        "rootfi_id": 1234,
        "rootfi_company_id": 123456,
        "rootfi_organisation_id": 1,
        "rootfi_integration_type": "ZOHO_BOOKS",
        "rootfi_updated_at": "2021-09-28T15:00:00.000Z",
        "rootfi_created_at": "2021-09-28T15:00:00.000Z",
        "platform_id": "3770712000001556051",
        "invoice_ids": [
          "3770712000000352003"
        ],
        "contact_id": "3770712000000080150",
        "currency_id": null,
        "document_number": "CN-00038",
        "posted_date": "2023-03-21T00:00:00.000Z",
        "memo": null,
        "status": "SUBMITTED",
        "tax_amount": null,
        "total_amount": 60,
        "remaining_credit": 60,
        "updated_at": "2023-10-13T00:00:00.000Z",
        "currency": {
          "data": {
            "platform_id": null,
            "name": null,
            "code": null,
            "symbol": null,
            "is_base_currency": null,
            "exchange_rate": null,
            "updated_at": null
          }
        },
        "line_items": {
          "data": [
            {
              "platform_id": "1234567890123456789",
              "line_item_type": "BILLS",
              "line_item_type_id": "1234567890123456789",
              "tracking_category_ids": [
                "1234567890123456789"
              ],
              "item_id": "1234567890123456789",
              "tax_id": "1234567890123456789",
              "account_id": null,
              "description": "Test Item",
              "quantity": 1,
              "unit_amount": 100,
              "total_amount": 100,
              "sub_total": null,
              "tax_amount": 0,
              "total_discount": null,
              "updated_at": "2021-09-28T15:00:00.000Z"
            }
          ]
        }
      }
    ],
    "total_count": 1
  },
  "request_timestamp": "2021-09-28T15:00:00.000Z",
  "response_timestamp": "2021-09-28T15:00:00.000Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

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/all \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "take": 10,
  "skip": 0,
  "orderBy": {
    "document_number": "asc"
  },
  "filter": {
    "contact_id": {
      "eq": "3770712000000080150"
    }
  }
}'

Authorizations

​
api_key
string
header
required

Body

application/json
​
take
integer | null
​
skip
integer | null
​
orderBy
object
​
filter
object

Response

200 - application/json
​
data
object
required
​
request_timestamp
string
required

The time at which the request was received by the server

​
response_timestamp
string
required

The time at which the response was sent by the server

​
request_id
string
required

The unique ID of the request

Get All Invoice Credit NotesCreate Invoice Credit Note