getOffer

Query

Get offer by ID

Query Signature

query {
  getOffer(ogId: String!): GetOfferResponse!
}

Example Request

GraphQL

query GetOffer($ogId: String!) {
  getOffer(ogId: $ogId) {
    # Add fields you want to retrieve
  }
}

Example Variables:

{
  "ogId": "og-offer-123456"
}

Apollo Studio

Open in Apollo Studio Explorer →

Click the link above to open this query in Apollo Studio Explorer with the query pre-filled. You’ll need to authenticate with your sandbox credentials.

Example Response

{
  "data": {
    "getOffer": {
      "data": {
        "id": "og-offer-123456",
        "uwResultId": "uw-xyz789",
        "uwResultRevision": 2,
        "frequency": "M",
        "frequencyInterval": "15",
        "firstPaymentDate": "2025/02/15",
        "paymentTerm": "48",
        "maxPaymentTerm": "60",
        "enrolledDebt": "13500.00",
        "enrollmentPlanId": "plan-standard-48",
        "enrollmentPlanName": "Standard 48-Month Plan",
        "serviceFee": 3375,
        "estimatedSettlementFee": 6750,
        "compTemplateId": 1001,
        "totals": {
          "fee1": "3375.00",
          "fee2": "0.00",
          "fee3": "0.00",
          "fee4": "0.00",
          "fee5": "0.00",
          "fee6": "0.00",
          "fee7": "0.00",
          "savings": "3375.00",
          "totalPayment": "16875.00"
        },
        "payments": [
          {
            "paymentNumber": "1",
            "paymentDate": "2025/02/15",
            "totalPayment": "351.56",
            "fee1": "70.31",
            "fee2": "0.00",
            "fee3": "0.00",
            "fee4": "0.00",
            "fee5": "0.00",
            "fee6": "0.00",
            "fee7": "0.00",
            "savings": "70.31"
          },
          {
            "paymentNumber": "2",
            "paymentDate": "2025/03/15",
            "totalPayment": "351.56",
            "fee1": "70.31",
            "fee2": "0.00",
            "fee3": "0.00",
            "fee4": "0.00",
            "fee5": "0.00",
            "fee6": "0.00",
            "fee7": "0.00",
            "savings": "70.31"
          },
          {
            "paymentNumber": "3",
            "paymentDate": "2025/04/15",
            "totalPayment": "351.56",
            "fee1": "70.31",
            "fee2": "0.00",
            "fee3": "0.00",
            "fee4": "0.00",
            "fee5": "0.00",
            "fee6": "0.00",
            "fee7": "0.00",
            "savings": "70.31"
          }
        ],
        "forthRequestParameters": {
          "epFee1Amount": true,
          "epFee2Monthly": false,
          "epFee3Amount": false,
          "epFee3Monthly": false,
          "epFee4Monthly": false,
          "epFee4Amount": false,
          "epFee5Monthly": false,
          "epFee5Amount": false,
          "firstPaymentDate": "2025/02/15",
          "recurringStartDate": "2025/03/15",
          "epFrequency": "M",
          "epFreqInterval": "15",
          "debt": "13500.00",
          "enrollmentPlan": "plan-standard-48",
          "programMonths": "48",
          "maxPaymentTerm": "60",
          "estSettlement": "6750.00"
        }
      },
      "errors": [
        {
          "message": "OFFER_NOT_FOUND"
        },
        {
          "message": "INTERNAL_SERVER_ERROR"
        }
      ]
    }
  }
}

Arguments

Argument	Type	Description
ogId	String!	TBD

Response Type

Returns: GetOfferResponse!

GetOfferResponse

Field	Type	Description
data	Offer	TBD
errors	[ResponseError]	TBD

Offer

Field	Type	Description
id	String!	TBD
uwResultId	String!	TBD
uwResultRevision	Int!	TBD
frequency	String!	TBD
frequencyInterval	String!	TBD
firstPaymentDate	String!	TBD
paymentTerm	String!	TBD
maxPaymentTerm	String!	TBD
enrolledDebt	String!	TBD
enrollmentPlanId	String!	TBD
enrollmentPlanName	String!	TBD
serviceFee	Int	TBD
estimatedSettlementFee	Int!	TBD
totals	OfferTotals!	TBD
payments	[OfferPayment]!	TBD
forthRequestParameters	ForthRequestParameters!	TBD
compTemplateId	Int	TBD

OfferTotals

Field	Type	Description
fee1	String	TBD
fee2	String	TBD
fee3	String	TBD
fee4	String	TBD
fee5	String	TBD
fee6	String	TBD
fee7	String	TBD
savings	String	TBD
totalPayment	String	TBD

OfferPayment

Field	Type	Description
fee1	String	TBD
fee2	String	TBD
fee3	String	TBD
fee4	String	TBD
fee5	String	TBD
fee6	String	TBD
fee7	String	TBD
paymentDate	String	TBD
paymentNumber	String	TBD
savings	String	TBD
totalPayment	String	TBD

ForthRequestParameters

Field	Type	Description
epFee1Amount	Boolean!	TBD
epFee2Monthly	Boolean!	TBD
epFee3Amount	Boolean!	TBD
epFee3Monthly	Boolean!	TBD
epFee4Monthly	Boolean!	TBD
epFee4Amount	Boolean!	TBD
epFee5Monthly	Boolean!	TBD
epFee5Amount	Boolean!	TBD
firstPaymentDate	String!	TBD
recurringStartDate	String!	TBD
epFrequency	String!	TBD
epFreqInterval	String!	TBD
debt	String!	TBD
enrollmentPlan	String!	TBD
programMonths	String!	TBD
maxPaymentTerm	String!	TBD
estSettlement	String!	TBD

ResponseError

Response Error

Field	Type	Description
message	String	Error message

Error Types

The response may include the following error types:

ResponseError

Response Error

Field	Type	Description
message	String	Error message

Manual Error Documentation

Add service-specific error codes and their resolutions below.

Common Errors

Error Code	Description	Resolution
VALIDATION_ERROR	Input validation failed	Check required fields and formats
UNAUTHORIZED	Invalid or expired token	Re-authenticate and retry
NOT_FOUND	Resource not found	Verify the ID or reference

Related

• Back to Offer Generation