Dúvida
Como consultar o contrato a partir de seu id
/api/contract/{id}
Esta API é responsável por consultar as informações 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 do contrato correspondente ao id informado.
Modelo do JSON de retorno da API:
{
"Id": 2715,
"AlternateNumber": "vendas sem pedido 4 itens 17 02 2",
"ContractStatusId": 4,
"ContractStatusName": "Ativo",
"ClassificationId": 31,
"ClassificationName": "APAS (Venda)",
"CompanyId": 1,
"CompanyName": "INVENT",
"CardCode": "CL00003",
"CardName": "CLIENTE TESTE",
"GroupNum": 7,
"GroupNumDescription": "45, 90, 135 e 180 dias",
"ContractTypeId": 2,
"ContractTypeDesc": "Cliente",
"DateStart": "2025-02-17T00:00:00",
"DateEnd": "2027-06-26T00:00:00",
"DateConclusion": "2030-09-17T00:00:00",
"DocTotal": 274840,
"MeasurementTotal": 5277.5,
"Balance": 269562.5,
"AdditiveTotal": 0,
"TaxTotal": 0,
"Comments": "Com Rateio, Representantes e Campos de Usuários",
"EngineerId": 3,
"EngineerDesc": "Lucas Couto",
"Guarantee": 0,
"AllowChangePartner": 0,
"CurrentValue": 274840,
"DateAdd": "2025-02-17T00:00:00",
"QuotationId": 0,
"ProjectId": "PR02",
"ProjectDesc": "PROJETO CORES",
"ProBonoRelationShip": 0,
"ExpensesRefund": 0,
"Fine": "",
"AllowAdvance": 0,
"Royalties": 0,
"OrderId": 0,
"ObjectOfTheContract": "",
"RoyaltiesDesc": "",
"SlpCode": 3,
"Header": "",
"Footer": "",
"Currency": "R$",
"CloseWhenBalanceIsZero": 0,
"AvailableProduct": 0,
"TypeDocumentId": -900,
"ObjTypeSbo": 0,
"DocEntrySbo": 0,
"TermInMonths": 0,
"RmvCalculationTypeId": 0,
"RmvCalculationTypeEnum": 0,
"StoreId": 0,
"IntBankInterest": 0,
"IntBankFine": 0,
"ProductSaleReportType": 2,
"InitialMeasurement": 0,
"DisagreementTotal": 0,
"AccountsForParticipation": 0,
"ProductSaleReportTypeEnum": 2,
"CreatedBy": 1,
"CreatedByEnum": 1,
"ApprovalBy": 2,
"ApprovalByEnum": 2,
"Lines": [
{
"Id": 4281,
"ContractId": 2715,
"ContractAdditiveLineId": 0,
"LineNum": 4,
"ItemCode": "SER000018",
"ItemName": "Item Medição",
"Item": {
"ItemName": "Item Medição",
"ItemCode": "SER000018",
"UgpEntry": -1,
"ItmsGrpCod": 100,
"PrchseItem": "Y",
"SellItem": "Y",
"InvntItem": "N",
"OnHand": 0,
"LeadTime": 0,
"SaleItemUnit": "Unidade",
"ItemUnit": "Unidade",
"validFor": "Y",
"DfltWH": "01"
},
"MeasureUnitId": "UN",
"MeasurementById": 1,
"Quantity": 1,
"PriceUnit": 100020,
"LineTotal": 100020,
"InicialBalanceQuantity": 0,
"InicialBalance": 0,
"IsInitialMeasurement": 0,
"Guarantee": 0,
"UsageId": 9,
"BillingType": 1,
"ApportionmentEffectiveId": "CL00003;",
"SlpCode": 0,
"InstallmentsTotal": 0,
"RecurrenceType": 1,
"DueDateBase": "2025-02-17T00:00:00",
"BirthdayDate": "2030-10-10T00:00:00",
"Liberated": 1,
"TaxRate": 100,
"TaxBase": 100020,
"TaxCalcBase": 100020,
"QuantityHired": 0,
"OcrCode": "",
"OcrCode2": "",
"OcrCode3": "",
"OcrCode4": "",
"OcrCode5": "",
"TreeType": 0,
"QuotationLineNum": 0,
"GroupNum": 0,
"WhsCode": "01",
"Delivered": 0,
"PrjCode": "",
"FinancialIndexId": 0,
"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,
"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,
"HasParticipation": false,
"DueDateBaseDay": 0,
"DateBillingBaseDay": 0,
"DisagreedStatusEnum": 0,
"MeasurementByEnum": 1,
"MeasurementBy": "Valor",
"BillingTypeEnum": 1,
"SourceEnum": 1,
"Source": "Contrato",
"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",
"Item": {
"ItemName": "Aluguel",
"ItemCode": "0008",
"UgpEntry": -1,
"ItmsGrpCod": 100,
"PrchseItem": "Y",
"SellItem": "Y",
"InvntItem": "N",
"OnHand": 0,
"BuyUnitMsr": "Und",
"LeadTime": 0,
"SaleItemUnit": "Unidade",
"ItemUnit": "Unidade",
"validFor": "Y",
"DfltWH": "01"
},
"MeasureUnitId": "UN",
"MeasurementById": 1,
"Quantity": 1,
"PriceUnit": 100020,
"LineTotal": 100020,
"InicialBalanceQuantity": 0,
"InicialBalance": 0,
"IsInitialMeasurement": 0,
"Guarantee": 0,
"UsageId": 9,
"BillingType": 2,
"ApportionmentEffectiveId": "CL00003;",
"SlpCode": 0,
"InstallmentsTotal": 24,
"RecurrenceType": 2,
"DueDateBase": "2025-02-17T00:00:00",
"BirthdayDate": "2030-10-10T00:00:00",
"Liberated": 0,
"TaxRate": 100,
"TaxBase": 100020,
"TaxCalcBase": 100020,
"QuantityHired": 0,
"OcrCode": "",
"OcrCode2": "",
"OcrCode3": "",
"OcrCode4": "",
"OcrCode5": "",
"TreeType": 0,
"QuotationLineNum": 0,
"GroupNum": 0,
"WhsCode": "01",
"Delivered": 0,
"PrjCode": "",
"FinancialIndexId": 0,
"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,
"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,
"HasParticipation": false,
"DueDateBaseDay": 0,
"DateBillingBaseDay": 0,
"DisagreedStatusEnum": 0,
"MeasurementByEnum": 1,
"MeasurementBy": "Valor",
"BillingTypeEnum": 2,
"SourceEnum": 1,
"Source": "Contrato",
"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",
"Item": {
"ItemName": "MICROONDAS",
"ItemCode": "I0003",
"UgpEntry": -1,
"ItmsGrpCod": 100,
"PrchseItem": "Y",
"SellItem": "Y",
"InvntItem": "N",
"OnHand": 0,
"LeadTime": 0,
"SaleItemUnit": "Unidade",
"ItemUnit": "Unidade",
"validFor": "Y",
"DfltWH": "01"
},
"MeasureUnitId": "UN",
"MeasurementById": 1,
"Quantity": 1,
"PriceUnit": 100,
"LineTotal": 100,
"InicialBalanceQuantity": 0,
"InicialBalance": 0,
"IsInitialMeasurement": 0,
"Guarantee": 0,
"UsageId": 9,
"BillingType": 3,
"ApportionmentEffectiveId": "CL00003;",
"SlpCode": 0,
"InstallmentsTotal": 68,
"RecurrenceType": 2,
"DueDateBase": "2025-02-17T00:00:00",
"BirthdayDate": "2030-10-10T00:00:00",
"Liberated": 0,
"TaxRate": 100,
"TaxBase": 100,
"TaxCalcBase": 100,
"QuantityHired": 0,
"OcrCode": "",
"OcrCode2": "",
"OcrCode3": "",
"OcrCode4": "",
"OcrCode5": "",
"TreeType": 0,
"QuotationLineNum": 0,
"GroupNum": 0,
"WhsCode": "01",
"Delivered": 0,
"PrjCode": "",
"FinancialIndexId": 0,
"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,
"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,
"HasParticipation": false,
"DueDateBaseDay": 0,
"DateBillingBaseDay": 0,
"DisagreedStatusEnum": 0,
"MeasurementByEnum": 1,
"MeasurementBy": "Valor",
"BillingTypeEnum": 3,
"SourceEnum": 1,
"Source": "Contrato",
"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",
"Item": {
"ItemName": "GÁS",
"ItemCode": "I0002",
"UgpEntry": -1,
"ItmsGrpCod": 100,
"PrchseItem": "Y",
"SellItem": "Y",
"InvntItem": "N",
"OnHand": 0,
"LeadTime": 0,
"SaleItemUnit": "Unidade",
"ItemUnit": "Unidade",
"validFor": "Y"
},
"MeasureUnitId": "UN",
"MeasurementById": 1,
"Quantity": 1,
"PriceUnit": 1000,
"LineTotal": 1000,
"InicialBalanceQuantity": 0,
"InicialBalance": 0,
"IsInitialMeasurement": 0,
"Guarantee": 0,
"UsageId": 9,
"BillingType": 5,
"ApportionmentEffectiveId": "CL00003;",
"SlpCode": 0,
"InstallmentsTotal": 68,
"RecurrenceType": 2,
"DueDateBase": "2025-02-17T00:00:00",
"BirthdayDate": "2030-10-10T00:00:00",
"Liberated": 0,
"TaxRate": 100,
"TaxBase": 1000,
"TaxCalcBase": 1000,
"QuantityHired": 0,
"OcrCode": "",
"OcrCode2": "",
"OcrCode3": "",
"OcrCode4": "",
"OcrCode5": "",
"TreeType": 0,
"QuotationLineNum": 0,
"GroupNum": 0,
"WhsCode": "01",
"Delivered": 0,
"PrjCode": "",
"FinancialIndexId": 0,
"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,
"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,
"HasParticipation": false,
"DueDateBaseDay": 0,
"DateBillingBaseDay": 0,
"DisagreedStatusEnum": 0,
"MeasurementByEnum": 1,
"MeasurementBy": "Valor",
"BillingTypeEnum": 5,
"SourceEnum": 1,
"Source": "Contrato",
"RecurrenceTypeEnum": 2,
"ReadjustmentValueTypeEnum": 0,
"UseListItemsEnum": 0,
"CalculationTypeEnum": 0,
"SaleRepRangeTypeEnum": 0,
"SaleReportValueSourceEnum": 0,
"ProductPriceSourceEnum": 0,
"GuaranteedMinimumTypeEnum": 0,
"UserFields": [],
"UserFieldColumns": {},
"UserFieldsTemp": []
}
],
"Additives": [],
"Taxes": [],
"Discounts": [],
"Documents": [
{
"Id": 6930,
"TypeDocumentId": 9,
"ContractId": 2715,
"Description": "doc 5",
"NeedAttach": 0,
"NeedAttachInTheLastMeasurement": 0,
"Attachments": [],
"PaymentBlock": 0
}
],
"Deliveries": [],
"Representatives": [],
"UserFieldsTemp": [],
"ObjTypeSboEnum": 0,
"ContractTypeEnum": 2,
"ContractStatusEnum": 4,
"PaymentMethod": "TES_23",
"PaymentMethodDescription": "TESTE"
}