# Get unused credits for a company

Returns the list of company unused credits which can be used by any employees of the company.

Endpoint: POST /v3/air/company-unused-credits/list
Version: v2
Security: Bearer

## Request fields (application/json):

  - `companyId` (object)

  - `companyId.id` (string)
    Example: "edd5b835-8001-430c-98f8-fedeccebe4cf"

  - `companyCreditFilter` (object)
    Filter for fetching company credits.

  - `companyCreditFilter.supplier` (string)
    Supplier for which this service provider should be used.
    Enum: "SABRE", "AMADEUS", "TRAVEL_FUSION", "FARELOGIX_NDC", "ATPCO_NDC", "TRAINLINE", "AVIA", "QBR", "BCD", "QANTAS_HOTELS", "SOUTHWEST", "EXPEDIA", "HOTEL_HUB", "NDC", "MARRIOTT", "CLEARTRIP", "KYTE", "GROUNDSPAN", "SABRE_NDC", "BOOKING_COM", "CARTRAWLER", "PREMIER_INN", "TRAVELODGE"

  - `companyCreditFilter.selectedAirlines` (array)
    Example: ["AA"]

  - `companyCreditFilter.expiryDateRange` (object)

  - `companyCreditFilter.expiryDateRange.expiryDateStart` (object)
    Date in ISO 8601 standard.
    Example: "2023-01-31"

  - `companyCreditFilter.expiryDateRange.expiryDateStart.iso8601` (string, required)
    Example: "2017-07-21"

  - `companyCreditFilter.expiryDateRange.expiryDateEnd` (object)
    Date in ISO 8601 standard.
    Example: "2023-12-01"

  - `companyCreditFilter.fopLabel` (array)
    FOP labels for which the credits should be fetched.
    Example: ["Company Central Card","Personal Card"]

  - `companyCreditFilter.pcc` (string)
    PCC for which the credits should be fetched.
    Example: "LA5K"

  - `offset` (integer)

## Response 200 fields (application/json):

  - `unusedCreditInfos` (array)

  - `unusedCreditInfos.sourcePnr` (string)
    PNR number corresponding to third party through which booking was made.
    Example: "MC5ONS"

  - `unusedCreditInfos.spotnanaPnr` (string)
    Spotnana pnr ID.
    Example: "2345678"

  - `unusedCreditInfos.ticketNumber` (string)
    Ticket number for the ticket that was converted into an unused credit.
    Example: "5267779139217"

  - `unusedCreditInfos.airlineCode` (string)
    2 letter airline code of the airline associated with this unused credit.
    Example: "AA"

  - `unusedCreditInfos.airlineInfo` (object)
    Airline info with airline name and code

  - `unusedCreditInfos.airlineInfo.airlineCode` (string, required)
    IATA code for airline.
    Example: "AA"

  - `unusedCreditInfos.airlineInfo.airlineName` (string, required)
    Airline name
    Example: "American Airlines"

  - `unusedCreditInfos.totalFare` (object)
    Total airfare associated with the original ticket.

  - `unusedCreditInfos.totalFare.amount` (number, required)
    The numeric value for the amount of money.
    Example: 510

  - `unusedCreditInfos.totalFare.currencyCode` (string, required)
    The 3-letter currency code for the money amount (defined using ISO 4217 standard).
    Example: "GBP"

  - `unusedCreditInfos.totalFare.convertedAmount` (number)
    The converted currency and amount that has been converted (if a currency conversion has been requested).
