List Credit Memos for a Business - Asset API Documentation

GET

business

{business_id}

credit-memo

List Credit Memos for a Business

curl --request GET \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/credit-memo \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "business_id": "<string>",
      "customer_id": "<string>",
      "number": "<string>",
      "amount": 123,
      "issued_at": "2023-11-07T05:31:56Z",
      "journal_entry_id": "<string>",
      "id": "<string>",
      "voided": true,
      "memo": "<string>",
      "void_journal_entry_id": "je_R2fAXCjqJPdpYata112zyW",
      "voided_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "tags": {
        "Job": [
          {
            "amount": "60.00",
            "value": "Maple Street Remodel"
          },
          {
            "amount": "40.00",
            "value": "Downtown Office Rewire"
          }
        ]
      }
    }
  ],
  "pagination": {
    "next_page_token": "<string>",
    "previous_page_token": "<string>"
  }
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

business_id

string<biz_string>

required

Query Parameters

customer_id

string<cus_string> | null

Filter credit memos by customer ID

voided

boolean | null

If set, filter by voided status (true = voided, false = active)

page_token

string | null

The page token to for the next or previous page

page_size

integer

default:100

Required range: 1 <= x <= 100

Response

Successful Response

data

CreditMemoPublic · object[]

required

Show child attributes

pagination

PaginationResponse · object

required

Show child attributes

⌘I

List Credit Memos for a Business

curl --request GET \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/credit-memo \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "business_id": "<string>",
      "customer_id": "<string>",
      "number": "<string>",
      "amount": 123,
      "issued_at": "2023-11-07T05:31:56Z",
      "journal_entry_id": "<string>",
      "id": "<string>",
      "voided": true,
      "memo": "<string>",
      "void_journal_entry_id": "je_R2fAXCjqJPdpYata112zyW",
      "voided_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "tags": {
        "Job": [
          {
            "amount": "60.00",
            "value": "Maple Street Remodel"
          },
          {
            "amount": "40.00",
            "value": "Downtown Office Rewire"
          }
        ]
      }
    }
  ],
  "pagination": {
    "next_page_token": "<string>",
    "previous_page_token": "<string>"
  }
}