Sign in
Rates

Get all rates

Returns all rates (pricing setups) of the default service provided by the enterprise. Note this operation uses Pagination and supports Portfolio Access Tokens.

post/api/connector/v1/rates/getAll

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

EnterpriseIdsstring[] nullable

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

RateIdsstring[] nullable

Unique identifiers of the requested Rates.

ServiceIdsstring[] required

Unique identifiers of the Services from which the rates are requested.

ExternalIdentifiersstring[] nullable

Identifiers of Rate from external systems.

ActivityStatesActivityStates[] nullable

Whether to return only active, only deleted, or both types of record. If not specified, both active and deleted will be returned.

Response

OK

Cursorstring uuid nullable

Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.

Changes

Changed in 1 of the 10 revisions of this API.3

  • 349059cceec73See the full diff
    • ●

      added the new FR_261_7 enum value to the Rates/items/TaxExemptionReason/allOf[subschema #1: Tax exemption reason type]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new FR_262_00_BIS enum value to the Rates/items/TaxExemptionReason/allOf[subschema #1: Tax exemption reason type]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new FR_293_B enum value to the Rates/items/TaxExemptionReason/allOf[subschema #1: Tax exemption reason type]/ response property for the response status 200

      response-property-enum-value-added