ContractPlus APIs | Consultar Linhas do Contrato pelo ID.
21 min
Criado por Eduardo Martins Dos Santos em 20/02/2025 08:35
Atualizado por Eduardo Martins Dos Santos em 20/02/2025 08:38

Dúvida
Como consultar as linhas do contrato a partir de seu id

/api/contract/Lines/{id} 

Esta API é responsável por consultar as informações das linhas do contrato a partir de seu id.

Inserção obrigatória
id (Código do contrato.)

Preencha o campo com o id do contrato e execute a API.


Serão retornadas as informações das linhas do contrato correspondente ao id informado.


Modelo do JSON retornado pela API:

[
  {
    "Id": 4281,
    "ContractId": 2715,
    "ContractAdditiveLineId": 0,
    "LineNum": 4,
    "ItemCode": "SER000018",
    "ItemName": "Item Medição",
    "MeasureUnitId": "UN",
    "MeasurementById": 1,
    "MeasurementByIdDesc": "Valor",
    "Quantity": 1,
    "PriceUnit": 100020,
    "LineTotal": 100020,
    "InicialBalanceQuantity": 0,
    "InicialBalance": 0,
    "IsInitialMeasurement": 0,
    "Guarantee": 0,
    "UsageId": 9,
    "UsageName": "Venda Prod. Própria",
    "BillingType": 1,
    "ApportionmentEffectiveId": "CL00003;",
    "SlpCode": 0,
    "SlpNameDesc": "",
    "InstallmentsTotal": 0,
    "RecurrenceType": 1,
    "RecurrenceTypeDesc": "Não se aplica",
    "DueDateBase": "2025-02-17T00:00:00",
    "BirthdayDate": "2030-10-10T00:00:00",
    "Liberated": 1,
    "TaxRate": 100,
    "TaxBase": 100020,
    "TaxCalcBase": 100020,
    "QuantityHired": 0,
    "OcrCode": "",
    "OcrCodeDesc": "",
    "OcrCode2": "",
    "OcrCode3": "",
    "OcrCode4": "",
    "OcrCode5": "",
    "TreeType": 0,
    "QuotationLineNum": 0,
    "GroupNum": 0,
    "WhsCode": "01",
    "WhsCodeDesc": "Depósito geral",
    "Delivered": 0,
    "PrjCode": "",
    "PrjCodeDesc": "",
    "FinancialIndexId": 0,
    "FinancialIndexDesc": "",
    "Readjusted": 0,
    "Segment": "",
    "ParticipationPercent": 0,
    "ByParticipation": 0,
    "ContractLineRefId": 0,
    "DocumentLineSheetId": 0,
    "LineProcessType": 0,
    "ReadjustmentValueType": 0,
    "LineItems": [],
    "Installments": [],
    "Apportionments": [],
    "SaleRepRanges": [],
    "Negotiations": [],
    "QuantityBalance": 0.9999,
    "LineTotalBalance": 100010,
    "ContractAdditiveId": 0,
    "SourceId": 1,
    "SourceDesc": "Contrato",
    "UseListItems": 0,
    "CalculationTypeId": 0,
    "Guaranteed": 0,
    "GuaranteedSeq": 0,
    "Prorated": 0,
    "ProratedBaseValue": 0,
    "SaleRepRangeType": 0,
    "SaleReportValueSource": 0,
    "SaleReportValueBase": 0,
    "ChargeNegativeBalance": 0,
    "ProductPriceSource": 0,
    "GuaranteedMinimumType": 0,
    "ReferenceDate": "2024-07-15T00:00:00",
    "DisagreedStatusId": 0,
    "CalcDaysProratedFromLastInst": false,
    "AdditiveNewTotalBalance": 0,
    "AdditiveByParticipation": 0,
    "BillingTypeDesc": "Medição",
    "HasParticipation": false,
    "DueDateBaseDay": 0,
    "DateBillingBaseDay": 0,
    "DisagreedStatusEnum": 0,
    "MeasurementByEnum": 1,
    "BillingTypeEnum": 1,
    "SourceEnum": 1,
    "RecurrenceTypeEnum": 1,
    "ReadjustmentValueTypeEnum": 0,
    "UseListItemsEnum": 0,
    "CalculationTypeEnum": 0,
    "SaleRepRangeTypeEnum": 0,
    "SaleReportValueSourceEnum": 0,
    "ProductPriceSourceEnum": 0,
    "GuaranteedMinimumTypeEnum": 0,
    "UserFields": [],
    "UserFieldColumns": {},
    "UserFieldsTemp": []
  },
  {
    "Id": 4278,
    "ContractId": 2715,
    "ContractAdditiveLineId": 0,
    "LineNum": 1,
    "ItemCode": "0008",
    "ItemName": "Aluguel",
    "MeasureUnitId": "UN",
    "MeasurementById": 1,
    "MeasurementByIdDesc": "Valor",
    "Quantity": 1,
    "PriceUnit": 100020,
    "LineTotal": 100020,
    "InicialBalanceQuantity": 0,
    "InicialBalance": 0,
    "IsInitialMeasurement": 0,
    "Guarantee": 0,
    "UsageId": 9,
    "UsageName": "Venda Prod. Própria",
    "BillingType": 2,
    "ApportionmentEffectiveId": "CL00003;",
    "SlpCode": 0,
    "SlpNameDesc": "",
    "InstallmentsTotal": 24,
    "RecurrenceType": 2,
    "RecurrenceTypeDesc": "Mensal",
    "DueDateBase": "2025-02-17T00:00:00",
    "BirthdayDate": "2030-10-10T00:00:00",
    "Liberated": 0,
    "TaxRate": 100,
    "TaxBase": 100020,
    "TaxCalcBase": 100020,
    "QuantityHired": 0,
    "OcrCode": "",
    "OcrCodeDesc": "",
    "OcrCode2": "",
    "OcrCode3": "",
    "OcrCode4": "",
    "OcrCode5": "",
    "TreeType": 0,
    "QuotationLineNum": 0,
    "GroupNum": 0,
    "WhsCode": "01",
    "WhsCodeDesc": "Depósito geral",
    "Delivered": 0,
    "PrjCode": "",
    "PrjCodeDesc": "",
    "FinancialIndexId": 0,
    "FinancialIndexDesc": "",
    "Readjusted": 0,
    "Segment": "",
    "ParticipationPercent": 0,
    "ByParticipation": 0,
    "ContractLineRefId": 0,
    "DocumentLineSheetId": 0,
    "LineProcessType": 0,
    "ReadjustmentValueType": 0,
    "LineItems": [],
    "Installments": [],
    "Apportionments": [],
    "SaleRepRanges": [],
    "Negotiations": [],
    "QuantityBalance": 0.958333,
    "LineTotalBalance": 95852.5,
    "ContractAdditiveId": 0,
    "SourceId": 1,
    "SourceDesc": "Contrato",
    "UseListItems": 0,
    "CalculationTypeId": 0,
    "Guaranteed": 0,
    "GuaranteedSeq": 0,
    "Prorated": 0,
    "ProratedBaseValue": 0,
    "SaleRepRangeType": 0,
    "SaleReportValueSource": 0,
    "SaleReportValueBase": 0,
    "ChargeNegativeBalance": 0,
    "ProductPriceSource": 0,
    "GuaranteedMinimumType": 0,
    "ReferenceDate": "2024-07-15T00:00:00",
    "DisagreedStatusId": 0,
    "CalcDaysProratedFromLastInst": false,
    "AdditiveNewTotalBalance": 0,
    "AdditiveByParticipation": 0,
    "BillingTypeDesc": "Parcelado",
    "HasParticipation": false,
    "DueDateBaseDay": 0,
    "DateBillingBaseDay": 0,
    "DisagreedStatusEnum": 0,
    "MeasurementByEnum": 1,
    "BillingTypeEnum": 2,
    "SourceEnum": 1,
    "RecurrenceTypeEnum": 2,
    "ReadjustmentValueTypeEnum": 0,
    "UseListItemsEnum": 0,
    "CalculationTypeEnum": 0,
    "SaleRepRangeTypeEnum": 0,
    "SaleReportValueSourceEnum": 0,
    "ProductPriceSourceEnum": 0,
    "GuaranteedMinimumTypeEnum": 0,
    "UserFields": [],
    "UserFieldColumns": {},
    "UserFieldsTemp": []
  },
  {
    "Id": 4279,
    "ContractId": 2715,
    "ContractAdditiveLineId": 0,
    "LineNum": 2,
    "ItemCode": "I0003",
    "ItemName": "MICROONDAS",
    "MeasureUnitId": "UN",
    "MeasurementById": 1,
    "MeasurementByIdDesc": "Valor",
    "Quantity": 1,
    "PriceUnit": 100,
    "LineTotal": 100,
    "InicialBalanceQuantity": 0,
    "InicialBalance": 0,
    "IsInitialMeasurement": 0,
    "Guarantee": 0,
    "UsageId": 9,
    "UsageName": "Venda Prod. Própria",
    "BillingType": 3,
    "ApportionmentEffectiveId": "CL00003;",
    "SlpCode": 0,
    "SlpNameDesc": "",
    "InstallmentsTotal": 68,
    "RecurrenceType": 2,
    "RecurrenceTypeDesc": "Mensal",
    "DueDateBase": "2025-02-17T00:00:00",
    "BirthdayDate": "2030-10-10T00:00:00",
    "Liberated": 0,
    "TaxRate": 100,
    "TaxBase": 100,
    "TaxCalcBase": 100,
    "QuantityHired": 0,
    "OcrCode": "",
    "OcrCodeDesc": "",
    "OcrCode2": "",
    "OcrCode3": "",
    "OcrCode4": "",
    "OcrCode5": "",
    "TreeType": 0,
    "QuotationLineNum": 0,
    "GroupNum": 0,
    "WhsCode": "01",
    "WhsCodeDesc": "Depósito geral",
    "Delivered": 0,
    "PrjCode": "",
    "PrjCodeDesc": "",
    "FinancialIndexId": 0,
    "FinancialIndexDesc": "",
    "Readjusted": 0,
    "Segment": "",
    "ParticipationPercent": 0,
    "ByParticipation": 0,
    "ContractLineRefId": 0,
    "DocumentLineSheetId": 0,
    "LineProcessType": 0,
    "ReadjustmentValueType": 0,
    "LineItems": [],
    "Installments": [],
    "Apportionments": [],
    "SaleRepRanges": [],
    "Negotiations": [],
    "QuantityBalance": 67,
    "LineTotalBalance": 6700,
    "ContractAdditiveId": 0,
    "SourceId": 1,
    "SourceDesc": "Contrato",
    "UseListItems": 0,
    "CalculationTypeId": 0,
    "Guaranteed": 0,
    "GuaranteedSeq": 0,
    "Prorated": 0,
    "ProratedBaseValue": 0,
    "SaleRepRangeType": 0,
    "SaleReportValueSource": 0,
    "SaleReportValueBase": 0,
    "ChargeNegativeBalance": 0,
    "ProductPriceSource": 0,
    "GuaranteedMinimumType": 0,
    "ReferenceDate": "2024-07-01T00:00:00",
    "DisagreedStatusId": 0,
    "CalcDaysProratedFromLastInst": false,
    "AdditiveNewTotalBalance": 0,
    "AdditiveByParticipation": 0,
    "BillingTypeDesc": "Recorrente",
    "HasParticipation": false,
    "DueDateBaseDay": 0,
    "DateBillingBaseDay": 0,
    "DisagreedStatusEnum": 0,
    "MeasurementByEnum": 1,
    "BillingTypeEnum": 3,
    "SourceEnum": 1,
    "RecurrenceTypeEnum": 2,
    "ReadjustmentValueTypeEnum": 0,
    "UseListItemsEnum": 0,
    "CalculationTypeEnum": 0,
    "SaleRepRangeTypeEnum": 0,
    "SaleReportValueSourceEnum": 0,
    "ProductPriceSourceEnum": 0,
    "GuaranteedMinimumTypeEnum": 0,
    "UserFields": [],
    "UserFieldColumns": {},
    "UserFieldsTemp": []
  },
  {
    "Id": 4280,
    "ContractId": 2715,
    "ContractAdditiveLineId": 0,
    "LineNum": 3,
    "ItemCode": "I0002",
    "ItemName": "GÁS",
    "MeasureUnitId": "UN",
    "MeasurementById": 1,
    "MeasurementByIdDesc": "Valor",
    "Quantity": 1,
    "PriceUnit": 1000,
    "LineTotal": 1000,
    "InicialBalanceQuantity": 0,
    "InicialBalance": 0,
    "IsInitialMeasurement": 0,
    "Guarantee": 0,
    "UsageId": 9,
    "UsageName": "Venda Prod. Própria",
    "BillingType": 5,
    "ApportionmentEffectiveId": "CL00003;",
    "SlpCode": 0,
    "SlpNameDesc": "",
    "InstallmentsTotal": 68,
    "RecurrenceType": 2,
    "RecurrenceTypeDesc": "Mensal",
    "DueDateBase": "2025-02-17T00:00:00",
    "BirthdayDate": "2030-10-10T00:00:00",
    "Liberated": 0,
    "TaxRate": 100,
    "TaxBase": 1000,
    "TaxCalcBase": 1000,
    "QuantityHired": 0,
    "OcrCode": "",
    "OcrCodeDesc": "",
    "OcrCode2": "",
    "OcrCode3": "",
    "OcrCode4": "",
    "OcrCode5": "",
    "TreeType": 0,
    "QuotationLineNum": 0,
    "GroupNum": 0,
    "WhsCode": "01",
    "WhsCodeDesc": "Depósito geral",
    "Delivered": 0,
    "PrjCode": "",
    "PrjCodeDesc": "",
    "FinancialIndexId": 0,
    "FinancialIndexDesc": "",
    "Readjusted": 0,
    "Segment": "",
    "ParticipationPercent": 0,
    "ByParticipation": 0,
    "ContractLineRefId": 0,
    "DocumentLineSheetId": 0,
    "LineProcessType": 0,
    "ReadjustmentValueType": 0,
    "LineItems": [],
    "Installments": [],
    "Apportionments": [],
    "SaleRepRanges": [],
    "Negotiations": [],
    "QuantityBalance": 67,
    "LineTotalBalance": 67000,
    "ContractAdditiveId": 0,
    "SourceId": 1,
    "SourceDesc": "Contrato",
    "UseListItems": 0,
    "CalculationTypeId": 0,
    "Guaranteed": 0,
    "GuaranteedSeq": 0,
    "Prorated": 0,
    "ProratedBaseValue": 0,
    "SaleRepRangeType": 0,
    "SaleReportValueSource": 0,
    "SaleReportValueBase": 0,
    "ChargeNegativeBalance": 0,
    "ProductPriceSource": 0,
    "GuaranteedMinimumType": 0,
    "ReferenceDate": "2024-08-31T00:00:00",
    "DisagreedStatusId": 0,
    "CalcDaysProratedFromLastInst": false,
    "AdditiveNewTotalBalance": 0,
    "AdditiveByParticipation": 0,
    "BillingTypeDesc": "Parcelado Medido",
    "HasParticipation": false,
    "DueDateBaseDay": 0,
    "DateBillingBaseDay": 0,
    "DisagreedStatusEnum": 0,
    "MeasurementByEnum": 1,
    "BillingTypeEnum": 5,
    "SourceEnum": 1,
    "RecurrenceTypeEnum": 2,
    "ReadjustmentValueTypeEnum": 0,
    "UseListItemsEnum": 0,
    "CalculationTypeEnum": 0,
    "SaleRepRangeTypeEnum": 0,
    "SaleReportValueSourceEnum": 0,
    "ProductPriceSourceEnum": 0,
    "GuaranteedMinimumTypeEnum": 0,
    "UserFields": [],
    "UserFieldColumns": {},
    "UserFieldsTemp": []
  }
]


Este artigo foi útil para você?
Últimos artigos visitados