API - Consumption Line

This page supports access to consumption lines.

Object Definition

Object Type	Page
Object ID	70299121
Object Name	QWEPR API - Consumption Line
Source Table	QWEPR Consumption Line

API Definition

APIPublisher	smartApps
APIGroup	parrot
APIVersion	v1.0
EntitySetName	consumptionLines
EntityName	consumptionLine

Example

Read

Get a list of Consumption Lines.

GET businesscentralPrefix/companies({id})/consumptionLines?$schemaversion=2.0

Get a single Consumption Line.

GET businesscentralPrefix/companies({id})/consumptionLines({id})?$schemaversion=2.0

Create

Create a new Consumption Line. When a new Consumption Line is created, the calculated values in the corresponding contract lines must be updated via bound action CalculateConsumption in Contracts or ContractLines, depending on which entity you want to update consumption for.

POST businesscentralPrefix/companies({id})/consumptionLines?$schemaversion=2.0
Content-Type: application/json
{
    "documentNumber": "T00001",
    "documentLineNumber": "30000",
    "lineNumber": 10000,
    "description": "Description of Consumption Line",
    "quantity": 5
}

Update

Update a Consumption Line.

PATCH businesscentralPrefix/companies({id})/consumptionLines({id})?$schemaversion=2.0
If-Match: {@odata.etag from the POST response}
Content-Type: application/json
{
     "quantity": 5
}

Delete

Delete a Consumption Line.

DELETE businesscentralPrefix/companies({id})/consumptionLines({id})?$schemaversion=2.0

Controls

Type	Name	Data Type	Read-only
Field	id	Guid	Yes
Field	documentType	Enum "QWEPR Contract Document Type"
Field	documentNumber	Code[20]
Field	documentLineNumber	Integer
Field	lineNumber	Integer
Field	description	Text[100]
Field	quantity	Decimal
Field	unitPrice	Decimal
Field	discountPercent	Decimal
Field	chargeableSharePercent	Decimal
Field	chargeableAmount	Decimal
Field	comment	Text[80]
Field	date	Date
Field	dateAndTime	DateTime
Field	blocked	Boolean
Field	transactionId	Text[100]
Field	contractEntryNumber	Integer	Yes
Field	systemCreatedAt	DateTime	Yes
Field	systemCreatedBy	Guid	Yes
Field	lastModifiedDateTime	DateTime	Yes
Field	systemModifiedBy	Guid	Yes

This documentation is generated from Parrot v26.2.242726.0