Vouchers

Get all vouchers

Returns all rate vouchers filtered by Service, voucher code or voucher identifier. Note this operation uses Pagination and supports Portfolio Access Tokens.

Request

[PlatformAddress]/api/connector/v1/vouchers/getAll

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "Extent": {
    "Vouchers": true,
    "VoucherCodes": true,
    "VoucherAssignments": true,
    "Companies": false,
    "Rates": false
  },
  "ServiceIds": [
    "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
    "8c1bd738-a505-4b29-aa71-9ecc2982b843"
  ],
  "VoucherIds": [
    "fe568bbd-1ecb-4bb2-bf77-96c3698de20d"
  ],
  "VoucherCodeValues": [
    "TEST-VOUCHER-CODE"
  ],
  "ActivityStates": [
    "Active"
  ],
  "UpdatedUtc": {
    "StartUtc": "2023-10-10T00:00:00Z",
    "EndUtc": "2023-10-17T00:00:00Z"
  },
  "ExternalIdentifiers": [
    "Voucher-001",
    "Voucher-002"
  ],
  "EnterpriseIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "4d0201db-36f5-428b-8d11-4f0a65e960cc"
  ],
  "Limitation": {
    "Count": 100
  }
}

Property	Type	Contract	Description
ClientToken	string	required	Token identifying the client application.
AccessToken	string	required	Access token of the client application.
Client	string	required	Name and version of the client application.
EnterpriseIds	array of string	optional, max 1000 items	Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
Extent	Voucher Extent	required	Extent of data to be returned. Whether only specific voucher info should be returned or related items as well.
ServiceIds	array of string	required, max 1000 items	Unique identifiers of Services where the vouchers belong to.
VoucherIds	array of string	optional, max 1000 items	Unique identifiers of vouchers.
CompanyIds	array of string	optional, max 1000 items	Unique identifiers of the companies.
VoucherCodeValues	array of string	optional, max 1000 items	Value of voucher codes used by customers.
ActivityStates	array of Activity state	optional	Whether to return only active, only deleted, or both types of record. If not specified, both active and deleted records will be returned.
UpdatedUtc	Time interval	optional, max length 3 months
ExternalIdentifiers	array of string	optional, max 1000 items	Identifiers of Voucher from external systems.
Limitation	Limitation	required	Limitation on the quantity of data returned and optional Cursor for the starting point of data.

Voucher Extent

Extent of data to be returned. Whether only specific voucher info should be returned or related items as well.

Property	Type	Contract	Description
Vouchers	boolean	optional	Whether the response should contain main information about vouchers.
VoucherAssignments	boolean	optional	Whether the response should contain assignments between vouchers and Rates.
Rates	boolean	optional	Whether the response should contain detail of assigned rates.
VoucherCodes	boolean	optional	Whether the response should contain voucher codes used by customers. Deprecated! Use voucherCodes/getAll
Companies	boolean	optional	Whether the response should contain detail of related companies. Deprecated! Use companies/getAll

Response