For example, if the call requests that money be sent in a specified currency (because the frontend requested
the backend to send money in the user's preferred currency).
    Example: 715.42

  - `unusedCreditInfos.totalFare.convertedCurrency` (string)
    The 3-letter currency code for the converted currency (defined using ISO 4217 standard).
    Example: "USD"

  - `unusedCreditInfos.totalFare.otherCoinage` (array)
    List of the dollar amount in other coinage systems like reward points, cryptocurrency etc.

  - `unusedCreditInfos.totalFare.otherCoinage.coinageCode` (string)
    Payment method
    Enum: "PAYMENT_METHOD_UNKNOWN", "CREDIT_CARD", "BREX_POINTS", "CASH", "QANTAS_POINTS", "VENDOR_PROGRAM_PAYMENT", "DELAYED_INVOICING", "FLIGHT_CREDITS", "QANTAS_TRAVEL_FUND", "CUSTOM_VIRTUAL_PAYMENT", "FLIGHT_PASS", "MISCELLANEOUS_CREDIT_ORDER"

  - `unusedCreditInfos.totalFare.otherCoinage.amount` (number)
    Example: 1000

  - `unusedCreditInfos.totalFare.otherCoinage.conversionRate` (number)
    1 coin in this system equals to how many currency value
    Example: 0.01

  - `unusedCreditInfos.totalFare.otherCoinage.preferredCurrencyConversionRate` (number)
    1 coin in this system equals to how many currency value
    Example: 0.01

  - `unusedCreditInfos.issueDate` (object)
    Issue date for the unused credit.

  - `unusedCreditInfos.issueDate.iso8601` (string, required)
    Example: "2017-07-21T17:32Z"

  - `unusedCreditInfos.expiryDate` (object)
    Expiry date for the unused credit.

  - `unusedCreditInfos.usedDate` (object)
    Date on which the unused credit was used.

  - `unusedCreditInfos.departureDate` (object)
    Date for the departure of the first flight associated with the unused credit.

  - `unusedCreditInfos.segmentsAvailable` (string)
    Whether all segments are unused or some have already been used.
    Enum: "UNKNOWN", "ALL_OPEN", "PARTIAL", "OTHER"

  - `unusedCreditInfos.passengerName` (object)
    Name of the passenger associated with the credit.

  - `unusedCreditInfos.passengerName.family1` (string, required)
    Last (family) name.
    Example: "Gandas"

  - `unusedCreditInfos.passengerName.family2` (string)
    Example: "FamilyTwo"

  - `unusedCreditInfos.passengerName.given` (string, required)
    First (given) name.
    Example: "Vichitr"

  - `unusedCreditInfos.passengerName.middle` (string)
    Middle name.
    Example: "Kumar"

  - `unusedCreditInfos.passengerName.suffix` (string)
    Suffix used with the name. For example SR or JR.
    Enum: "NAME_SUFFIX_UNKNOWN", "SR", "JR", "MD", "PHD", "II", "III", "IV", "DO", "ATTY", "V", "VI", "ESQ", "DC", "DDS", "VM", "JD", "SECOND", "THIRD"

  - `unusedCreditInfos.passengerName.preferred` (string)
    Informal preferred name added by traveler. This is not used on any PNR or tickets
    Example: "Don"

  - `unusedCreditInfos.departureCountry` (string)
    3 letter country code of the departure country associated with the original ticket.
    Example: "USA"

  - `unusedCreditInfos.arrivalCountry` (string)
    3 letter country code of the arrival country associated with the original ticket.
    Example: "USA"

  - `unusedCreditInfos.ticketType` (string)
    Type of credit.
    Enum: "TICKET_TYPE_UNKNOWN", "ETICKET", "MCO", "NON_GDS"

  - `unusedCreditInfos.pcc` (string)
    PCC the credit was issued on.

  - `unusedCreditInfos.status` (string)
    Status of the credit.
    Enum: "STATUS_UNKNOWN", "OPEN", "USED", "RESERVED"

  - `unusedCreditInfos.source` (string)
    Source of unused credit e.g. Sabre, NDC etc.
    Enum: "UNKNOWN_SOURCE", "SABRE", "TRAVEL_FUSION", "AVIA", "NDC", "TRAINLINE", "ATPCO_NDC", "FARELOGIX_NDC", "OFFLINE", "CONNEXUS", "ROUTEHAPPY", "AMADEUS", "GIATA", "QBR", "BCD", "QANTAS_HOTELS", "SOUTHWEST", "EXPEDIA", "HOTEL_HUB", "MARRIOTT", "CLEARTRIP", "KYTE", "GROUNDSPAN", "SABRE_NDC", "BOOKING_COM", "CARTRAWLER", "PREMIER_INN", "TRAVELODGE"

  - `unusedCreditInfos.tripId` (string)
    Trip ID that contains the unused credit
    Example: "1234567"

  - `unusedCreditInfos.redeemVia` (string)
    Credit redemption method. 
If the value contains CONTACT_AGENT, then the agent must book the ticket and redeem the credits on behalf of the traveler.
    Enum: "REDEEM_VIA_OBT", "CONTACT_AGENT"

  - `unusedCreditInfos.sourceOfTruth` (string)
    The system that owns the credit.
    Enum: "SPOTNANA", "MANUAL_FORM"

  - `unusedCreditInfos.owningPcc` (string)
    PCC the PNR was created on.

  - `unusedCreditInfos.paymentSourceId` (string)
    Payment source ID associated with the credit.
    Example: "edd5b835-8001-430c-98f8-fedeccebe4cf"

  - `unusedCreditInfos.creditUsageType` (string)
    The type of credit usage. This can be either COMPANY or PERSONAL.
    Enum: "CREDIT_USAGE_TYPE_UNKNOWN", "COMPANY", "PERSONAL"

  - `unusedCreditInfos.email` (string)
    Email of the passenger owning the unused credit.

  - `unusedCreditInfos.fopInfo` (object)
    The FOP associated with the unused credit.

  - `unusedCreditInfos.fopInfo.paymentMethod` (string)
    Payment method used for the original booking.
    Enum: "PAYMENT_METHOD_UNKNOWN", "CREDIT_CARD", "BREX_POINTS", "CASH", "QANTAS_POINTS", "VENDOR_PROGRAM_PAYMENT", "DELAYED_INVOICING", "FLIGHT_CREDITS", "QANTAS_TRAVEL_FUND", "CUSTOM_VIRTUAL_PAYMENT", "FLIGHT_PASS", "MISCELLANEOUS_CREDIT_ORDER"

  - `unusedCreditInfos.fopInfo.paymentSourceType` (string)
    Type of payment source used.
    Enum: "CARD", "VIRTUAL_CARD", "REWARDS_PROGRAM", "DELAYED_INVOICING", "CUSTOM_PAYMENT_METHOD", "VENDOR_PROGRAM_PAYMENT", "UNUSED_CREDIT", "CASH"

  - `unusedCreditInfos.fopInfo.card` (object)
    Card information if the payment source type is a card.

  - `unusedCreditInfos.fopInfo.card.id` (string)
    Unique identifier for this card
    Example: "34d536b6-f8ff-11eb-9a61-0242ac180002"

  - `unusedCreditInfos.fopInfo.card.type` (string)
    Type of card
    Enum: "UNKNOWN", "CREDIT", "DEBIT"

  - `unusedCreditInfos.fopInfo.card.company` (string)
    The issuing company of card
    Enum: "NONE", "VISA", "MASTERCARD", "AMEX", "DISCOVER", "AIR_TRAVEL_UATP", "CARTE_BLANCHE", "DINERS_CLUB", "JCB", "BREX", "UNION_PAY", "EURO_CARD", "ACCESS_CARD", "ELO_CARD"

  - `unusedCreditInfos.fopInfo.card.name` (string)
    Name on card
    Example: "Harrison Schwartz"

  - `unusedCreditInfos.fopInfo.card.address` (object)
    Billing address

  - `unusedCreditInfos.fopInfo.card.address.addressLines` (array, required)
    Address lines
    Example: ["Golden Gate Bridge"]

  - `unusedCreditInfos.fopInfo.card.address.administrativeArea` (string)
    Code of administrative area. For example: DL for Delhi, India.
Highest administrative subdivision which is used for postal
addresses of a country or region.
For example, this can be a state, a province, an oblast, or a prefecture.
Specifically, for Spain this is the province and not the autonomous
community (e.g. "Barcelona" and not "Catalonia").
Many countries don't use an administrative area in postal addresses. E.g.
in Switzerland this should be left unpopulated.
    Example: "CA"

  - `unusedCreditInfos.fopInfo.card.address.administrativeAreaName` (string)
    Name of administrative area. This is full name corresponding to administrativeArea. 
Like Delhi for DL area code. For some places, code and name maybe same as well like Tokyo.
    Example: "California"

  - `unusedCreditInfos.fopInfo.card.address.description` (string)
    Address description
    Example: "San Francisco Home"

  - `unusedCreditInfos.fopInfo.card.address.isDefault` (boolean)
    Whether this address is default address in case multiple addresses are specified.
    Example: true

  - `unusedCreditInfos.fopInfo.card.address.languageCode` (string)
    BCP-47 language code of the contents of this address (if known). This is often the UI 
language of the input form or is expected to match one of the languages used in the 
address' country/region, or their transliterated equivalents.
This can affect formatting in certain countries, but is not critical to the correctness 
of the data and will never affect any validation or other non-formatting related operations.
Examples: "zh-Hant", "ja", "ja-Latn", "en".
    Example: "en"

  - `unusedCreditInfos.fopInfo.card.address.locality` (string)
    Generally refers to the city/town portion of the address.
    Example: "San Francisco"

  - `unusedCreditInfos.fopInfo.card.address.locationCode` (string)
    IATA 3-letter location code. See https://www.iata.org/en/services/codes.
    Example: "LAX"

  - `unusedCreditInfos.fopInfo.card.address.organization` (string)
    The name of the organization at the address.
    Example: "Spotnana"

  - `unusedCreditInfos.fopInfo.card.address.postalCode` (string)
    Postal code of the address. This is a required field when setting for a user/legal entity/company etc.
    Example: "94130"

  - `unusedCreditInfos.fopInfo.card.address.continentCode` (string)
    2 letter continent code of the continent this address falls in.
    Example: "AF"

  - `unusedCreditInfos.fopInfo.card.address.recipients` (array)
    The recipient at the address.

  - `unusedCreditInfos.fopInfo.card.address.regionCode` (string, required)
    Region code of the country/region of the address.
    Example: "US"

  - `unusedCreditInfos.fopInfo.card.address.regionName` (string)
    Region name of the country/region of the address.
    Example: "America"

  - `unusedCreditInfos.fopInfo.card.address.revision` (integer)
    Example: 1

  - `unusedCreditInfos.fopInfo.card.address.sortingCode` (string)
    Additional, country-specific, sorting code. This is not used
in most regions. Where it is used, the value is either a string like
"CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
alone, representing the "sector code" (Jamaica), "delivery area indicator"
(Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
    Example: "Jamaica"

  - `unusedCreditInfos.fopInfo.card.address.sublocality` (string)
    Sublocality of the address. This can be neighborhoods, boroughs, districts.

  - `unusedCreditInfos.fopInfo.card.address.timezone` (string)
    Time zone of the address.
    Example: "America/Los_Angeles"

  - `unusedCreditInfos.fopInfo.card.address.coordinates` (object)
    Map coordinates of the address.

  - `unusedCreditInfos.fopInfo.card.address.coordinates.latitude` (number, required)
    Latitude of the Location
    Example: 77.1025

  - `unusedCreditInfos.fopInfo.card.address.coordinates.longitude` (number, required)
    Longitude of the Location
    Example: 28.7041

  - `unusedCreditInfos.fopInfo.card.number` (string, required)
    Card number
    Example: "4111111111111111"

  - `unusedCreditInfos.fopInfo.card.cvv` (string)
    Card cvv number
    Example: "012"

  - `unusedCreditInfos.fopInfo.card.label` (string)
    Card Label
    Example: "Label amex"

  - `unusedCreditInfos.fopInfo.card.currency` (string)
    Native currency of the card.
    Example: "USD"

  - `unusedCreditInfos.fopInfo.card.externalId` (string)
    Spotnana partner card id.
    Example: "bxt_RNGsNfzgJDaTstKIKqK4xEuhGYAnMdYK8T40"

  - `unusedCreditInfos.fopInfo.card.vaultId` (string)
    ID of the vault used for creating the card.
    Example: "34d536b6-f8ff-11eb-9a61-0242ac180002"

  - `unusedCreditInfos.fopInfo.card.expiry` (any)

  - `unusedCreditInfos.fopInfo.card.ownershipLabel` (string)
    Ownership label of the card whether it is personal, corporate or central.
    Enum: "CORPORATE", "PERSONAL", "CENTRAL"

  - `unusedCreditInfos.fopInfo.card.expiryMonth` (integer)
    Expiry month
    Example: 1

  - `unusedCreditInfos.fopInfo.card.expiryYear` (integer)
    Expiry year
    Example: 2010

  - `unusedCreditInfos.fopLabel` (string)
    The label associated with the FOP. This value can be empty if that particular FOP does not have any label.

  - `unusedCreditInfos.exchangeInfo` (object)
    Exchange information in case of exchanges.

  - `unusedCreditInfos.exchangeInfo.previousTicket` (string)
    Previous ticket number in case of exchanges.

  - `paginationParams` (object)

  - `paginationParams.offset` (integer)

  - `paginationParams.totalRecords` (integer)
    Example: 100

  - `companyFopLabels` (array)
    List of distinct FOP labels for company credits
    Example: ["Company Central Card","Corporate Amex"]

## Response 400 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 401 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 403 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 404 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.