Retrieves calculations for an invoice

Request

GET {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/calculations

This endpoint retrieves calculations for an invoice.

Security

Bearer

Path

invoiceIdstring, (uuid)required

The identifier of the invoice.

Example:9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70

x-api-versionstring

curl -i -X GET \
  https://developer.flute.com/_mock/api-reference/pay-int-api/invoices/9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70/calculations \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-version: string'

Responses

OK

Bodyapplication/json

idstring, (uuid)

subTotalAmountnumber, (double)

Specifies the transaction's subtotal amount.

This includes the base amount, tips, taxes, and discounts.

Example: 3219.45

Example:3219.45

shippingAmountnumber, (double)

Indicates the shipping amount (in USD).

Example: 129.99

Example:129.99

taxPercentagenumber, (double)

Indicates the tax percentage.

Example: 8.50 (as 8.50%)

Example:8.5

taxAmountnumber, (double)

feesPercentagenumber, (double)

Indicates the fees percentage.

Example: 10.25 (as 10.25%)

Example:10.25

feesAmountnumber, (double)

Indicates the fees amount (in USD).

Example: 35.00

Example:35

discountPercentagenumber, (double)

Indicates the discount percentage.

Example: 1.5 (as 1.5%)

Example:1.5

discountAmountnumber, (double)

surchargeAmountnumber, (double)

Identifies the amount (in USD) when a surcharge is applicable.

This is a surcharge on the base amount. This surcharge was calculated using the preset percentage from surchargePercentage.

Example: 6.45

Example:6.45

surchargePercentagenumber or null, (double)

Identifies the surcharge percentage.

This is a surcharge on the base amount. This value is surcharge percentage rate. This surcharge percentage calculates the surcharge amount for surchargeAmount.

Example: 1.5 (as 1.5%)

Example:1.5

totalAmountnumber, (double)

Specifies the transaction's total amount.

This includes the base amount, tips, taxes, shipping, discounts, and other charges.

Example: 3219.45

Example:3219.45

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "subTotalAmount": 3219.45,
  "shippingAmount": 129.99,
  "taxPercentage": 8.5,
  "taxAmount": 0.1,
  "feesPercentage": 10.25,
  "feesAmount": 35,
  "discountPercentage": 1.5,
  "discountAmount": 0.1,
  "surchargeAmount": 6.45,
  "surchargePercentage": 1.5,
  "totalAmount": 3219.45
}