{
  "Vouchers": [
    {
      "Id": "fe568bbd-1ecb-4bb2-bf77-96c3698de20d",
      "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
      "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Name": "Weekend Voucher",
      "CreatedUtc": "2018-11-29T08:17:05Z",
      "UpdatedUtc": "2020-10-30T13:38:49Z",
      "Type": "Public",
      "ActivityState": "Active",
      "CompanyId": "c6f5c82d-621a-4c8a-903b-1b0a9a23b71f",
      "TravelAgencyId": null,
      "OccupiableIntervalStartUtc": null,
      "OccupiableIntervalEndUtc": null,
      "ExternalIdentifier": "VCHR-278",
      "IsActive": true
    }
  ],
  "VoucherCodes": [
    {
      "Id": "11111111-1111-1111-1111-111111111111",
      "VoucherId": "fe568bbd-1ecb-4bb2-bf77-96c3698de20d",
      "Value": "TEST-VOUCHER-CODE",
      "ValidityStartUtc": null,
      "ValidityEndUtc": null,
      "CreatedUtc": "2020-10-30T13:37:16Z",
      "UpdatedUtc": "2020-10-30T13:37:16Z",
      "ActivityState": "Active",
      "IsActive": true
    },
    {
      "Id": "22222222-2222-2222-2222-222222222222",
      "VoucherId": "fe568bbd-1ecb-4bb2-bf77-96c3698de20d",
      "Value": "05400269B23A59C649E4",
      "ValidityStartUtc": "2020-10-09T22:00:00Z",
      "ValidityEndUtc": "2020-10-09T22:00:00Z",
      "CreatedUtc": "2020-10-09T15:08:14Z",
      "UpdatedUtc": "2020-10-09T15:08:14Z",
      "ActivityState": "Active",
      "IsActive": true
    }
  ],
  "VoucherAssignments": [
    {
      "VoucherId": "fe568bbd-1ecb-4bb2-bf77-96c3698de20d",
      "RateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda"
    },
    {
      "VoucherId": "fe568bbd-1ecb-4bb2-bf77-96c3698de20d",
      "RateId": "b7e6a1c2-4f3a-4e2b-9c1d-2a5e7b8c9d0f"
    }
  ],
  "Rates": null,
  "Companies": null,
  "Cursor": "fe568bbd-1ecb-4bb2-bf77-96c3698de20d"
}

Property	Type	Contract	Description
Vouchers	array of Voucher	optional	Details about vouchers added to the system.
VoucherCodes	array of Voucher code	optional	Information about voucher codes used by customers.
VoucherAssignments	array of Voucher assignment	optional	The assignments between vouchers and Rates.
Rates	array of Rate for extent	optional	The assigned rates.
Companies	array of Company	optional	The related companies and travel agencies.
Cursor	string	optional	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.

Voucher

Property	Type	Contract	Description
Id	string	required	Unique identifier of voucher.
ServiceId	string	required	Unique identifier of Service the voucher belongs to.
EnterpriseId	string	required	Unique identifier of the enterprise to which the voucher belongs.
Name	string	required, max length 128 characters	Internal name of the voucher.
CreatedUtc	string	required	Creation date and time of the voucher in UTC timezone in ISO 8601 format.
UpdatedUtc	string	required	Last update date and time of the voucher in UTC timezone in ISO 8601 format.
Type	Voucher Type	required	Type of the voucher.
CompanyId	string	optional	Unique identifier of Company the voucher is related to.
TravelAgencyId	string	optional	Unique identifier of Company with Travel agency contract the voucher is related to.
OccupiableIntervalStartUtc	string	optional	Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format.
OccupiableIntervalEndUtc	string	optional	End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format.
ExternalIdentifier	string	optional, max length 255 characters	Identifier of the voucher from external system.
IsActive	boolean	required	Whether the voucher is still active.
ActivityState	Activity state	required	Whether voucher is active or deleted. Deprecated! Use IsActive instead.

Voucher Type

• Public

• PartnerCompany

• TravelAgency

Voucher assignment

Property	Type	Contract	Description
VoucherId	string	required	Unique identifier of Voucher.
RateId	string	required	Unique identifier of Rate the voucher is assigned with.

Add vouchers

Adds the specified vouchers to the specified Services. Note this operation supports Portfolio Access Tokens.

Request

[PlatformAddress]/api/connector/v1/vouchers/add

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "VoucherParameters": [
    {
      "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
      "Name": "Weekend Voucher",
      "Type": "Public",
      "AssignedRateIds": [
        "ed4b660b-19d0-434b-9360-a4de2ea42eda",
        "b7e6a1c2-4f3a-4e2b-9c1d-2a5e7b8c9d0f"
      ]
    },
    {
      "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
      "Name": "Sample company voucher",
      "Type": "PartnerCompany",
      "CompanyId": "c6f5c82d-621a-4c8a-903b-1b0a9a23b71f",
      "AssignedRateIds": [
        "ed4b660b-19d0-434b-9360-a4de2ea42eda",
        "b7e6a1c2-4f3a-4e2b-9c1d-2a5e7b8c9d0f"
      ],
      "OccupiableIntervalStartUtc": "2023-12-31T22:00:00Z",
      "OccupiableIntervalEndUtc": "2024-01-01T22:00:00Z",
      "ExternalIdentifier": "VCHR-278"
    }
  ],
  "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Property	Type	Contract	Description
