FUfulcrumpro
Sales Order Fee Line Item

Update a specific fee line item for a sales order

Changed on
put/api/sales-orders/{salesOrderId}/fee-line-items/{lineItemId}

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/sales-orders/{salesOrderId}/fee-line-items/{lineItemId}
  • Auth
    none declared

Path parameters

salesOrderIdstring required
lineItemIdstring required

Request body

namestring nullable

Verbose name for this entity.

descriptionstring nullable

Verbose description for this entity.

quantitynumber double nullable

The line item quantity

pricenumber double required

The line item price.

accountingCodeIdstring nullable

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

isTaxableboolean nullable

Dictate if this fee is taxable.

taxCodeIdstring nullable

Tax code key identifier.

taxRatenumber double nullable

Tax code to use for this entity. If a FulcrumProduct.PublicApi.Dto.SalesOrder.FeeLineItem.FeeLineItemUpdateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.SalesOrder.FeeLineItem.FeeLineItemUpdateDto.TaxRate will supercede the defined tax rate.

overrideTaxRateboolean nullable

Indicate if the tax supplied is intended to be an override.

externalReferencesobject nullable

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Response

Fee line item

idstring required

Unique id associated to this entity.

namestring nullable

Verbose name for this entity.

descriptionstring nullable

Verbose description for this entity.

quantitynumber double nullable

The line item quantity

pricenumber double required

The line item price.

unitOfMeasure'notApplicable' | 'piece' | 'linearFeet' | 'hour' | 'yard'

Line item unit of measure.

accountingCodeIdstring nullable

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

isTaxableboolean nullable

Dictate if this fee is taxable.

overrideTaxRateboolean nullable

Dictate if the tax rate is overridden.

taxCodeIdstring nullable

Tax code key identifier.

taxRatenumber double nullable

Tax code to use for this entity. If a FulcrumProduct.PublicApi.Dto.SalesOrder.FeeLineItem.FeeLineItemDto.TaxCodeId is provided and FulcrumProduct.PublicApi.Dto.SalesOrder.FeeLineItem.FeeLineItemDto.OverrideTaxRate = true, the provided FulcrumProduct.PublicApi.Dto.SalesOrder.FeeLineItem.FeeLineItemDto.TaxRate will supercede the defined tax rate.

externalReferencesobject nullable

Arbitrary key-value-pair like data that can be used to later on search for this line item.

numberinteger

Line number

Changes

  • 68a3cf300a5dRevision changes
    • info

      added the new optional request property // (media type: application/json-patch+json)

    • info

      added the new optional request property // (media type: application/json)

    • info

      added the new optional request property // (media type: text/json)

    • info

      added the new optional request property // (media type: application/*+json)

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: application/problem+json)

  • 30a13c1e996eRevision changes
    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/problem+json)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/problem+json)