ENVIRONMENT : Test

POST {culture}/api/ExFinanceDocument/Create

Create a new finance document for reservation or booking.

Request Information

URI Parameters

Name Description Type Additional information
culture

string

None.

Body Parameters

ExFinanceDocumentCreateModel
Name Description Type Additional information
Amount

Amount for payment. The Amount for payment may not exceed the total unpaid amount from reservation or booking.

decimal number

Required

BookingNumber

Booking number. Identifier of booking in provider system.

string

Required

Client

Client information.

ExClientModel

Required

CreditCardAutorizationNumber

Credit card transaction autorization number (Optional)

string

None.

CreditCardHolderName

Credit card holder name (Optional)

string

None.

CreditCardNumber

Masked credit card number (Optional)

string

None.

CreditCardTypeCode

Credit card type codes: MAESTRO DINERS MASTER VISA AMERICAN OTHER UNIONPAY DISCOVER MADA JCB

string

None.

CreditCardValidUntil

Credit card expire date (MM/YY) (Optional)

string

None.

CurrencyCode

Currency code.

string

Required

FinanceDocumentSubTypeCode

Finance document type code. Payment used for individual, invoice for comapnies. Payment = "CAS-DEP", Invoice = "INV-DOM", Invoice advance = "INV-A-DOM" Default value = "CAS-DEP"

string

Required

OfficeCode

Alphanumeric code of the office where finance document will be created.

string

Required

PaymentDateFrom

Payment date from in ISO 8601 format. Local representation in ISO 8601 format without time zone designator. (Optional)

date

None.

PaymentDateTo

Payment date to in ISO 8601 format. Local representation in ISO 8601 format without time zone designator. (Optional)

date

None.

PaymentRemark

Arbitrary remark visible only inside provider system.

string

None.

PaymentTypeCode

Payment type codes: CC - Credit card PYP - PayPal CHKO - Checkout TA - Transaction Account (invoice) PD - Payment Delay ADV - Payment Advance PYTB - PayTabs

string

Required

PreauthorizationCode

Credit card preauthorization code. (Optional)

string

None.

RetrievalReferenceNumber

Credit card retrival reference number, a key to uniquely identify a card transaction based on the ISO 8583 standard. (Optional)

string

None.

TransactionId

Transaction ID for external payment system (eg. PayPal, Checkout)

string

None.

Request Formats

application/json, text/json

Sample:
{
  "BookingNumber": "2016-ZS-4568",
  "OfficeCode": "ZG1",
  "CurrencyCode": "EUR",
  "FinanceDocumentSubTypeCode": "CAS-DEP",
  "PaymentTypeCode": "CC",
  "CreditCardTypeCode": "VISA",
  "CreditCardNumber": "4231 36** **** 5429",
  "CreditCardValidUntil": "05/29",
  "CreditCardHolderName": "Michael Stanson",
  "CreditCardAutorizationNumber": "245864",
  "RetrievalReferenceNumber": "35312621",
  "PreauthorizationCode": "23445667",
  "PaymentRemark": "API Payment",
  "TransactionId": "sample string 1",
  "Amount": 2.0,
  "PaymentDateFrom": "2022-03-21T00:00:00",
  "PaymentDateTo": "2022-03-23T00:00:00",
  "Client": {
    "AddressBookId": 5897,
    "IsCompany": true,
    "VatId": "6458762234",
    "Name": "Company Name Ltd.",
    "Surname": "",
    "Email": "client.email@email.com",
    "Remark": "Employee driver for client",
    "Street": "24 Winter Street",
    "PostalCode": "10003",
    "TownName": "New York",
    "CountryCode": "US",
    "PhoneNumber": "+385912112589",
    "IsDriverLicenceDomestic": true,
    "DriverLicenceTownCode": "sample string 2",
    "DriverLicenceCountryCode": "sample string 3",
    "IsPassportDomestic": true,
    "PassportTownCode": "sample string 5",
    "PassportCountryCode": "sample string 6",
    "IsIdCardDomestic": true,
    "IdCardTownCode": "sample string 8",
    "IdCardCountryCode": "sample string 9",
    "DriversLicenseNumber": "5036489",
    "DriversLicenseIssuedIn": "New York",
    "DriversLicenseIssueDate": "2017-04-10T00:00:00",
    "DriversLicenseValidUntil": "2017-04-10T00:00:00",
    "DriversLicenseValidUnlimited": true,
    "PassportNumber": "45896652",
    "PassportIssuedIn": "New York",
    "PassportIssueDate": "2017-04-10T00:00:00",
    "PassportValidUntil": "2017-04-10T00:00:00",
    "PassportValidUnlimited": true,
    "IdentityCardNumber": "45896652",
    "IdentityCardIssuedIn": "New York",
    "IdentityCardIssueDate": "2017-04-10T00:00:00",
    "IdentityCardValidUntil": "2017-04-10T00:00:00",
    "IdentityCardValidUnlimited": true
  }
}

