API - Contract Lines
This page supports access to contracts lines.
Object Definition
| Object Type | Page |
| Object ID | 70299111 |
| Object Name | QWEPR API - Contract Lines |
| Source Table | QWEPR Contract Line |
API Definition
| APIPublisher | smartApps |
| APIGroup | parrot |
| APIVersion | v1.0 |
| EntitySetName | contractLines |
| EntityName | contractLine |
Service Enabled Procedures
| Name | Description |
|---|---|
| CalculateConsumption(WebServiceActionContext) | Calculate consumption for a contract line. |
Example
Read
Get a list of Contract Lines.
GET businesscentralPrefix/companies({id})/contractLines?$schemaversion=2.0
Get a single Contract Line.
GET businesscentralPrefix/companies({id})/contractLines({id})?$schemaversion=2.0
Create
Create a new Contract Line.
POST businesscentralPrefix/companies({id})/contratcsLines?$schemaversion=2.0
Content-Type: application/json
{
"documentNumber": "T00001",
"lineNumber": "30000",
"type": "Item",
"number": "1896-S",
"quantity": 4
}
Update
Update a Contract Line.
PATCH businesscentralPrefix/companies({id})/contractLines({id})?$schemaversion=2.0
If-Match: {@odata.etag from the POST response}
Content-Type: application/json
{
"quantity": 5
}
Controls
| Type | Name | Data Type | Read-only |
|---|---|---|---|
| Field | id | Guid | Yes |
| Field | documentNumber | Code[20] | |
| Field | lineNumber | Integer | |
| Field | type | Enum "QWEPR Contract Line Type" | |
| Field | number | Code[20] | |
| Field | description | Text[100] | |
| Field | description2 | Text[50] | |
| Field | locationCode | Code[10] | |
| Field | jobNumber | Code[20] | |
| Field | jobTaskNumber | Code[20] | |
| Field | quantity | Decimal | |
| Field | unitOfMeasureCode | Code[10] | |
| Field | sublineType | Enum "QWEPR Subline Type" | |
| Field | consumptionSumType | Enum "QWEPR Consumption Sum Type" | |
| Field | contractUniquePrice | Boolean | |
| Field | unitPrice | Decimal | |
| Field | lineDiscountPercent | Decimal | |
| Field | lineDiscountAmount | Decimal | Yes |
| Field | amount | Decimal | Yes |
| Field | autoAccGroup | Code[10] | |
| Field | deferralCode | Code[10] | |
| Field | blocked | Option | |
| Field | startingDate | Date | |
| Field | endingDate | Date | |
| Field | latestPostingDate | Date | Yes |
| Field | invoicingInterval | DateFormula | |
| Field | nextPostingDate | Date | |
| Field | shortcutDimension1Code | Code[20] | |
| Field | shortcutDimension2Code | Code[20] | |
| Field | dimensionSetId | Integer | Yes |
| Field | calculatedAmount | Decimal | Yes |
| Field | calculatedAmountLCY | Decimal | Yes |
| Field | calculatedAt | DateTime | 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