Sales Invoice Line

The sales invoice line resource.

Basehttps://rest.carbon.ms/salesInvoiceLine

GET/salesInvoiceLine

List sales invoice lines

Retrieve a paginated list of sales invoice 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.

GEThttps://rest.carbon.ms/salesInvoiceLine

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

Response

[
  {
    "id": "abc123def456",
    "invoiceId": "xyz789",
    "invoiceLineType": "string",
    "methodType": "string",
    "quantity": 10,
    "unitOfMeasureCode": "string",
    "exchangeRate": 0,
    "unitPrice": 0
  }
]

GET/salesInvoiceLine

Retrieve a sales invoice line

Fetch a single sales invoice line by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/salesInvoiceLine

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

Response

{
  "id": "abc123def456",
  "invoiceId": "xyz789",
  "invoiceLineType": "string",
  "methodType": "string",
  "quantity": 10,
  "unitOfMeasureCode": "string",
  "exchangeRate": 0,
  "unitPrice": 0
}

POST/salesInvoiceLine

Create a sales invoice line

Create a new sales invoice line.

Body parameters

invoiceIdstringrequired

References salesInvoice.id

invoiceLineTypesalesInvoiceLineTyperequired

descriptionstring

itemIdstring

References item.id

methodTypemethodTyperequired

assetIdstring

quantitynumberrequired

unitOfMeasureCodestringrequired

locationIdstring

References location.id

storageUnitIdstring

References storageUnit.id

exchangeRatenumberrequired

unitPricenumberrequired

setupPricenumberrequired

addOnCostnumberrequired

shippingCostnumberrequired

taxPercentnumberrequired

convertedUnitPricenumber

convertedAddOnCostnumber

convertedShippingCostnumber

convertedSetupPricenumber

externalNotesobjectrequired

internalNotesobjectrequired

modelUploadIdstring

References modelUpload.id

opportunityIdstring

References opportunity.id

salesOrderIdstring

References salesOrder.id

salesOrderLineIdstring

References salesOrderLine.id

customFieldsobjectrequired

companyIdstringrequired

References company.id

accountIdstring

References account.id

nonTaxableAddOnCostnumberrequired

convertedNonTaxableAddOnCostnumber

POSThttps://rest.carbon.ms/salesInvoiceLine

curl --request POST \
  --url https://rest.carbon.ms/salesInvoiceLine \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"invoiceId":"xyz789","invoiceLineType":"string","description":"string","methodType":"string","quantity":10,"unitOfMeasureCode":"string","exchangeRate":0,"unitPrice":0,"setupPrice":0,"addOnCost":0,"shippingCost":0,"taxPercent":0,"externalNotes":"string","internalNotes":"string","customFields":"string","companyId":"xyz789","nonTaxableAddOnCost":0}'

Response

{
  "id": "abc123def456",
  "invoiceId": "xyz789",
  "invoiceLineType": "string",
  "methodType": "string",
  "quantity": 10,
  "unitOfMeasureCode": "string",
  "exchangeRate": 0,
  "unitPrice": 0
}

PATCH/salesInvoiceLine

Update a sales invoice line

Update an existing sales invoice line, matched on `id`.

Body parameters

invoiceIdstringrequired

References salesInvoice.id

invoiceLineTypesalesInvoiceLineTyperequired

descriptionstring

itemIdstring

References item.id

methodTypemethodTyperequired

assetIdstring

quantitynumberrequired

unitOfMeasureCodestringrequired

locationIdstring

References location.id

storageUnitIdstring

References storageUnit.id

exchangeRatenumberrequired

unitPricenumberrequired

setupPricenumberrequired

addOnCostnumberrequired

shippingCostnumberrequired

taxPercentnumberrequired

convertedUnitPricenumber

convertedAddOnCostnumber

convertedShippingCostnumber

convertedSetupPricenumber

externalNotesobjectrequired

internalNotesobjectrequired

modelUploadIdstring

References modelUpload.id

opportunityIdstring

References opportunity.id

salesOrderIdstring

References salesOrder.id

salesOrderLineIdstring

References salesOrderLine.id

customFieldsobjectrequired

companyIdstringrequired

References company.id

accountIdstring

References account.id

nonTaxableAddOnCostnumberrequired

convertedNonTaxableAddOnCostnumber

PATCHhttps://rest.carbon.ms/salesInvoiceLine

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

Response

{
  "id": "abc123def456",
  "invoiceId": "xyz789",
  "invoiceLineType": "string",
  "methodType": "string",
  "quantity": 10,
  "unitOfMeasureCode": "string",
  "exchangeRate": 0,
  "unitPrice": 0
}

DELETE/salesInvoiceLine

Delete a sales invoice line

Delete a sales invoice line, matched on `id`. Returns 204 No Content.

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/salesInvoiceLine

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

204 No Content