Invoice Refund Line Item

Get a specific refund line item for an invoice

Changed on
get/api/invoices/{invoiceId}/refund-line-items/{lineItemId}

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/invoices/{invoiceId}/refund-line-items/{lineItemId}
  • Auth
    none declared

Path parameters

invoiceIdstring required
lineItemIdstring required

Response

Refund line item

idstring required

Unique id associated to this entity.

quantitynumber double required

The line item quantity

pricenumber double required

The line item price.

itemIdstring required

Item id associated with this line item.

namestring required

The name of the line item. Defaults to the item's description if none specified.

descriptionstring nullable

The refund line item description. Defaults to the item's description if none specified.

externalReferencesobject nullable

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

salesOrderLineItemIdstring required

Id that references the sales order line item that was refunded.

accountingCodeIdstring nullable

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

numberinteger

Line number

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)

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