ClientToken	string	required	Token identifying the client application.
AccessToken	string	required	Access token of the client application.
Client	string	required	Name and version of the client application.
EnterpriseId	string	optional	Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.
VoucherParameters	array of Voucher Parameters	required, max 1000 items	Vouchers to be added.

Voucher Parameters

Property	Type	Contract	Description
ServiceId	string	required	Unique identifier of Service.
Name	string	required, max length 128 characters	Internal name of the voucher.
Type	Voucher Type	required	Type of the voucher.
CompanyId	string	optional	Unique identifier of Company.
AssignedRateIds	array of string	optional, max 10 items	Unique identifiers of Rates.
OccupiableIntervalStartUtc	string	optional	Start of the interval in which the voucher can be applied.
OccupiableIntervalEndUtc	string	optional	End of the interval in which the voucher can be applied.
ExternalIdentifier	string	optional, max length 255 characters	Identifier of the voucher from external system.

Response

{
  "Vouchers": [
    {
      "Id": "fe568bbd-1ecb-4bb2-bf77-96c3698de20d",
      "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
      "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Name": "Weekend Voucher",
      "CreatedUtc": "2018-11-29T08:17:05Z",
      "UpdatedUtc": "2020-10-30T13:38:49Z",
      "Type": "Public",
      "ActivityState": "Active",
      "CompanyId": "c6f5c82d-621a-4c8a-903b-1b0a9a23b71f",
      "TravelAgencyId": null,
      "OccupiableIntervalStartUtc": null,
      "OccupiableIntervalEndUtc": null,
      "ExternalIdentifier": "VCHR-278",
      "IsActive": true
    },
    {
      "Id": "f4a9942c-2616-4074-b1f4-4b959515e933",
      "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
      "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Name": "Sample company voucher",
      "CreatedUtc": "2023-12-01T08:17:05Z",
      "UpdatedUtc": "2023-12-02T13:38:49Z",
      "Type": "PartnerCompany",
      "ActivityState": "Active",
      "CompanyId": "c6f5c82d-621a-4c8a-903b-1b0a9a23b71f",
      "TravelAgencyId": null,
      "OccupiableIntervalStartUtc": "2023-12-31T22:00:00Z",
      "OccupiableIntervalEndUtc": "2024-01-01T22:00:00Z",
      "ExternalIdentifier": "VCHR-278",
      "IsActive": true
    }
  ]
}

Property	Type	Contract	Description
Vouchers	array of Voucher	optional	Details about vouchers added to the system.

Update vouchers

Updates information about the specified vouchers. Note this operation supports Portfolio Access Tokens.

Request

[PlatformAddress]/api/connector/v1/vouchers/update

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "VoucherUpdates": [
    {
      "VoucherId": "fe568bbd-1ecb-4bb2-bf77-96c3698de20d",
      "Name": {
        "Value": "Weekend Voucher"
      },
      "Type": {
        "Value": "Public"
      },
      "AssignedRateIds": {
        "Value": [
          "ed4b660b-19d0-434b-9360-a4de2ea42eda",
          "b7e6a1c2-4f3a-4e2b-9c1d-2a5e7b8c9d0f"
        ]
      }
    },
    {
      "VoucherId": "f4a9942c-2616-4074-b1f4-4b959515e933",
      "Name": {
        "Value": "Sample company voucher"
      },
      "Type": {
        "Value": "PartnerCompany"
      },
      "CompanyId": {
        "Value": "c6f5c82d-621a-4c8a-903b-1b0a9a23b71f"
      },
      "AssignedRateIds": {
        "Value": [
          "ed4b660b-19d0-434b-9360-a4de2ea42eda",
          "b7e6a1c2-4f3a-4e2b-9c1d-2a5e7b8c9d0f"
        ]
      },
      "OccupiableIntervalStartUtc": {
        "Value": "2023-12-31T22:00:00Z"
      },
      "OccupiableIntervalEndUtc": {
        "Value": "2024-01-01T22:00:00Z"
      },
      "ExternalIdentifier": {
        "Value": "VCHR-278"
      }
    }
  ],
  "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Property	Type	Contract	Description