Response Information

Resource Description

Create a new finance document for reservation or booking.

ExFinanceDocumentModel
Name Description Type Additional information
Amount

Total amount including VAT.

decimal number

None.

AmountVat

VAT amount.

decimal number

None.

BookingNumber

Booking number.

string

None.

ClientName

Client name.

string

None.

CreationTime

Creation time. UTC representation in ISO 8601 format.

date

None.

CurrencyCode

Currency code (e.g. USD, EUR).

string

None.

CurrentDomesticCurrencyCode

Current domestic currency

string

None.

CurrentDomesticCurrencyId

Current domestic currency identifier

integer

None.

DomesticCurrencyCode

Domestic currency

string

None.

DomesticCurrencyId

Domestic currency identifier

integer

None.

DomesticToCurrentDomesticExchangeRate

Domestic to current domestic currency exchange rate

decimal number

None.

DueDate

Invoice due date. UTC representation in ISO 8601 format.

date

None.

FinanceDocumentDate

Invoice creation date. UTC representation in ISO 8601 format.

date

None.

FinanceDocumentTypeName

Finance document type (e.g. invoice, bill, approval, debit).

string

None.

Id

Identifier of invoice in provider system. Used as input parameter for get PDF method.

integer

None.

IsCancelled

True if invoice is canceled.

boolean

None.

IsClientFinanceDocument

True for non-broker finance document.

boolean

None.

ModificationTime

Modifiction time. UTC representation in ISO 8601 format.

date

None.

Number

Finance document number

string

None.

PaymentDateFrom

Payment date from in ISO 8601 format. Local representation in ISO 8601 format without time zone designator. (Optional)

date

None.

PaymentDateTo

Payment date to in ISO 8601 format. Local representation in ISO 8601 format without time zone designator. (Optional)

date

None.

VoucherNumber

Your agency voucher number.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "FinanceDocumentDate": "2026-05-15T11:05:11.3738371+02:00",
  "DueDate": "2026-05-15T11:05:11.3738371+02:00",
  "Number": "17/040/228",
  "IsCancelled": true,
  "AmountVat": 100.0,
  "Amount": 25.0,
  "CurrencyCode": "EUR",
  "FinanceDocumentTypeName": "Invoice",
  "ClientName": "Some Car Hire Ltd.",
  "BookingNumber": "17-040-228",
  "VoucherNumber": "AX555-67",
  "PaymentDateFrom": "2022-03-21T00:00:00",
  "PaymentDateTo": "2022-03-23T00:00:00",
  "IsClientFinanceDocument": true,
  "DomesticCurrencyId": 1,
  "DomesticCurrencyCode": "sample string 4",
  "CurrentDomesticCurrencyId": 1,
  "CurrentDomesticCurrencyCode": "sample string 5",
  "DomesticToCurrentDomesticExchangeRate": 1.0,
  "CreationTime": "2026-05-15T11:05:11.3738371+02:00",
  "ModificationTime": "2026-05-15T11:05:11.3738371+02:00"
}