Bill Credit Notes

A Bill Credit Note represents a refund or credit for goods or services that have been bought from a Vendors. For example, if a vendor was unable to complete an order that was placed by a business, or delivered invalid goods, they could issue a bill credit note.

The Bill Credit Note Object

Property

Type

Description

id

string

posted_at

string

The posted ISO 8601 date

allocated_at

string

The allocated ISO 8601 date

currency

string

The ISO-4217 currency code

currency_rate

number

line_items

object[]

total_discount

number

discount_percentage

number

sub_total

number

tax_amount

number

total_amount

number

remaining_credit

number

status

string

Current state of a bill credit note, one of:

  • draft
  • submitted
  • paid
  • void

memo

string

payments

object[]

vendor_id

string

{
      "id": "1",
      "posted_at": "2021-03-09T10:18:29.985Z",
      "allocated_at": "2021-03-09T10:18:29.985Z",
      "currency": "USD",
      "currency_rate": 1.13,
      "line_items": [
        {
          "description": "Services rendered.",
          "unit_amount": 100.5,
          "quantity": 3,
          "discount_amount": 0,
          "sub_total": 301.5,
          "tax_amount": 20.5,
          "total_amount": 322,
          "discount_percentage": 10.5,
          "tax_rate_id": "123",
          "item_id": "1",
          "account_id": "132"
        }
      ],
      "total_discount": 322,
      "discount_percentage": 322,
      "sub_total": 301.5,
      "tax_amount": 20.5,
      "total_amount": 322,
      "remaining_credit": 322,
      "status": "open",
      "memo": "Example bill memo.",
      "payments": [
        {
          "amount": 50.5,
          "id": "50"
        }
      ],
      "vendor_id": "1"
    }