Skip to content
aimrack

Sales Return Order Credit Line

The sales return order credit line resource.

Base/salesReturnOrderCreditLine
GET/salesReturnOrderCreditLine

List sales return order credit lines

Retrieve a paginated list of sales return order credit lines. 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.

GET/salesReturnOrderCreditLine
curl --request GET \
  --url '<your-host>/salesReturnOrderCreditLine?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "memoId": "xyz789",
    "salesReturnOrderLineId": "xyz789",
    "quantity": 10,
    "unitPrice": 0,
    "restockFee": 0,
    "createdBy": "string"
  }
]
GET/salesReturnOrderCreditLine

Retrieve a sales return order credit line

Fetch a single sales return order credit line by filtering on `id`.

Query parameters

idstring

Match on the sales return order credit line's `id`, e.g. `eq.{id}`.

GET/salesReturnOrderCreditLine
curl --request GET \
  --url '<your-host>/salesReturnOrderCreditLine?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "memoId": "xyz789",
  "salesReturnOrderLineId": "xyz789",
  "quantity": 10,
  "unitPrice": 0,
  "restockFee": 0,
  "createdBy": "string"
}
POST/salesReturnOrderCreditLine

Create a sales return order credit line

Create a new sales return order credit line.

Body parameters

memoIdstringrequired

References memo.id

salesReturnOrderLineIdstringrequired
quantitynumberrequired
unitPricenumberrequired
restockFeenumberrequired
POST/salesReturnOrderCreditLine
curl --request POST \
  --url <your-host>/salesReturnOrderCreditLine \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"memoId":"xyz789","salesReturnOrderLineId":"xyz789","quantity":10,"unitPrice":0,"restockFee":0}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "memoId": "xyz789",
  "salesReturnOrderLineId": "xyz789",
  "quantity": 10,
  "unitPrice": 0,
  "restockFee": 0,
  "createdBy": "string"
}
PATCH/salesReturnOrderCreditLine

Update a sales return order credit line

Update an existing sales return order credit line, matched on `id`.

Body parameters

memoIdstringrequired

References memo.id

salesReturnOrderLineIdstringrequired
quantitynumberrequired
unitPricenumberrequired
restockFeenumberrequired
PATCH/salesReturnOrderCreditLine
curl --request PATCH \
  --url '<your-host>/salesReturnOrderCreditLine?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"memoId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "memoId": "xyz789",
  "salesReturnOrderLineId": "xyz789",
  "quantity": 10,
  "unitPrice": 0,
  "restockFee": 0,
  "createdBy": "string"
}
DELETE/salesReturnOrderCreditLine

Delete a sales return order credit line

Delete a sales return order credit line, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the sales return order credit line to delete, e.g. `eq.{id}`.

DELETE/salesReturnOrderCreditLine
curl --request DELETE \
  --url '<your-host>/salesReturnOrderCreditLine?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content