Order receipt

📘

Access token

The Access token should be requested with finance scope

Request

Name

Value

Description

URL

https://business-api.gett.com/v1/orders/<orderId>/receipt?businessId=<companyUUID>;

URL for "Get receipt" request

orderId

string

Order ID obtained in Create order request

businessId

UUID

Company UUID identificator obtained from Gett in registration process

curl 'https://business-api.gett.com/v1/orders/<orderId>/receipt?businessId=<companyUUID>' \
-H "Authorization: Bearer token"

❗️

Please note!

Final prices will be received within 48 hours and may change/ update according to the order actuals as a result of new data received from suppliers. e.g parking fee is added by the supplier.

To receive price updates please subscribe to webhooks with event_type "business_reports"

Response

Name

Description

payment_summary

Payment summary information

payment_summary.currency_code

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

payment_summary.total_exc_tax

Total amount excluded tax

payment_summary.total_inc_tax

Total amount included tax

payment_summary.total_tax

Total tax

calculation

Detailed calculation

calculation.additional_fee

Additional fee added to payment

calculation.cancellation

Cancellation fee for cancelled order

calculation.commissions

Detailed information about commissions

calculation.commitment

calculation.driving

Payment for driving

calculation.extras

Extra payments

calculation.stop_points

Payment for stop points

calculation.surge

Information about surge

calculation.tax

Information about tax

calculation.tips

Information about tips

calculation.tolls

Information about tolls

calculation.total_without_commissions

Total payment without commissions

calculation.waiting

Information about payment for waiting

stops

Information about stop points. Format the same as for Create order

duration_minutes

Ride duration in minutes

distance

Ride distance in miles or kilometers

emissions

For UK accounts: CO2 emissions in kilograms and fuel type

