Memo

The memo resource.

Basehttps://rest.carbon.ms/memo

GET/memo

List memos

Retrieve a paginated list of memos. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/memo

curl --request GET \
  --url 'https://rest.carbon.ms/memo?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "memoId": "xyz789",
    "direction": "string",
    "status": "string",
    "memoDate": "2026-01-01",
    "currencyCode": "string",
    "exchangeRate": 0,
    "amount": 0
  }
]

GET/memo

Retrieve a memo

Fetch a single memo by filtering on `id`.

Query parameters

idstring

Match on the memo's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/memo

curl --request GET \
  --url 'https://rest.carbon.ms/memo?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "memoId": "xyz789",
  "direction": "string",
  "status": "string",
  "memoDate": "2026-01-01",
  "currencyCode": "string",
  "exchangeRate": 0,
  "amount": 0
}

POST/memo

Create a memo

Create a new memo.

Body parameters

memoIdstringrequired

directionmemoDirectionrequired

statusmemoStatusrequired

customerIdstring

supplierIdstring

memoDatedaterequired

postingDatedate

currencyCodestringrequired

References currencyCode.code

exchangeRatenumberrequired

amountnumberrequired

reasonAccountstring

References account.id

referencestring

notesstring

journalIdstring

References journal.id

postedAttimestamp

postedBystring

References user.id

voidedAttimestamp

voidedBystring

References user.id

companyIdstringrequired

References company.id

customFieldsobject

POSThttps://rest.carbon.ms/memo

curl --request POST \
  --url https://rest.carbon.ms/memo \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"memoId":"xyz789","direction":"string","status":"string","memoDate":"2026-01-01","currencyCode":"string","exchangeRate":0,"amount":0,"companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "memoId": "xyz789",
  "direction": "string",
  "status": "string",
  "memoDate": "2026-01-01",
  "currencyCode": "string",
  "exchangeRate": 0,
  "amount": 0
}

PATCH/memo

Update a memo

Update an existing memo, matched on `id`.

Body parameters

memoIdstringrequired

directionmemoDirectionrequired

statusmemoStatusrequired

customerIdstring

supplierIdstring

memoDatedaterequired

postingDatedate

currencyCodestringrequired

References currencyCode.code

exchangeRatenumberrequired

amountnumberrequired

reasonAccountstring

References account.id

referencestring

notesstring

journalIdstring

References journal.id

postedAttimestamp

postedBystring

References user.id

voidedAttimestamp

voidedBystring

References user.id

companyIdstringrequired

References company.id

customFieldsobject

PATCHhttps://rest.carbon.ms/memo

curl --request PATCH \
  --url 'https://rest.carbon.ms/memo?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"memoId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "memoId": "xyz789",
  "direction": "string",
  "status": "string",
  "memoDate": "2026-01-01",
  "currencyCode": "string",
  "exchangeRate": 0,
  "amount": 0
}

DELETE/memo

Delete a memo

Delete a memo, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the memo to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/memo

curl --request DELETE \
  --url 'https://rest.carbon.ms/memo?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content