Skip to main content

Arguments

activeAt : DateTime

The datetime to check the applicable rates at.

after : String
agreementId : ID! required

The ID of the agreement.

before : String
first : Int
last : Int

Returns

ApplicableRateConnection

Used by territory plugins (e.g. NLD) for agreement-level applicable_rates fields.

Allowed Viewers

Customer Partner User Third party

Required Permissions

Can query product rates

Query Complexity

1

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Query

query AgreementRates( $activeAt: DateTime, $after: String, $agreementId: ID!, $before: String, $first: Int, $last: Int ) { agreementRates( activeAt: $activeAt, after: $after, agreementId: $agreementId, before: $before, first: $first, last: $last ) { edgeCount edges { ...ApplicableRateEdgeFragment } pageInfo { ...PageInfoFragment } totalCount } }

Variables

{ "activeAt": "2024-06-02T19:35:21.842192+00:00", "after": "YXJyYXljb25uZWN0aW9uOjEw=", "agreementId": "17826402", "before": "YXJyYXljb25uZWN0aW9uOjEw=", "first": 10, "last": 10 }

Response

{ "data": { "agreementRates": { "edgeCount": 76, "edges": [ApplicableRateEdge], "pageInfo": PageInfo, "totalCount": 12 } } }