Item Unit Sale Price

The item unit sale price resource.

Basehttps://rest.carbon.ms/itemUnitSalePrice

GET/itemUnitSalePrice

List item unit sale prices

Retrieve a paginated list of item unit sale prices. 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/itemUnitSalePrice

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

Response

[
  {
    "itemId": "xyz789",
    "unitSalePrice": 0,
    "currencyCode": "string",
    "salesBlocked": true,
    "priceIncludesTax": true,
    "allowInvoiceDiscount": true,
    "companyId": "xyz789",
    "createdBy": "string"
  }
]

GET/itemUnitSalePrice

Retrieve a item unit sale price

Fetch a single item unit sale price by filtering on `itemId`.

Query parameters

itemIdstring

Match on the item unit sale price's `itemId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/itemUnitSalePrice

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

Response

{
  "itemId": "xyz789",
  "unitSalePrice": 0,
  "currencyCode": "string",
  "salesBlocked": true,
  "priceIncludesTax": true,
  "allowInvoiceDiscount": true,
  "companyId": "xyz789",
  "createdBy": "string"
}

POST/itemUnitSalePrice

Create a item unit sale price

Create a new item unit sale price.

Body parameters

itemIdstringrequired

References item.id

unitSalePricenumberrequired

currencyCodestringrequired

References currencyCode.code

salesUnitOfMeasureCodestring

salesBlockedbooleanrequired

priceIncludesTaxbooleanrequired

allowInvoiceDiscountbooleanrequired

companyIdstringrequired

References company.id

customFieldsobject

tagsarray

POSThttps://rest.carbon.ms/itemUnitSalePrice

curl --request POST \
  --url https://rest.carbon.ms/itemUnitSalePrice \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"itemId":"xyz789","unitSalePrice":0,"currencyCode":"string","salesBlocked":true,"priceIncludesTax":true,"allowInvoiceDiscount":true,"companyId":"xyz789"}'

Response

{
  "itemId": "xyz789",
  "unitSalePrice": 0,
  "currencyCode": "string",
  "salesBlocked": true,
  "priceIncludesTax": true,
  "allowInvoiceDiscount": true,
  "companyId": "xyz789",
  "createdBy": "string"
}

PATCH/itemUnitSalePrice

Update a item unit sale price

Update an existing item unit sale price, matched on `itemId`.

Body parameters

itemIdstringrequired

References item.id

unitSalePricenumberrequired

currencyCodestringrequired

References currencyCode.code

salesUnitOfMeasureCodestring

salesBlockedbooleanrequired

priceIncludesTaxbooleanrequired

allowInvoiceDiscountbooleanrequired

companyIdstringrequired

References company.id

customFieldsobject

tagsarray

PATCHhttps://rest.carbon.ms/itemUnitSalePrice

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

Response

{
  "itemId": "xyz789",
  "unitSalePrice": 0,
  "currencyCode": "string",
  "salesBlocked": true,
  "priceIncludesTax": true,
  "allowInvoiceDiscount": true,
  "companyId": "xyz789",
  "createdBy": "string"
}

DELETE/itemUnitSalePrice

Delete a item unit sale price

Delete a item unit sale price, matched on `itemId`. Returns 204 No Content.

Query parameters

itemIdstring

The `itemId` of the item unit sale price to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/itemUnitSalePrice

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

204 No Content