FUfulcrumpro
Purchase Order Fee Line Item

Update a specific fee line item for a purchase order

Changed on
put/api/purchase-orders/{purchaseOrderId}/fee-line-items/{lineItemId}

Request

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

Path parameters

purchaseOrderIdstring 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. Required for receivable line items.

pricenumber double required

The line item price.

accountingCodeIdstring nullable

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

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

Line item unit of measure.

isReceivableboolean nullable

Dictate if this fee is receivable. If not provided, defaults to false.

isTaxableboolean nullable

Dictate if this fee is taxable. If not provided, defaults to false.

taxCodeIdstring nullable

Tax code key identifier. Please reference /api/tax-rates endpoint.

taxRatenumber double nullable

Tax code to use for this entity. If a FulcrumProduct.PublicApi.Dto.PurchaseOrder.FeeLineItem.FeeLineItemUpdateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.PurchaseOrder.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 unit 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.

isReceivableboolean nullable

Dictate if this fee is receivable.

overrideTaxRateboolean nullable

Dictate if the tax rate is overridden.

taxCodeIdstring nullable

Tax code key identifier. Please reference /api/tax-rates endpoint.

taxRatenumber double nullable

Tax code to use for this entity. If a FulcrumProduct.PublicApi.Dto.PurchaseOrder.FeeLineItem.FeeLineItemDto.TaxCodeId is provided and FulcrumProduct.PublicApi.Dto.PurchaseOrder.FeeLineItem.FeeLineItemDto.OverrideTaxRate = true, the provided FulcrumProduct.PublicApi.Dto.PurchaseOrder.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

  • 6fc46fb4f45bRevision changes
    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json)

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status (media type: application/problem+json)

  • 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)