Backend for Frontend (0.1)

Download OpenAPI specification:Download

REST API for Frontend

Receipt

Payment Initialization

query Parameters
method
required
string
invoiceId
required
integer <int32>
paymentGatewayId
required
string
bookingType
required
string
Request Body schema: application/json
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "orderId": "string",
  • "sessionId": "string",
  • "finAccountId": 0,
  • "status": 0,
  • "redirect": {
    },
  • "hook": true,
  • "params": {
    }
}

Sales Invoice

Get Invoices

query Parameters
bookingId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Invoices

query Parameters
bookingId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "echoToken": "string",
  • "timestamp": 0,
  • "target": "string",
  • "targetName": "string",
  • "version": "string",
  • "transactionIdentifier": "string",
  • "sequenceNmbr": 0,
  • "transactionStatusCode": "string",
  • "retransmissionIndicator": true,
  • "correlationID": "string",
  • "primaryLangID": "string",
  • "altLangID": "string",
  • "success": true,
  • "warnings": {
    },
  • "errors": {
    },
  • "comment": {
    },
  • "uniqueID": {
    }
}

Get Invoice

path Parameters
invoiceId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "invoiceId": 0,
  • "invoiceNumber": 0,
  • "organizationUnitId": 0,
  • "bookingId": 0,
  • "bookingNumber": 0,
  • "facilityId": 0,
  • "facilityName": "string",
  • "invoiceTypeId": "string",
  • "glAccountTypeId": "string",
  • "currencyUomId": "string",
  • "partyIdFrom": 0,
  • "partyToName": "string",
  • "partyFromName": "string",
  • "partyId": 0,
  • "billingPartyId": 0,
  • "roleTypeId": "string",
  • "statusId": "string",
  • "statusName": "string",
  • "billingAccountId": 0,
  • "contactMechId": 0,
  • "invoiceDate": "2019-08-24",
  • "travelStartDate": "2019-08-24",
  • "travelEndDate": "2019-08-24",
  • "amount": 0,
  • "origAmount": 0,
  • "balance": 0,
  • "origBalance": 0,
  • "origTotalTax": 0,
  • "totalTax": 0,
  • "salesTax": 0,
  • "taxableAmount": 0,
  • "nonTaxableAmount": 0,
  • "passengerNames": "string",
  • "invoiceDateAsString": "string",
  • "dueDate": "2019-08-24",
  • "paidDate": "2019-08-24",
  • "invoiceMessage": "string",
  • "referenceNumber": "string",
  • "remarks": "string",
  • "hiddenRemarks": "string",
  • "description": "string",
  • "invoiceTypeName": "string",
  • "attention": "string",
  • "transferable": true,
  • "exchangeRate": 0,
  • "ticketsIssued": true,
  • "ticketingStatusId": "string",
  • "fulfillmentStatusId": "string",
  • "overrideGlAccountCode": "string",
  • "salesPartyId": 0,
  • "salesPartyName": "string",
  • "travelConsultantPartyId": 0,
  • "travelConsultantPartyName": "string",
  • "requestorPartyId": 0,
  • "requestorPartyName": "string",
  • "lastUpdatedUserLoginId": 0,
  • "quoteId": 0,
  • "memo": "string"
}