Create Bill Credit Note

Create a new Bill credit note.

POST /accounting/bill_credit_notes

Create Bill Credit Note

cURL

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

200

{
  "data": {
    "status": "SUCCESS",
    "upload_job_id": "aXI9pUDA5T7E2LS",
    "data": [
      {
        "job_id": "xQm2K441VosP8W4",
        "status": "success",
        "response": {
          "platform_id": "3770712000001684001",
          "bill_ids": [
            "3770712000000213001"
          ],
          "contact_id": "3770712000000209007",
          "currency_id": "3770712000000000099",
          "document_number": "Bd5200",
          "posted_date": "2023-04-17T00:00:00.000Z",
          "memo": "psssss",
          "remaining_credit": 140,
          "total_amount": 140,
          "status": "SUBMITTED",
          "updated_at": "2023-10-31T00:00:00.000Z",
          "raw_data": {
            "platform_id": "123456",
            "nominal_code": "Rootfi 01",
            "name": "Test Account",
            "description": "Test Description",
            "category": "LIABILITY",
            "sub_category": "Long Term Liabilities",
            "status": "ACTIVE"
          }
        },
        "error": null
      }
    ]
  },
  "request_timestamp": "2021-09-28T15:00:00.000Z",
  "response_timestamp": "2021-09-28T15:00:00.000Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

An Bill Credit Note is a financial transaction representing a reduction that can be applied against one or multiple bills issued to Vendors.

Additional Required Fields

To successfully create a bill 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
FRESH_BOOKS	currency_rate	The exchange rate between the currency of the invoice credit note and the base currency of the company.
MYOB_BUSINESS	tax_code	The tax code to which the contact belongs.
SAGE_CLOUD_ACCOUNTING	currency_rate	The exchange rate to be used for the bill credit note.

Authorizations

api_key · string · header · required

Body

application/json

company_id · integer · required

The company ID

Example:

1

data · accountingtypesBillCreditNotesWriteRequestFields · object[] · required

Show child attributes

Response

200 - application/json

data · accountingtypesCreateBillCreditNotesResponseData · object · required

Show child attributes

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