ClientToken	string	required	Token identifying the client application.
AccessToken	string	required	Access token of the client application.
Client	string	required	Name and version of the client application.
EnterpriseId	string	optional	Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.
VoucherUpdates	array of Vouchers update parameters	required, max 1000 items	Details of voucher updates.

Vouchers update parameters

Property	Type	Contract	Description
VoucherId	string	required	Unique identifier of the Voucher.
Name	String update value	optional, max length 128 characters	Internal name of the voucher (or null if the name should not be updated).
Type	Voucher Type update value	optional	Type of the voucher e.g. 'Public', 'PartnerCompany' or 'TravelAgency' (or null if the type should not be updated).
CompanyId	String update value	optional	Unique identifier of Company (Company or Travel Agency) the voucher is related to. This is required for Type of PartnerCompany or TravelAgency. Use null if Company should not be updated.
AssignedRateIds	Assigned rate ids	optional	Unique identifiers of Rates (or null should it not be updated).
OccupiableIntervalStartUtc	String update value	optional	Start of the interval in which the voucher can be applied (or null if the start time should not be updated).
OccupiableIntervalEndUtc	String update value	optional	End of the interval in which the voucher can be applied (or null if the end time should not be updated).
ExternalIdentifier	String update value	optional, max length 255 characters	Identifier of the voucher from external system (or null if the identifier should not be updated).

Assigned rate ids

Has same structure as Array of strings update value.

Property	Type	Contract	Description
Value	array of string	optional, max 10 items	Unique identifiers of Rates (or null should it not be updated).

Response

{
  "Vouchers": [
    {
      "Id": "fe568bbd-1ecb-4bb2-bf77-96c3698de20d",
      "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
      "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Name": "Weekend Voucher",
      "CreatedUtc": "2018-11-29T08:17:05Z",
      "UpdatedUtc": "2020-10-30T13:38:49Z",
      "Type": "Public",
      "ActivityState": "Active",
      "CompanyId": "c6f5c82d-621a-4c8a-903b-1b0a9a23b71f",
      "TravelAgencyId": null,
      "OccupiableIntervalStartUtc": null,
      "OccupiableIntervalEndUtc": null,
      "ExternalIdentifier": "VCHR-278",
      "IsActive": true
    },
    {
      "Id": "f4a9942c-2616-4074-b1f4-4b959515e933",
      "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
      "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Name": "Sample company voucher",
      "CreatedUtc": "2023-12-01T08:17:05Z",
      "UpdatedUtc": "2023-12-02T13:38:49Z",
      "Type": "PartnerCompany",
      "ActivityState": "Active",
      "CompanyId": "c6f5c82d-621a-4c8a-903b-1b0a9a23b71f",
      "TravelAgencyId": null,
      "OccupiableIntervalStartUtc": "2023-12-31T22:00:00Z",
      "OccupiableIntervalEndUtc": "2024-01-01T22:00:00Z",
      "ExternalIdentifier": "VCHR-278",
      "IsActive": true
    }
  ]
}

Property	Type	Contract	Description
Vouchers	array of Voucher	optional	Details about vouchers added to the system.

Delete vouchers

Delete specified vouchers. Note this operation supports Portfolio Access Tokens.

Request

[PlatformAddress]/api/connector/v1/vouchers/delete

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "VoucherIds": [
    "fe568bbd-1ecb-4bb2-bf77-96c3698de20d",
    "f4a9942c-2616-4074-b1f4-4b959515e933"
  ],
  "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Property	Type	Contract	Description
ClientToken	string	required	Token identifying the client application.
AccessToken	string	required	Access token of the client application.
Client	string	required	Name and version of the client application.
EnterpriseId	string	optional	Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.
VoucherIds	array of string	required, max 1000 items	Unique identifiers of the vouchers to be deleted.

Response

{}