{
  "id": 5823647,
  "status": "completed",
  "business_id": "78da5445-067c-451d-a1a7-6a54e2e20cdb",
  "country": "GB",
  "category": "transportation",
  "product_name": "Black Cab",
  "tariff_area": "",
  "timezone": "Europe/London",
  "payment_summary": {
    "currency_code": "GBP",
    "total_exc_tax": 47.7,
    "total_inc_tax": 57.24,
    "total_tax": 8.67
  },
  "calculation": {
    "additional_fee": {
      "summary": {
        "amount": null,
        "amount_exc_tax": null,
        "amount_inc_tax": null,
        "tax": null
      }
    },
    "cancellation": {
      "details": {
        "cancelled_before_arrival_fee": 0,
        "cancelled_on_arrival_fee": 0
      },
      "summary": {
        "amount": null,
        "amount_exc_tax": null,
        "amount_inc_tax": null,
        "tax": null
      }
    },
    "commissions": {
      "details": {
        "line_items": [
          {
            "amount": 4.34,
            "amount_exc_tax": 4.34,
            "amount_inc_tax": 5.21,
            "fee": 10,
            "name": "Handling Fee",
            "type": "percentage_ride"
          }
        ]
      },
      "summary": {
        "amount": null,
        "amount_exc_tax": 4.34,
        "amount_inc_tax": 5.21,
        "tax": null
      }
    },
    "driving": {
      "summary": {
        "amount": 43.36,
        "amount_exc_tax": 43.36,
        "amount_inc_tax": 52.03,
        "tax": 8.67
      }
    },
    "extras": {
      "details": {
        "all_extras_info": null,
        "charged_extras_price": null
      },
      "summary": {
        "amount": null,
        "amount_exc_tax": null,
        "amount_inc_tax": null,
        "tax": null
      }
    },
    "stop_points": {
      "summary": {
        "amount": 0,
        "amount_exc_tax": 0,
        "amount_inc_tax": 0,
        "tax": 0
      }
    },
    "surge": {
      "details": {
        "rate": 0
      },
      "summary": {
        "amount": 0,
        "amount_exc_tax": 0,
        "amount_inc_tax": 0,
        "tax": null
      }
    },
    "tax": {
      "conditional_tax": {
        "amount": 0,
        "applied_rate": 0
      },
      "sales_tax": {
        "amount": 8.67,
        "applied_rate": 20
      }
    },
    "tips": {
      "details": {
        "rate": 0
      },
      "summary": {
        "amount": 0,
        "amount_exc_tax": 0,
        "amount_inc_tax": 0,
        "tax": null
      }
    },
    "tolls": {
      "details": {
        "items": null
      },
      "summary": {
        "amount": 0,
        "amount_exc_tax": 0,
        "amount_inc_tax": 0,
        "tax": 0
      }
    },
    "total_without_commissions": {
      "summary": {
        "amount": 43.36,
        "amount_exc_tax": 43.36,
        "amount_inc_tax": 52.03,
        "tax": null
      }
    },
    "waiting": {
      "summary": {
        "amount": 0,
        "amount_exc_tax": 0,
        "amount_inc_tax": 0,
        "tax": 0
      },
      "details": {
        "free_time_min": 2,
        "paid_time_min": 0
      }
    }
  },
  "stops": [
    {
      "location": {
        "latitude": "51.473648",
        "longitude": "-0.324434",
        "full_address": "West Middlesex Hospital, Finance Officer,  Twickenham Road, ISLEWORTH, Middlesex, ENGLAND, TW7 6AG",
        "postcode": "TW7 6AF"
      },
      "actions": [
        {
          "type": "pick_up",
          "user": {
            "name": "John Smith",
            "phone": "440000000000",
            "email": "[email protected]",
            "cost_center": "",
            "department": "",
            "employee_external_id": "",
            "employee_id": "4973d449-6d0b-4c61-9c24-87a960c9cf3d"
          }
        }
      ],
      "type": "origin",
      "notes": ""
    },
    {
      "location": {
        "latitude": "51.480495",
        "longitude": "-0.4454942",
        "full_address": "Renaissance London Heathrow Hotel, Bath Road,  Heathrow, HOUNSLOW, Middlesex, ENGLAND, TW6 2AQ",
        "postcode": "TW6 2AQ"
      },
      "actions": [
        {
          "type": "drop_off",
          "user": {
            "name": "John Smith",
            "phone": "440000000000",
            "email": "[email protected]",
            "cost_center": "",
            "department": "",
            "employee_external_id": "",
            "employee_id": "4973d449-6d0b-4c61-9c24-87a960c9cf3d"
          }
        }
      ],
      "type": "destination",
      "notes": ""
    }
  ],
  "references": [
    {
      "id": 6562,
      "title": "JobReference",
      "value": "123:345"
    }
  ],
  "distance": {
    "ride_distance_unit": "miles",
    "ride_distance": 7
  },
  "emissions": {
    "CO2_emissions": 0.3,
    "CO2_emissions_unit": "kg",
    "fuel_type": "hybrid electric"
  },
  "duration_minutes": 0,
  "note_to_driver": "message text",
  "payment_type": "account",
  "scheduled_at": "2021-09-01T18:10:00+0100",
  "requested_at": "2021-09-01T17:49:14+0100",
  "will_arrive_at_pickup": "2021-09-01T17:59:18+0100",
  "pickedup_at": "2021-09-01T18:11:44+0100",
  "droppedoff_at": "2021-09-01T18:35:38+0100",
  "created_by_customer_care": "",
  "platform": "api"
}
{
    "business_uuid": "string",
    "calculation":{
        "additional_fee":{
        "summary":{
            "amount":0,
            "amount_exc_tax":0,
            "amount_inc_tax":0,
            "tax":0
            }
        },
        "cancellation":{
            "details":{
                "cancelled_before_arrival_fee":0,
                "cancelled_on_arrival_fee":0
            },
            "summary":{
                "amount":0,
                "amount_exc_tax":0,
                "amount_inc_tax":0,
                "tax":0
            }
        },
        "commitment":{
            "base_fare":{
                "summary":{
                    "amount":0,
                    "amount_exc_tax":0,
                    "amount_inc_tax":0,
                    "tax":0
                }
            }
        },
        "driving":{
            "summary":{
                "amount":0,
                "amount_exc_tax":0,
                "amount_inc_tax":0,
                "tax":0
            }   
        },
        "extras":{
            "details":{
                    "all_extras_info":{
                    "name":"string",
                    "quality":0
                },
            "charged_extras_price":0
            },
            "summary":{
                "amount":0,
                "amount_exc_tax":0,
                "amount_inc_tax":0,
                "tax":0
            }
        },
        "stop_points":{
            "summary":{
                "amount":0,
                "amount_exc_tax":0,
                "amount_inc_tax":0,
                "tax":0
            }   
        },
        "surge":{
            "details":{
                "rate":0
            },
            "summary":{
                "amount":0,
                "amount_exc_tax":0,
                "amount_inc_tax":0,
                "tax":0
            }
        },
        "tax":{
            "conditional_tax":{
                "amount":0,
                "applied_rate":0
            },
            "sales_tax":{
                "amount":0,
                "applied_rate":0
            }
        },
        "tips":{
            "details":{
                "rate":0
            },
            "summary":{
                "amount":0,
                "amount_exc_tax":0,
                "amount_inc_tax":0,
                "tax":0
            }
        },
        "tolls":{
            "details":{
                "items":[
                    {
                        "amount_exc_tax":0,
                        "amount_inc_tax":0,
                        "enter_gateway":"string",
                        "exit_gateway":"string",
                        "id":0,
                        "price":0,
                        "title":"string"
                    }
                ]
            },
            "summary":{
                "amount":0,
                "amount_exc_tax":0,
                "amount_inc_tax":0,
                "tax":0
            }
        },
        "total_without_commissions":{
            "summary":{
                "amount":0,
                "amount_exc_tax":0,
                "amount_inc_tax":0,
                "tax":0
                }
        },
        "waiting":{
            "details":{
                "free_time_min":0,
                "paid_time_min":0
            },
            "summary":{
                "amount":0,
                "amount_exc_tax":0,
                "amount_inc_tax":0,
                "tax":0
            }
        }
    },
    "cancelled_at":"string",
    "category":"string",
    "droppedoff_at":"string",
    "id":0,
    "note_to_driver":"string",
    "payment_summary":{
        "currency_code":"string",
        "total_exc_tax":0,
        "total_inc_tax":0,
        "total_tax":0
    },
    "payment_type":"string",
    "pickedup_at":"string",
    "product_name":"string",
    "references":[
        {
            "id":0,
            "title":"string",
            "value":"string"
        }
    ],
    "requested_at":"string",
    "scheduled_at":"string",
    "status":"string",
    "stops":[
        {
            "actions":[
                {
                "type":"pick_up",
                "user":{
                    "name":"string",
                    "phone":"string"
                    }          
                }
            ],
            "location":{
                "full_address":"string",
                "latitude":0,
                "longitude":0
            },   
            "title":"string"
        }
    ]
}

Did this page help you?