{
  "swagger": "2.0",
  "info": {
    "version": "v3",
    "title": " TruckFuelNet CustomerAPI v3.0",
    "description": "RESTful API for interacting with TFN system.<br/><br/><strong>Support and escalation</strong><br/>For support, or to escalate an issue, contact TFN System Support at <a href=\"mailto:system-support@tfn.co.za\">system-support@tfn.co.za</a>.<br/><br/><strong>Dashboard</strong><br/>TFN dashboard: <a href=\"https://app.qa.tfn.co.za\">https://app.qa.tfn.co.za</a><br/><br/><strong>Basic transaction flow</strong><br/>1. Authenticate: POST /api/token for an access token (Authentication)<br/>2. Check the API is available: GET /api/Ping (System Health)<br/>3. Set up drivers and vehicles: /api/Drivers and /api/Vehicle (Driver Management, Vehicle Management)<br/>4. Check pricing and depots: GET /api/Pricing and GET /api/Depots (Pricing &amp; Fuel Network)<br/>5. Place an order: POST /api/Orders (Order Management)<br/>6. View transactions: GET /api/Transactions (Transactions)<br/>7. Log out: POST /api/LogOut (Session Management)<br/><br/><strong>API versions</strong><br/>TFNCustomerAPI is versioned. To call a specific version, add the api-version parameter to the request. If no version is specified, version 3.0 is used, so an endpoint that only exists in a later version needs the parameter. Older versions continue to work; the response headers list the supported and deprecated versions.<br/>Example URL: https://api.tfn.co.za/api/Ping?api-version=3 or https://api.tfn.co.za/api/Ping\r\n<br/>\r\n<br/>\r\n<strong>Links to other swagger documents</strong>\r\n<br/>\r\n<a href=\"https://customerapi.qa.tfn.co.za/swagger/webhooksample/ui/index\" target=\"_blank\">TruckFuelNet Web Hook Receive Transactions Sample</a>\r\n",
    "contact": {
      "name": "TFN System Support",
      "email": "system-support@tfn.co.za"
    }
  },
  "host": "customerapi.qa.tfn.co.za",
  "schemes": [
    "https"
  ],
  "paths": {
    "/api/token#Login": {
      "post": {
        "tags": [
          "Authentication"
        ],
        "summary": "Authorise a user and get an OAuth token",
        "consumes": [
          "application/x-www-form-urlencoded"
        ],
        "parameters": [
          {
            "name": "grant_type",
            "in": "formData",
            "required": true,
            "type": "string",
            "default": "password"
          },
          {
            "name": "username",
            "in": "formData",
            "required": false,
            "type": "string"
          },
          {
            "name": "password",
            "in": "formData",
            "required": false,
            "type": "string"
          },
          {
            "name": "client_ID",
            "in": "formData",
            "required": true,
            "type": "string",
            "default": "customerAPI"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "object",
              "properties": {
                "access_token": {
                  "type": "string"
                },
                "token_type": {
                  "type": "string"
                },
                "expires_in": {
                  "type": "integer"
                },
                "refresh_token": {
                  "type": "string"
                },
                "as:client_id": {
                  "type": "string"
                },
                "userName": {
                  "type": "string"
                },
                ".issued": {
                  "type": "string"
                },
                ".expires": {
                  "type": "string"
                }
              }
            }
          },
          "401": {
            "description": "token_expired"
          }
        }
      }
    },
    "/api/token#RefreshAccessToken": {
      "post": {
        "tags": [
          "Authentication"
        ],
        "summary": "Refresh an expired access token",
        "consumes": [
          "application/x-www-form-urlencoded"
        ],
        "parameters": [
          {
            "name": "grant_type",
            "in": "formData",
            "required": true,
            "type": "string",
            "default": "refresh_token"
          },
          {
            "name": "client_ID",
            "in": "formData",
            "required": true,
            "type": "string",
            "default": "customerAPI"
          },
          {
            "name": "refresh_token",
            "in": "formData",
            "required": true,
            "type": "string",
            "default": ""
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "object",
              "properties": {
                "access_token": {
                  "type": "string"
                },
                "token_type": {
                  "type": "string"
                },
                "expires_in": {
                  "type": "integer"
                },
                "refresh_token": {
                  "type": "string"
                },
                "as:client_id": {
                  "type": "string"
                },
                "userName": {
                  "type": "string"
                },
                ".issued": {
                  "type": "string"
                },
                ".expires": {
                  "type": "string"
                }
              }
            }
          },
          "401": {
            "description": "token_expired"
          }
        }
      }
    },
    "/api/Ping": {
      "get": {
        "tags": [
          "System Health"
        ],
        "summary": "Check server availability and get current server timestamp",
        "operationId": "Ping_Get",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "format": "date-time",
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/Orders": {
      "get": {
        "tags": [
          "Order Management"
        ],
        "summary": "Retrieve a list of orders after a specific date",
        "description": "Returns all orders for the specified {customerNumber} that have been modified\r\nafter {modifiedAfterDate}.\r\n            \r\nThe {modifiedAfterDate} parameter has a maximum range of 14 days ago. Requests\r\nwith a date older than 14 days will be rejected. Orders that have been marked as deleted will\r\nalso be returned.\r\n            \r\n**Security**\r\n            \r\n- Requires a valid bearer token in the `Authorization` header.\r\n- The caller must be authorized for the specified customer.\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Orders retrieved successfully. |\r\n| `400 Bad Request` | The {customerNumber} is invalid, {modifiedAfterDate} is earlier than the allowed 14-day limit, or the request failed business validation. |\r\n| `401 Unauthorized` | The caller is not authorized, or the customer number is not valid for this user. |\r\n| `500 Internal Server Error` | An internal error occurred while trying to retrieve orders. |",
        "operationId": "Orders_GetOrders",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Customer number to retrieve orders for.",
            "required": true,
            "type": "string"
          },
          {
            "name": "modifiedAfterDate",
            "in": "query",
            "description": "Only orders modified after this date will be returned.",
            "required": true,
            "type": "string",
            "format": "date-time"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.OrderSerializable"
              }
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "put": {
        "tags": [
          "Order Management"
        ],
        "summary": "Update an existing order",
        "description": "Uses the supplied order data to process an update operation. The order is identified\r\nby the `OrderNumber` field on the order object.\r\n            \r\n**Security**\r\n            \r\n- Requires a valid bearer token in the `Authorization` header.\r\n- The caller must be authorized for the specified customer.\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Order successfully updated. |\r\n| `400 Bad Request` | The request is invalid or failed business validation (for example, validation rules were not met for the supplied order details). |\r\n| `401 Unauthorized` | The caller is not authorized, or the customer number is not valid for this user. |\r\n| `500 Internal Server Error` | An internal error occurred while trying to update the order. |",
        "operationId": "Orders_UpdateOrder",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "order",
            "in": "body",
            "description": "The order object that will be used to update the order.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.OrderSerializableV2"
            }
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.OrderProcessingResult"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "post": {
        "tags": [
          "Order Management"
        ],
        "summary": "Create a new order",
        "description": "When creating a new order or adding new entries to an existing order you must specify a\r\n`newRecordIdentifier`. The API uses this value to ensure that repeated attempts to create\r\nnew records do not result in duplicates.\r\n            \r\nIf the `newRecordIdentifier` is not specified for a new order or an existing order with new\r\nentries, the update will fail. You may generate a throwaway `System.Guid` for this value as\r\nlong as you include the same value for repeated attempts to complete a specific change.\r\n            \r\nFor deletions, you may attempt to set the `IsDeleted` flag to `1` for order entries. If\r\ndeletion is possible, the entry will be deleted; otherwise it will not be deleted, and you will\r\nreceive information in the `OrderProcessingResult` to confirm the failed deletion attempt.\r\nAll other information will still be processed.\r\n            \r\n**Important: Integer Values with Leading Zeros**\r\n            \r\nInteger fields (e.g., `SupplierNumber`, `ProductNumber`) with leading zeros must be sent as\r\nstrings in quotes to avoid octal interpretation. For example, send `\"0144\"` instead of `0144`,\r\notherwise the value may be parsed as octal (0144 octal = 100 decimal instead of 144 decimal).\r\n            \r\n**Finding entry numbers for the Delete Entry endpoint**\r\n            \r\nThe response includes `Order.Entries`, each containing a `Position` field.\r\nThis `Position` value is the `entryNumber` required by the `DELETE {entryNumber}` endpoint.\r\nA `Position` of `0` in the request means \"create a new entry\"; the response will\r\nalways return the system-assigned position (greater than zero).\r\n            \r\n**Security**\r\n            \r\n- Requires a valid bearer token in the `Authorization` header.\r\n- The caller must be authorized for the specified customer.\r\n            \r\n**V3 Changes**\r\n            \r\n- Added \"SkipSMS\" property. If \"SkipSMS\" is set to true, SMS notifications will not be sent for this order.\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Order created/processed successfully. |\r\n| `400 Bad Request` | The order could not be created due to business validation failures (for example, orders are not enabled for this customer or validation rules were not met). |\r\n| `401 Unauthorized` | The caller is not authorized, or the customer number is not valid for this user. |\r\n| `500 Internal Server Error` | An internal error occurred while trying to create the order. |",
        "operationId": "Orders_CreateOrder",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "order",
            "in": "body",
            "description": "The order object that will be used to create the new order.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.OrderSerializableV2"
            }
          },
          {
            "name": "newRecordIdentifier",
            "in": "query",
            "description": "GUID that will be used to uniquely identify the order operation.",
            "required": true,
            "type": "string",
            "format": "uuid"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.OrderProcessingResult"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Order Management"
        ],
        "summary": "Cancel/delete a specific order",
        "description": "The order will be marked as deleted in the database. Order data is never physically removed.\r\n            \r\n**Security**\r\n            \r\n- Requires a valid bearer token in the `Authorization` header.\r\n- The caller must be authorized for the specified customer.\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Order deleted successfully. |\r\n| `400 Bad Request` | The {orderNumber} or {customerNumber} is invalid, or the delete operation failed business validation. |\r\n| `401 Unauthorized` | The caller is not authorized, or the customer number is not valid for this user. |\r\n| `500 Internal Server Error` | An internal error occurred while trying to delete the order. |",
        "operationId": "Orders_DeleteOrder",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Customer number the order belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "name": "orderNumber",
            "in": "query",
            "description": "5-digit order number to delete.",
            "required": true,
            "type": "string"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.OrderProcessingResult"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/Orders/{orderNumber}": {
      "get": {
        "tags": [
          "Order Management"
        ],
        "summary": "Retrieve details for a specific order",
        "description": "Returns the order identified by the supplied {orderNumber} for the\r\nspecified {customerNumber}, provided that the current user has access\r\nto that customer.\r\n            \r\nIf no matching order exists, a `401 Unauthorized` response is returned. Order existence\r\nis not distinguished from authorization failure to prevent enumeration.\r\n            \r\n**Security**\r\n            \r\n- Requires a valid bearer token in the `Authorization` header.\r\n- The caller must be authorized for the specified customer.\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Order retrieved successfully. |\r\n| `400 Bad Request` | The {orderNumber} or {customerNumber} is invalid, or the request failed business validation (for example, invalid arguments). |\r\n| `401 Unauthorized` | The caller is not authorized, the customer number is not valid for this user, or the order was not found. |\r\n| `500 Internal Server Error` | An internal error occurred while trying to retrieve the order. |",
        "operationId": "Orders_Get",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "orderNumber",
            "in": "path",
            "description": "5-digit order number. The value will be left-padded with `\"0\"` if less than 5 digits.",
            "required": true,
            "type": "string"
          },
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Customer number the order belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.OrderSerializable"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/Orders/{entryNumber}": {
      "delete": {
        "tags": [
          "Order Management"
        ],
        "summary": "Delete an individual order entry",
        "description": "The order entry will be marked as deleted in the database. Entry data is never physically removed.\r\n            \r\n**Security**\r\n            \r\n- Requires a valid bearer token in the `Authorization` header.\r\n- The caller must be authorized for the specified customer.\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Order entry deleted successfully. |\r\n| `400 Bad Request` | The request is invalid or the delete operation failed business validation. |\r\n| `401 Unauthorized` | The caller is not authorized, or the customer number is not valid for this user. |\r\n| `500 Internal Server Error` | An internal error occurred while trying to delete the order entry. |",
        "operationId": "Orders_DeleteOrderEntry",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "orderNumber",
            "in": "query",
            "description": "5-digit order number. Value will be left padded with `\"0\"` if less than 5 digits.",
            "required": true,
            "type": "string"
          },
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Customer number the order belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "name": "entryNumber",
            "in": "path",
            "description": "The entry number (position) within the order to delete.\r\nObtain this value from the Position field on the entry in the response returned by the\r\nPOST (create order) or GET (fetch order) endpoints.",
            "required": true,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.OrderProcessingResult"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/Pricing": {
      "get": {
        "tags": [
          "Pricing & Fuel Network"
        ],
        "summary": "Retrieve live pricing for a specific product code",
        "operationId": "Pricing_Get",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Customer number the order belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "name": "productCode",
            "in": "query",
            "description": "Product number to retrieve pricing for.",
            "required": true,
            "type": "string"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.CustomerPriceSerializable"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/Depots": {
      "get": {
        "tags": [
          "Pricing & Fuel Network"
        ],
        "summary": "Retrieve the list of available fueling depots",
        "description": "Only depots which a user has access to will be returned.",
        "operationId": "Depots_Get",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Customer number the depot belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.DepotSerializable"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/Products": {
      "get": {
        "tags": [
          "Pricing & Fuel Network"
        ],
        "summary": "Retrieves a list of products for a customer",
        "operationId": "Products_Get",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Customer number to retrieve products for.",
            "required": true,
            "type": "string"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.CustomerProductSerializable"
              }
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/Drivers": {
      "get": {
        "tags": [
          "Driver Management"
        ],
        "summary": "Retrieve the customer's full driver list",
        "operationId": "Drivers_Get",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Customer number to get all drivers for.",
            "required": true,
            "type": "string"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.DriverSerializable"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "post": {
        "tags": [
          "Driver Management"
        ],
        "summary": "Import a new driver or update existing driver info",
        "operationId": "Drivers_Post",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Customer number to which the driver has to be added to",
            "required": true,
            "type": "string"
          },
          {
            "name": "driver",
            "in": "body",
            "description": "DriverSerializable to use to create new driver",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.DriverSerializable"
            }
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.DriverSerializable"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/SubAccountAggregateLitres": {
      "get": {
        "tags": [
          "Account Settings"
        ],
        "summary": "Retrieve aggregate fuel volume data for sub-accounts",
        "description": "Returns one entry per sub-account and fuel product, with the total litres consumed\r\nover the requested calendar month.\r\nReversed and no-system-effect transactions are excluded; only Sphera-enabled\r\nsub-accounts are included, and Sphera-mapped products with no volume in the period are\r\nreturned with 0 litres rather than omitted.\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Aggregated litres retrieved successfully. |\r\n| `400 Bad Request` | The customer number was not provided or is invalid, or the month was not a valid yyyyMM value. |\r\n| `401 Unauthorized` | You are not signed in, or this customer account is not accessible to you. |\r\n| `500 Internal Server Error` | Something went wrong — please try again. |",
        "operationId": "SubAccountAggregateLitres_GetSubAccountAggregateLitres",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "The parent account's customer number.",
            "required": true,
            "type": "string"
          },
          {
            "name": "month",
            "in": "query",
            "description": "Month to aggregate, in yyyyMM format (e.g. 202607).",
            "required": true,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.SubAccountAggregateLitresSerializable"
              }
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/Logout": {
      "post": {
        "tags": [
          "Session Management"
        ],
        "summary": "Invalidate the current session and sign out",
        "operationId": "Logout_Post",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "logoutPoco",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Tranzact.UserManagement.WebApi.LogoutPOCO"
            }
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "object"
            }
          }
        }
      }
    },
    "/api/TransactionsWithUtilisedOrders/{transactionId}": {
      "get": {
        "tags": [
          "Transactions"
        ],
        "summary": "Retrieve a specific transaction by transaction ID",
        "description": "Returns the transaction identified by the supplied {transactionId} for the\r\nspecified {customerNumber}, provided that the current user has access\r\nto that customer.\r\n            \r\nIf no matching transaction exists, a `400 Bad Request` response is returned.\r\n            \r\n**Security**\r\n            \r\n- Requires a valid bearer token in the `Authorization` header.\r\n- The caller must be authorized for the specified customer.\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Transaction retrieved successfully. |\r\n| `400 Bad Request` | The {transactionId} or {customerNumber} is invalid, the transaction was not found, or the request failed business validation. |\r\n| `401 Unauthorized` | The caller is not authorized, or the customer number is not valid for this user. |\r\n| `500 Internal Server Error` | An internal error occurred while trying to retrieve the transaction. |",
        "operationId": "Transactions_GetTransactionById",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Customer number the transaction belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "name": "transactionId",
            "in": "path",
            "description": "Unique identifier of the transaction.",
            "required": true,
            "type": "string",
            "format": "uuid"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/CustomerAPI.Integration.TransactionSerializable"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "404": {
            "description": "NotFound",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/Transactions": {
      "get": {
        "tags": [
          "Transactions"
        ],
        "summary": "Retrieve transactions after a specified date",
        "description": "Returns batches of transactions captured after the supplied {capturedDateAfter}\r\nfor the specified {customerNumber}, provided that the current user has access\r\nto that customer.\r\n            \r\nThis endpoint can be used to retrieve all transactions in batches by continuously moving the date\r\nforward to the date and time of the last transaction retrieved after the previous retrieval.\r\n            \r\nThe minimum date should be the first transaction date for a customer. A maximum of 100 transactions\r\nwill be included at a time.\r\n            \r\n**Limitations**\r\n            \r\n- Maximum of 100 transactions per request.\r\n- Maximum of 3 months of data (limited to 2 weeks from 5AM until 7PM).\r\n            \r\n**Security**\r\n            \r\n- Requires a valid bearer token in the `Authorization` header.\r\n- The caller must be authorized for the specified customer.\r\n- Only transactions which the user has access to will be returned.\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Transactions retrieved successfully. |\r\n| `400 Bad Request` | The {capturedDateAfter} is invalid, or the {customerNumber} is incorrect. |\r\n| `401 Unauthorized` | The caller is not authorized, or the customer number is not valid for this user. |\r\n| `500 Internal Server Error` | An internal error occurred while trying to fetch transactions. |",
        "operationId": "Transactions_Get",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Customer number the order belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "name": "capturedDateAfter",
            "in": "query",
            "description": "DateTime after which transactions will be retrieved.",
            "required": true,
            "type": "string",
            "format": "date-time"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/CustomerAPI.Integration.TransactionSerializable"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/TransactionsWithUtilisedOrders": {
      "get": {
        "tags": [
          "Transactions"
        ],
        "summary": "Retrieve transactions after a specified date, including utilised orders",
        "description": "Returns batches of transactions captured after the supplied {capturedDateAfter}\r\nfor the specified {customerNumber}, including transactions with utilised orders,\r\nprovided that the current user has access to that customer.\r\n            \r\nThis endpoint can be used to retrieve all transactions in batches by continuously moving the date\r\nforward to the date and time of the last transaction retrieved after the previous retrieval.\r\n            \r\n**Limitations**\r\n            \r\n- Maximum of 50 transactions per request.\r\n- Maximum of 1 month of data (limited to 1 week from 5AM until 7PM).\r\n            \r\n**Security**\r\n            \r\n- Requires a valid bearer token in the `Authorization` header.\r\n- The caller must be authorized for the specified customer.\r\n- Only transactions which the user has access to will be returned.\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Transactions retrieved successfully. |\r\n| `400 Bad Request` | The {capturedDateAfter} is invalid, or the {customerNumber} is incorrect. |\r\n| `401 Unauthorized` | The caller is not authorized, or the customer number is not valid for this user. |\r\n| `500 Internal Server Error` | An internal error occurred while trying to fetch transactions. |",
        "operationId": "Transactions_GetWithUtilised",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Customer number the order belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "name": "capturedDateAfter",
            "in": "query",
            "description": "DateTime after which transactions will be retrieved.",
            "required": true,
            "type": "string",
            "format": "date-time"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/CustomerAPI.Integration.TransactionSerializable"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/TransactionAggregates": {
      "get": {
        "tags": [
          "Transactions"
        ],
        "summary": "Gets aggregated transaction values per sub-account, product and fee type for a period.",
        "description": "Returns one entry per sub-account, each with one line per product (fuel and non-fuel)\r\nand one line per fee type, plus totals per sub-account and for the whole response. Every\r\nline is aggregated for the requested period; the response repeats the resolved period\r\nstart and end so you can confirm what was used.\r\n            \r\n**Period**\r\n            \r\nSupply the period in exactly one of three ways. Supplying none, or more than one, is rejected\r\nwith a 400 Bad Request.\r\n            \r\n| Mode | Parameters | Description |\r\n| ---- | ---------- | ----------- |\r\n| Date range | `startDate`, `endDate` (`yyyy-MM-dd`), optional `startTime`, `endTime` (`HH:mm` or `HH:mm:ss`) | Both dates are inclusive. `startTime` defaults to `00:00:00` and `endTime` defaults to the end of the day, `23:59:59.997`. |\r\n| Month to date | `monthToDate=true` | From the start of the current month to the end of today. |\r\n| Calendar month | `month` (`yyyyMM`, e.g. `202610`) | The whole of that calendar month. |\r\n            \r\n`startTime` and `endTime` can only be used together with a date range. The period may not be\r\nlonger than 32 days (counting both the first and the last day), the end may not be before the\r\nstart, and the period may not start in the future.\r\n            \r\nTransactions are placed in a period by their captured date, which is the date the\r\ntransaction was recorded, exactly as on the statement.\r\n            \r\n**Which sales are included**\r\n            \r\n- Sales stamped with the requested customer as the service provider.\r\n- The requested customer's own sales. These come back as a block for the customer's own account in\r\n  `SubAccounts`, alongside the blocks for its sub-accounts.\r\n- If the requested customer is not a service provider, its sub-accounts' own-account sales.\r\n- If the requested customer is not a service provider, sales stamped with a service provider are not\r\n  included, including sales its branches made under another service provider. Those sales belong to that\r\n  service provider's aggregate.\r\n- A service provider can also see a block for another main account's sub-account when that sub-account\r\n  bought under the service provider's link (for example a shared vehicle). `subAccountNumber` only accepts\r\n  the requested customer's own sub-accounts; any other sub-account number is rejected with a 401\r\n  Unauthorized.\r\n- Never another service provider's sales.\r\n- Sales linked to the customer only as a subcontractor are not included.\r\n            \r\n**Fees and reversals**\r\n            \r\n- Fees are returned on separate lines, one per fee type, in `Fees`.\r\n- Reversals are returned as negative lines with `IsReversal` set to `true`, in the\r\n  period in which the reversal was recorded.\r\n            \r\n**Amounts**\r\n            \r\nAll amounts are in ZAR (`Currency`). `AmountExclVat`, `Vat` and `AmountInclVat` match the\r\nOrganisation statement. `SubAccountAmount` is the amount billed to the sub-account, on both product\r\nlines and fee lines.\r\n`TransactionCount` counts fuel and non-fuel sale lines only (not fees and not reversals),\r\nso it differs from the \"# transactions\" footer on the statement. `Quantity` is litres for\r\nfuel products and units for non-fuel products.\r\n            \r\n**Difference from `api/SubAccountAggregateLitres`**\r\n            \r\nThat endpoint is built for Sphera: it takes an exclusive end date, excludes reversed\r\nsales and returns litres only. This endpoint takes inclusive dates, returns reversals as\r\nnegative lines and returns quantities and amounts.\r\n            \r\n**Sample response**\r\n            \r\n```json\r\n{\r\n  \"Currency\": \"ZAR\",\r\n  \"PeriodStart\": \"2026-10-01T00:00:00\",\r\n  \"PeriodEnd\": \"2026-10-31T23:59:59.997\",\r\n  \"CustomerNumber\": \"ABC001\",\r\n  \"CustomerName\": \"Example Transport\",\r\n  \"SubAccounts\": [\r\n    {\r\n      \"SubAccountNumber\": \"ABC001-01\",\r\n      \"SubAccountName\": \"Truck 1\",\r\n      \"Products\": [\r\n        {\r\n          \"ProductCode\": \"D50\", \"ProductName\": \"Diesel 50ppm\", \"ProductType\": \"Fuel\",\r\n          \"IsReversal\": false, \"TransactionCount\": 12, \"Quantity\": 540.25,\r\n          \"AmountExclVat\": 9500.10, \"Vat\": 1425.02, \"AmountInclVat\": 10925.12,\r\n          \"SubAccountAmount\": 10925.12\r\n        }\r\n      ],\r\n      \"Fees\": [\r\n        {\r\n          \"FeeTypeCode\": \"TXF\", \"FeeTypeName\": \"Transaction fee\", \"IsReversal\": false,\r\n          \"TransactionCount\": 12, \"AmountExclVat\": 60.00, \"Vat\": 9.00, \"AmountInclVat\": 69.00,\r\n          \"SubAccountAmount\": 69.00\r\n        }\r\n      ],\r\n      \"Totals\": {\r\n        \"Litres\": 540.25, \"NonFuelQuantity\": 0, \"TransactionCount\": 12, \"ReversalCount\": 0,\r\n        \"FeeCount\": 12, \"AmountExclVat\": 9560.10, \"Vat\": 1434.02, \"AmountInclVat\": 10994.12,\r\n        \"SubAccountAmount\": 10994.12\r\n      }\r\n    }\r\n  ],\r\n  \"Totals\": {\r\n    \"Litres\": 540.25, \"NonFuelQuantity\": 0, \"TransactionCount\": 12, \"ReversalCount\": 0,\r\n    \"FeeCount\": 12, \"AmountExclVat\": 9560.10, \"Vat\": 1434.02, \"AmountInclVat\": 10994.12,\r\n    \"SubAccountAmount\": 10994.12\r\n  }\r\n}\r\n```\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Aggregated transaction values retrieved successfully. |\r\n| `400 Bad Request` | The customer number was not provided, the customer is a sub-account rather than a main account, or the period is invalid. For example: an unparseable date or time, an end before the start, a start in the future, a period longer than 32 days, an invalid `month`, no period supplied, or more than one period mode supplied. |\r\n| `401 Unauthorized` | You are not signed in, the customer account is not accessible to you, or the requested sub-account does not exist or is not linked to the requested customer (including a sub-account of another main account). |\r\n| `500 Internal Server Error` | Something went wrong — please try again. |",
        "operationId": "TransactionAggregates_GetTransactionAggregates",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "The main account's customer number.",
            "required": false,
            "type": "string"
          },
          {
            "name": "subAccountNumber",
            "in": "query",
            "description": "Optional. Restricts the response to this sub-account of the main account. Omit to\r\nreturn every sub-account. Only the requested customer's own sub-accounts are accepted; any other\r\nsub-account number is rejected with a 401 Unauthorized.",
            "required": false,
            "type": "string"
          },
          {
            "name": "startDate",
            "in": "query",
            "description": "Start date of a date range, in yyyy-MM-dd format. Inclusive.",
            "required": false,
            "type": "string"
          },
          {
            "name": "endDate",
            "in": "query",
            "description": "End date of a date range, in yyyy-MM-dd format. Inclusive.",
            "required": false,
            "type": "string"
          },
          {
            "name": "startTime",
            "in": "query",
            "description": "Optional time on the start date, in HH:mm or HH:mm:ss format. Defaults to 00:00:00.",
            "required": false,
            "type": "string"
          },
          {
            "name": "endTime",
            "in": "query",
            "description": "Optional time on the end date, in HH:mm or HH:mm:ss format. Defaults to 23:59:59.997 (the end of the day).",
            "required": false,
            "type": "string"
          },
          {
            "name": "monthToDate",
            "in": "query",
            "description": "Set to true to aggregate from the start of the current month to the end of today.",
            "required": false,
            "type": "boolean"
          },
          {
            "name": "month",
            "in": "query",
            "description": "Calendar month to aggregate, in yyyyMM format (e.g. 202610).",
            "required": false,
            "type": "string"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.TransactionAggregateSerializable"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/TransactionReceipt": {
      "get": {
        "tags": [
          "Transactions"
        ],
        "summary": "Downloads the PDF receipt for a transaction.",
        "description": "Returns the receipt for a transaction of the specified {customerNumber} as a raw\r\n`application/pdf` file. This is the same receipt that is emailed to the customer or produced by a reprint.\r\n            \r\nIdentify the transaction with exactly one of the following:\r\n            \r\n- {transactionReference} - Mamastops' own transaction reference, as supplied at settlement.\r\n  This only resolves orders that were settled by Mamastops.\r\n- {transactionId} - the ID of any fuel transaction or transaction entry of the customer.\r\n            \r\nThe `api-version=3.0` query parameter is required (this endpoint exists in version 3 only).\r\n            \r\n**Security**\r\n            \r\n- Requires a valid bearer token in the `Authorization` header.\r\n- The caller must be authorized for the specified customer.\r\n- Only receipts for transactions belonging to the specified customer are returned.\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Receipt returned as an `application/pdf` file. |\r\n| `400 Bad Request` | Neither or both of {transactionReference} and {transactionId} were supplied, or the request failed business validation. |\r\n| `401 Unauthorized` | The caller is not authorized, or the customer number is not valid for this user. |\r\n| `404 Not Found` | The transaction was not found, it belongs to another customer, or its order has not been settled yet. |\r\n| `500 Internal Server Error` | The receipt could not be generated, or an internal error occurred. Safe to retry. |",
        "operationId": "TransactionReceipt_Get",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/pdf"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Customer number the transaction belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "name": "transactionReference",
            "in": "query",
            "description": "Mamastops' own transaction reference from settlement. Only resolves Mamastops-settled orders.\r\nSupply this or {transactionId}, not both.",
            "required": false,
            "type": "string"
          },
          {
            "name": "transactionId",
            "in": "query",
            "description": "ID of any fuel transaction or transaction entry of the customer.\r\nSupply this or {transactionReference}, not both.",
            "required": false,
            "type": "string",
            "format": "uuid"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "The receipt as an application/pdf file.",
            "schema": {
              "type": "file"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "404": {
            "description": "NotFound",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/UserStatus": {
      "get": {
        "tags": [
          "User Status"
        ],
        "summary": "Get the status of a user account",
        "description": "Returns whether the account is active, locked, or restricted. Useful for checking\r\na user's access before performing actions on their behalf.\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Status retrieved successfully. |\r\n| `400 Bad Request` | The username was not found or the account is locked. |\r\n| `401 Unauthorized` | You are not signed in. |\r\n| `500 Internal Server Error` | Something went wrong — please try again. |",
        "operationId": "UserStatus_Get",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "userName",
            "in": "query",
            "description": "The username of the account to check.",
            "required": true,
            "type": "string"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.CustomerService.UserStatusPOCO"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/Vehicle": {
      "get": {
        "tags": [
          "Vehicle Management"
        ],
        "summary": "Retrieve a list of vehicles",
        "description": "Only vehicles which a user has access to will be returned.",
        "operationId": "Vehicle_Get",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Customer number the vehicle belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.VehicleSerializable"
              }
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "put": {
        "tags": [
          "Vehicle Management"
        ],
        "summary": "Update an existing vehicle",
        "description": "Changes the registration, tank size, status, fleet number, and external reference for a vehicle\r\non the specified customer account.\r\n            \r\n**Vehicle status values**\r\n            \r\n| Value | Status |\r\n| ----- | ------ |\r\n| `1` | WrittenOff |\r\n| `2` | Dormant |\r\n| `3` | Unused |\r\n| `4` | Active |\r\n| `5` | Stolen |\r\n| `6` | Moved |\r\n| `7` | Sold |\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Vehicle updated successfully. |\r\n| `400 Bad Request` | The registration, tank size, or customer number is invalid. |\r\n| `401 Unauthorized` | You are not signed in, or this customer account is not accessible to you. |\r\n| `500 Internal Server Error` | Something went wrong — please try again. |",
        "operationId": "Vehicle_UpdateVehicle",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Your customer account number.",
            "required": true,
            "type": "string"
          },
          {
            "name": "registration",
            "in": "query",
            "description": "The vehicle's registration number, without spaces.",
            "required": true,
            "type": "string"
          },
          {
            "name": "tankSize",
            "in": "query",
            "description": "The vehicle's tank capacity in litres.",
            "required": true,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "status",
            "in": "query",
            "description": "The new status for the vehicle. See the status values table above.",
            "required": true,
            "type": "integer",
            "format": "int32",
            "enum": [
              0,
              1,
              2,
              3,
              4,
              5,
              6,
              7
            ]
          },
          {
            "name": "fleetNumber",
            "in": "query",
            "description": "An optional fleet reference number for the vehicle.",
            "required": false,
            "type": "string"
          },
          {
            "name": "externalNumber",
            "in": "query",
            "description": "An optional external reference number for the vehicle.",
            "required": false,
            "type": "string"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.VehicleResult"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "post": {
        "tags": [
          "Vehicle Management"
        ],
        "summary": "Add a new vehicle to a customer account",
        "description": "Creates the vehicle with an Active status. Provide the registration without spaces.\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Vehicle added successfully. |\r\n| `400 Bad Request` | The registration, tank size, or customer number is invalid. |\r\n| `401 Unauthorized` | You are not signed in, or this customer account is not accessible to you. |\r\n| `500 Internal Server Error` | Something went wrong — please try again. |",
        "operationId": "Vehicle_CreateVehicle",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Your customer account number.",
            "required": true,
            "type": "string"
          },
          {
            "name": "registration",
            "in": "query",
            "description": "The vehicle's registration number, without spaces.",
            "required": true,
            "type": "string"
          },
          {
            "name": "tankSize",
            "in": "query",
            "description": "The vehicle's tank capacity in litres.",
            "required": true,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "fleetNumber",
            "in": "query",
            "description": "An optional fleet reference number for the vehicle.",
            "required": false,
            "type": "string"
          },
          {
            "name": "externalNumber",
            "in": "query",
            "description": "An optional external reference number for the vehicle.",
            "required": false,
            "type": "string"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.VehicleResult"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/Vehicle/{vehicleRegistration}": {
      "get": {
        "tags": [
          "Vehicle Management"
        ],
        "summary": "Retrieve a specific vehicle",
        "description": "Only vehicles which a user has access to will be returned.",
        "operationId": "Vehicle_Get",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Customer number the vehicle belongs to.",
            "required": true,
            "type": "string"
          },
          {
            "name": "vehicleRegistration",
            "in": "path",
            "description": "Vehicle registration number of the vehicle to return.",
            "required": true,
            "type": "string"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.VehicleSerializable"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/VirtualCardNumber": {
      "get": {
        "tags": [
          "Virtual Card Number"
        ],
        "summary": "Get the virtual card number for a vehicle",
        "description": "Returns the virtual card number assigned to a vehicle on the specified customer account.\r\nYou can only query vehicles that belong to your account.\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Virtual card number retrieved successfully. |\r\n| `400 Bad Request` | The customer number was not found. |\r\n| `401 Unauthorized` | You are not signed in, or this customer account is not accessible to you. |\r\n| `500 Internal Server Error` | Something went wrong — please try again. |",
        "operationId": "VirtualCardNumber_Get",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "Your customer account number.",
            "required": true,
            "type": "string"
          },
          {
            "name": "vehicleRegistration",
            "in": "query",
            "description": "The registration number of the vehicle.",
            "required": true,
            "type": "string"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.VirtualCardSerialisable"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/SubAccountBalance": {
      "get": {
        "tags": [
          "Sub-Account Management"
        ],
        "summary": "Gets the current balance for a sub-account.",
        "description": "Returns the live statement balance and available balance for the given customer number.\r\nYou can only query accounts that belong to you.\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Balance retrieved successfully. |\r\n| `400 Bad Request` | The customer number was not provided or is invalid. |\r\n| `401 Unauthorized` | You are not signed in, or this customer account is not accessible to you. |\r\n| `500 Internal Server Error` | Something went wrong — please try again. |",
        "operationId": "SubAccountBalance_Get",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "The sub-account's customer number.",
            "required": true,
            "type": "string"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.SubAccountBalanceSerializable"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/SubAccountCreditLimit": {
      "get": {
        "tags": [
          "Sub-Account Management"
        ],
        "summary": "Gets the credit limit for a sub-account.",
        "description": "Returns the current credit limit for the specified sub-account customer.\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Credit limit retrieved successfully. |\r\n| `400 Bad Request` | The customer number was not provided or is invalid. |\r\n| `401 Unauthorized` | You are not signed in, or this customer account is not accessible to you. |\r\n| `500 Internal Server Error` | Something went wrong — please try again. |",
        "operationId": "SubAccountCreditLimit_GetSubAccountCreditLimit",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "The sub-account's customer number.",
            "required": true,
            "type": "string"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.SubAccountCreditLimitSerializable"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "post": {
        "tags": [
          "Sub-Account Management"
        ],
        "summary": "Updates the credit limit for a sub-account.",
        "description": "Sets a new credit limit on the specified sub-account and returns the updated limit on success.\r\nOne sub-account can be updated per request.\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Credit limit updated successfully. Returns the new limit. |\r\n| `400 Bad Request` | A customer number was not provided or is invalid. |\r\n| `401 Unauthorized` | You are not signed in, or this customer account is not accessible to you. |\r\n| `500 Internal Server Error` | Something went wrong — please try again. |",
        "operationId": "SubAccountCreditLimit_PostSubAccountCreditLimits",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "parentCustomerNumber",
            "in": "query",
            "description": "The parent account's customer number.",
            "required": true,
            "type": "string"
          },
          {
            "name": "subAccountCustomerNumber",
            "in": "query",
            "description": "The customer number of the sub-account to update.",
            "required": true,
            "type": "string"
          },
          {
            "name": "newCreditLimit",
            "in": "query",
            "description": "The new credit limit to apply.",
            "required": true,
            "type": "number",
            "format": "double"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.SubAccountCreditLimitSerializable"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/SubAccountCreditLimits": {
      "get": {
        "tags": [
          "Sub-Account Management"
        ],
        "summary": "Gets the credit limits for all sub-accounts under a parent account.",
        "description": "Returns the credit limit for every sub-account belonging to the given parent customer.\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Credit limits retrieved successfully. |\r\n| `400 Bad Request` | The customer number was not provided or is invalid. |\r\n| `401 Unauthorized` | You are not signed in, or this customer account is not accessible to you. |\r\n| `500 Internal Server Error` | Something went wrong — please try again. |",
        "operationId": "SubAccountCreditLimit_GetSubAccountCreditLimits",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "parentCustomerNumber",
            "in": "query",
            "description": "The parent account's customer number.",
            "required": true,
            "type": "string"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.SubAccountCreditLimitSerializable"
              }
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/SubAccountPayment": {
      "post": {
        "tags": [
          "Sub-Account Management"
        ],
        "summary": "Applies a debit or credit to a sub-account.",
        "description": "Posts a payment against the customer's sub-account and returns the updated balance on success.\r\n            \r\n**Payment action values**\r\n            \r\n| Value | Action |\r\n| ----- | ------ |\r\n| `1` | Debit |\r\n| `2` | Credit |\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | Payment applied successfully. Returns the updated account balance. |\r\n| `400 Bad Request` | The customer number, action, or amount is invalid, or the customer is not a sub-account. |\r\n| `401 Unauthorized` | You are not signed in, or this customer account is not accessible to you. |\r\n| `500 Internal Server Error` | Something went wrong — please try again. |",
        "operationId": "SubAccountPayment_PostSubAccountPayment",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "The sub-account number to debit or credit.",
            "required": true,
            "type": "string"
          },
          {
            "name": "action",
            "in": "query",
            "description": "The payment action: Debit (1) or Credit (2).",
            "required": true,
            "type": "integer",
            "format": "int32",
            "enum": [
              1,
              2
            ]
          },
          {
            "name": "amount",
            "in": "query",
            "description": "The amount to apply.",
            "required": true,
            "type": "number",
            "format": "double"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.SubAccountBalanceSerializable"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/subAccount": {
      "get": {
        "tags": [
          "Sub-Account Management"
        ],
        "summary": "Returns the full detail of a single sub-account by its customer number, in the same shape\r\nas the create/update request so the result can be posted back unchanged.",
        "operationId": "SubAccountOnboarding_Get",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "The sub-account's customer number.",
            "required": true,
            "type": "string"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.CustomerService.SubAccountOnboardingRequest"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "put": {
        "tags": [
          "Sub-Account Management"
        ],
        "summary": "Updates a single existing driver sub-account under the parent organisation named in the body,\r\nusing the same request shape as onboarding. Drivers are matched to their existing\r\nsub-account by cell number. The request is validated up front; if any item is invalid,\r\nnothing is updated.",
        "operationId": "SubAccountOnboarding_Put",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "request",
            "in": "body",
            "description": "The update request (parent, external reference, drivers, vehicles, links).",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.CustomerService.SubAccountOnboardingRequest"
            }
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "post": {
        "tags": [
          "Sub-Account Management"
        ],
        "summary": "Onboards a single sub-account of the parent organisation named in the body, with its\r\ndrivers, vehicles and driver-vehicle links.",
        "operationId": "SubAccountOnboarding_Post",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "request",
            "in": "body",
            "description": "The onboarding request (parent, external reference, drivers, vehicles, links).",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.CustomerService.SubAccountOnboardingRequest"
            }
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "string"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Sub-Account Management"
        ],
        "summary": "Discontinues a sub-account, setting its status to Terminated. Identify the\r\nsub-account by its customer number (as returned by the GET endpoint, e.g. \"10021/005\").",
        "operationId": "SubAccountOnboarding_Delete",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "customerNumber",
            "in": "query",
            "description": "The sub-account's customer number.",
            "required": false,
            "type": "string"
          },
          {
            "name": "api-version",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "401": {
            "description": "Unauthorized",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "/api/paymaster/v1/arrangements/{id}/amounts": {
      "post": {
        "tags": [
          "Ecosystem Paymaster"
        ],
        "summary": "Stages the amounts to collect from your customers for one period of an arrangement.",
        "description": "Identify each customer by your own customer reference - the one your customer was linked\r\nwith. The period is worked out from the arrangement's frequency and the ProcessDate\r\nyou send (or the arrangement's next collection date when you leave it out), so posting the\r\nsame reference for the same period again replaces the amount rather than adding a second one.\r\nSafe to retry. At most 5000 amounts per request. Send ProcessDate as a date only,\r\nyyyy-MM-dd; a value carrying a time zone is read as its calendar date in South African time.\r\n            \r\n**Row outcomes**\r\n            \r\n| Outcome | Meaning |\r\n| ------- | ------- |\r\n| `Created` | Staged for the first time. |\r\n| `Updated` | Replaced the amount already staged for this reference and period. |\r\n| `Unmatched` | No linked customer has this reference. Staged, but it will not be collected until the reference is linked. |\r\n| `Ambiguous` | More than one linked customer has this reference. Staged, but not collected until that is resolved. |\r\n| `Rejected` | Not staged - see the row's message (for example a negative amount or one above the arrangement's maximum). Submit it again if the message says it could not be saved. |\r\n| `Locked` | Not collected - a collection has already been prepared for this period, or was prepared while this request was being processed. |\r\n            \r\n**Response codes**\r\n            \r\n| Status | Description |\r\n| ------ | ----------- |\r\n| `200 OK` | The request was processed. Check each row's outcome. |\r\n| `400 Bad Request` | The arrangement is not active or not API-sourced, or the request is empty or too large. |\r\n| `403 Forbidden` | You are not signed in as an ecosystem partner, or Ecosystem Paymaster is not enabled for you. |\r\n| `404 Not Found` | You have no arrangement with this id. |\r\n| `500 Internal Server Error` | Something went wrong - please try again. |",
        "operationId": "PaymasterArrangementAmounts_PostAmounts",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json",
          "text/json",
          "application/problem+json",
          "application/xml",
          "text/xml"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The arrangement id.",
            "required": true,
            "type": "string",
            "format": "uuid"
          },
          {
            "name": "request",
            "in": "body",
            "description": "The amounts, keyed by your customer reference.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.EcosystemPaymaster.EcosystemPartnerAmountSubmissionRequest"
            }
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "access token",
            "required": false,
            "type": "string",
            "default": "Bearer "
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.EcosystemPaymaster.EcosystemPartnerAmountSubmissionResult"
            }
          },
          "400": {
            "description": "BadRequest",
            "schema": {
              "type": "string"
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "string"
            }
          },
          "404": {
            "description": "NotFound",
            "schema": {
              "type": "string"
            }
          },
          "500": {
            "description": "InternalServerError",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "definitions": {
    "Tranzact.EntityInformation.WebApi.AccessLevelPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "title": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.AccessLevelListPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "title": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.AccessLevelSetupPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "title": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "accessLevelPermissionList": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.EntityInformation.WebApi.AccessLevelPermissionPOCO"
          }
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.AccessLevelPermissionPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "accessLevelId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "permissionId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "isDeleted": {
          "default": false,
          "type": "boolean",
          "example": false
        },
        "permissionTitle": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "accessType": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.AddressController.AddressPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "postalCodeId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "countryId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "address1": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "address2": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "cityArea": {
          "$ref": "#/definitions/Tranzact.EntityInformation.WebApi.CityAreaController.CityAreaWithPostalCodesPOCO"
        },
        "cityAreaTitle": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "areaTitle": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "postalCodeTitle": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "countryTitle": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "gpsLocation": {
          "$ref": "#/definitions/Tranzact.EntityInformation.BusinessLogic.GPSLocationPOCO"
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.CityAreaController.CityAreaWithPostalCodesPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "displayTitle": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "areaTitle": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "postalCodeListWithEmptyRecord": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.EntityInformation.WebApi.PostalCodeController.PostalCodePOCO"
          }
        }
      }
    },
    "Tranzact.EntityInformation.BusinessLogic.GPSLocationPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "longitude": {
          "format": "double",
          "type": "number"
        },
        "lattitude": {
          "format": "double",
          "type": "number"
        },
        "accuracy": {
          "format": "double",
          "type": "number"
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.PostalCodeController.PostalCodePOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "displayTitle": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "code": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.UserManagement.Services.LoginTokenPOCO": {
      "type": "object",
      "properties": {
        "accessToken": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "refreshToken": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "issuedDate": {
          "format": "date-time",
          "default": "",
          "type": "string",
          "example": ""
        },
        "expiryDate": {
          "format": "date-time",
          "default": "",
          "type": "string",
          "example": ""
        },
        "username": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.UserManagement.WebApi.AppLoginPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "username": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "title": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "systemLanguageId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "changePassword": {
          "default": false,
          "type": "boolean",
          "example": false
        },
        "locked": {
          "default": false,
          "type": "boolean",
          "example": false
        },
        "acceptedLatestTermsAndConditions": {
          "default": false,
          "type": "boolean",
          "example": false
        },
        "permittedRoutes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "userDashboards": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.UserManagement.WebApi.UserDashboardPOCO"
          }
        },
        "currentUserDashboardId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        }
      }
    },
    "Tranzact.UserManagement.WebApi.UserDashboardPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "homeRouteName": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "roleName": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "linkedEntityId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "linkedEntityTitle": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "systemUserTypeId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.AreaController.AreaPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "title": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.ApplicationManagement.WebApi.AutomationImportPOCO": {
      "type": "object",
      "properties": {
        "globalId": {
          "format": "int32",
          "type": "integer"
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.BankAccountHeaderPOCO": {
      "type": "object",
      "properties": {
        "entries": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.EntityInformation.WebApi.BankAccountPOCO"
          }
        },
        "linkedEntityId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.BankAccountPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "isDeleted": {
          "default": false,
          "type": "boolean",
          "example": false
        },
        "title": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "bankAccountTypeId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "bankAccountTypeTitle": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "bankAccountNumber": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "bankBranchCode": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "bankAccountName": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "bankId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "bankTitle": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "entityTypeId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "swiftCode": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "isNew": {
          "default": false,
          "type": "boolean",
          "example": false
        },
        "isBlank": {
          "default": false,
          "type": "boolean",
          "example": false
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.BankAccountTypeListPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "title": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.BankListPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "title": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.UserManagement.WebApi.CaptureOTPPOCO": {
      "type": "object",
      "properties": {
        "cellSecure": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "otp": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.UserManagement.WebApi.CaptureOTPResponsePOCO": {
      "type": "object",
      "properties": {
        "success": {
          "default": false,
          "type": "boolean",
          "example": false
        },
        "errorMessage": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "otpExpired": {
          "default": false,
          "type": "boolean",
          "example": false
        },
        "exceededRetryAttempts": {
          "default": false,
          "type": "boolean",
          "example": false
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.CitiesWithAddressesController.CityPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "displayTitle": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.CountryListController.CountryPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "title": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.DashboardLayoutPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "title": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.UserManagement.WebApi.RoutePOCO": {
      "type": "object",
      "properties": {
        "ap": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "t": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "s": {
          "default": false,
          "type": "boolean",
          "example": false
        },
        "m": {
          "default": false,
          "type": "boolean",
          "example": false
        },
        "dc": {
          "default": false,
          "type": "boolean",
          "example": false
        },
        "e": {
          "default": false,
          "type": "boolean",
          "example": false
        },
        "cmi": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.UserManagement.WebApi.RoutePOCO"
          }
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.DepotSerializable": {
      "type": "object",
      "properties": {
        "DepotID": {
          "format": "uuid",
          "description": "Unique Depot Identifier",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "Number": {
          "format": "int32",
          "description": "Depot number",
          "type": "integer"
        },
        "Title": {
          "description": "Depot name",
          "default": "",
          "type": "string",
          "example": ""
        },
        "GPSLatitude": {
          "format": "double",
          "description": "GPS latitude of the depot",
          "type": "number"
        },
        "GPSLongitude": {
          "format": "double",
          "description": "GPS longitude of the depot",
          "type": "number"
        },
        "MarketingCategory": {
          "format": "int32",
          "description": "TFN’s site marketing category\r\n -  Refuel2Save\r\n -  Standard\r\n -  CrossBorder",
          "enum": [
            0,
            1,
            2
          ],
          "type": "integer"
        },
        "Products": {
          "description": "Products offered by the depot",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.DepotProductSerializable"
          }
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.DepotProductSerializable": {
      "type": "object",
      "properties": {
        "ProductCode": {
          "description": "Product code",
          "default": "",
          "type": "string",
          "example": ""
        },
        "ProductTitle": {
          "description": "Name of the product",
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.DriverSerializable": {
      "type": "object",
      "properties": {
        "ID": {
          "format": "uuid",
          "description": "The driver UniqueIdentifier",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "Name": {
          "description": "The driver name",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Surname": {
          "description": "The driver surname",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Cellphone": {
          "description": "The driver cell number",
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.EmailAddressTypePOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "title": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "TFNPlatformAPI.Controllers.HealthMonitorAreasController.HealthMonitorAreaPOCO": {
      "type": "object",
      "properties": {
        "ID": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "Title": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "CurrentHealthMonitorStateID": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "StateLastUpdated": {
          "format": "date-time",
          "default": "",
          "type": "string",
          "example": ""
        },
        "TotalMonitors": {
          "format": "int32",
          "type": "integer"
        },
        "TotalMonitorsFlagged": {
          "format": "int32",
          "type": "integer"
        },
        "TotalMonitorsUnknown": {
          "format": "int32",
          "type": "integer"
        }
      }
    },
    "TFNPlatformAPI.Controllers.HealthMonitorCategoriesController.HealthMonitorCategoryPOCO": {
      "type": "object",
      "properties": {
        "ID": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "Title": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "CurrentHealthMonitorStateID": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "StateLastUpdated": {
          "format": "date-time",
          "default": "",
          "type": "string",
          "example": ""
        },
        "TotalMonitors": {
          "format": "int32",
          "type": "integer"
        },
        "TotalMonitorsFlagged": {
          "format": "int32",
          "type": "integer"
        },
        "TotalMonitorsUnknown": {
          "format": "int32",
          "type": "integer"
        }
      }
    },
    "TFNPlatformAPI.Controllers.HealthMonitorCurrentEntriesController.HealthMonitorSpecPOCO": {
      "type": "object",
      "properties": {
        "ID": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "Title": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "HealthMonitorCategoryID": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "CurrentHealthMonitorStateID": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "StateLastUpdated": {
          "format": "date-time",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Summary": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "EntryValue1Label": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "EntryValue2Label": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "EntryValue3Label": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "DataValue1Label": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "DataValue2Label": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "DataValue3Label": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "CurrentEntry": {
          "$ref": "#/definitions/TFNPlatformAPI.Controllers.HealthMonitorCurrentEntriesController.HealthMonitorEntryPOCO"
        }
      }
    },
    "TFNPlatformAPI.Controllers.HealthMonitorCurrentEntriesController.HealthMonitorEntryPOCO": {
      "type": "object",
      "properties": {
        "ID": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "Value1": {
          "format": "double",
          "type": "number"
        },
        "Value2": {
          "format": "double",
          "type": "number"
        },
        "Value3": {
          "format": "double",
          "type": "number"
        },
        "Detail": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "TFNPlatformAPI.Controllers.HealthMonitorEntryDataController.HealthMonitorEntryDataPOCO": {
      "type": "object",
      "properties": {
        "ID": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "Value1": {
          "format": "double",
          "type": "number"
        },
        "Value2": {
          "format": "double",
          "type": "number"
        },
        "Value3": {
          "format": "double",
          "type": "number"
        },
        "Detail": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "ExternalReferenceTitle": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "ExternalReferenceID": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        }
      }
    },
    "TFNPlatformAPI.Controllers.HealthMonitorStatesController.HealthMonitorStatePOCO": {
      "type": "object",
      "properties": {
        "ID": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "Title": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.UserManagement.WebApi.InstallationPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "title": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.UserManagement.Services.LoginPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "username": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "title": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "homeRouteName": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "roleName": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "linkedEntityId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "linkedEntityTitle": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "systemLanguageId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "systemUserTypeId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "dashboardLayoutId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "changePassword": {
          "default": false,
          "type": "boolean",
          "example": false
        },
        "locked": {
          "default": false,
          "type": "boolean",
          "example": false
        },
        "acceptedLatestTermsAndConditions": {
          "default": false,
          "type": "boolean",
          "example": false
        },
        "latestUnAcceptedTermsAndCondtions": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "editPermissionIdList": {
          "type": "array",
          "items": {
            "format": "uuid",
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000"
          }
        }
      }
    },
    "Tranzact.UserManagement.WebApi.LogoutPOCO": {
      "type": "object",
      "properties": {
        "refreshToken": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.OrderSerializable": {
      "description": "Represents a single order in the system.\r\nAn order consists of one or more order entries.",
      "type": "object",
      "properties": {
        "IsDeleted": {
          "description": "Indicates if a previously existing order is now deleted.\r\nOrders from both FetchOrders and FetchOrder will return deleted orders so that the third party system can \r\neasily update the status in the 3rd party system.",
          "default": false,
          "type": "boolean",
          "example": false
        },
        "Planned": {
          "description": "Indicates if an order is specified with enough detail to be made active and be used.\r\nPlanned orders are missing detail but have been persisted.\r\nValidations: Read only",
          "default": false,
          "type": "boolean",
          "example": false
        },
        "PlannedReasons": {
          "description": "Reasons this order is in the planned status\r\nValidations: Read only",
          "default": "",
          "type": "string",
          "example": ""
        },
        "OrderNumber": {
          "description": "The unique order number\r\nValidations: Read-only.\r\nSpecify a valid OrderNumber when updating an existing order\r\nLeave blank when creating a new order. The returned order will include the system issued order number.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CustomerNumber": {
          "description": "The customer number of the associated customer.\r\nValidations: A valid customer number",
          "default": "",
          "type": "string",
          "example": ""
        },
        "SubContractorCustomerNumber": {
          "description": "The customer number of the associated sub contractor.\r\nTo be used when the order is for another customer (the 'Farmer' model).\r\nValidations: A valid customer number and associated as a sub contractor to the customer",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CustomerReference": {
          "description": "A reference from the customer system or process\r\nValidations: Max length 100 characters\r\nNote: Not used when entry-level references are enabled for this customer. In that case, set CustomerReference on each entry instead.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "EntriesCompleteAfterFirstUse": {
          "description": "True if order entries complete after first usage.",
          "default": false,
          "type": "boolean",
          "example": false
        },
        "MaxAllocation": {
          "format": "double",
          "description": "The maximum litres (for fuel products) or maximum ZAR amount (for non fuel products)\r\nthat can be allocated to this order.\r\nOnly applicable for sub-contractor orders (i.e. when SubContractorCustomerNumber is specified).\r\nValidations: Not 0.00 and not negative",
          "type": "number"
        },
        "SubContractorAccepted": {
          "description": "True when a sub-contractor has accepted this order\r\nValidations: Cannot be true at the same time SubContractorDeclined is true",
          "default": false,
          "type": "boolean",
          "example": false
        },
        "SubContractorDeclined": {
          "description": "True when a sub-contractor has declined this order\r\nValidations: Cannot be true at the same time SubContractorAccepted is true",
          "default": false,
          "type": "boolean",
          "example": false
        },
        "StatusTitle": {
          "description": "The current status that the order is in",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Entries": {
          "description": "Individual order entry instructions associated with this parent level order",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.OrderEntrySerializable"
          }
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.OrderEntrySerializable": {
      "description": "Represents a single order entry (which is contained within an order)\r\nAn order entry is an instruction to purchase product on the network.",
      "type": "object",
      "properties": {
        "IsDeleted": {
          "description": "Indicates if a previously existing entry is now deleted.\r\nEntries returned include deleted entries so that the third party system can easily.",
          "default": false,
          "type": "boolean",
          "example": false
        },
        "Position": {
          "format": "int32",
          "description": "The position is used to uniquely identify an entry in the system.\r\n\r\nWhen adding a new entry set the position to zero.\r\nThe returning order will include the system allocated position.\r\nWhen editing an entry make sure the position is specified correctly.\r\n            \r\nThe position also indicates the order in which an entry\r\nshows in the list of entries when viewing the order.\r\nHowever, it is not possible to change the position of an entry.",
          "type": "integer"
        },
        "SupplierNumber": {
          "format": "int32",
          "description": "The system number for the supplier (when applicable)\r\nThe numbers are available on request or can be determined via the Depots method documented in the Supporting Data API.\r\nWe recommend getting an updated list once a day to ensure depots for a customer are up-to-date",
          "type": "integer"
        },
        "ProductCode": {
          "description": "The code of the purchased product (when applicable)\r\nThe product codes are available on request.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "VehicleRegistration": {
          "description": "Vehicle registration\r\nValidations: Should already exist on the specified customer record\r\n(or sub-contractor if sub-contractor is specified) record",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CardNumber": {
          "description": "Returns the card associated with the specified vehicle (if any - virtual cards are not linked to vehicles)\r\nCard number (read only)",
          "default": "",
          "type": "string",
          "example": ""
        },
        "DriverCellNumber": {
          "description": "Driver cell number. To be specified when using virtual cards. To be left blank when using cards.\r\nValidations: Should already exist on the specified customer record (or sub-contractor if sub-contractor is specified) record",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CurrentVirtualCardNumber": {
          "description": "Current virtual card number if applicable (read only)\r\nNumber will change when the expiry date is reached and is only guaranteed to be correct as at the time the API is called.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "MaxAllocation": {
          "format": "double",
          "description": "The maximum litres (for fuel products) or maximum ZAR amount (for non fuel products)\r\nthat can be allocated to this entry.",
          "type": "number"
        },
        "ValidDateStart": {
          "format": "date-time",
          "description": "Start of the order entry's usable period\r\nValidations: Is before the end period",
          "default": "",
          "type": "string",
          "example": ""
        },
        "ValidDateEnd": {
          "format": "date-time",
          "description": "End of the order entry's usable period\r\nValidations: Is after the start period",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CustomerReference": {
          "description": "A reference from the third party system or process\r\nValidations: Max length 100 characters",
          "default": "",
          "type": "string",
          "example": ""
        },
        "LinkedTransactions": {
          "description": "List of product purchases linked to this entry",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.OrderTransactionSerializable"
          }
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.OrderTransactionSerializable": {
      "description": "Transaction information returned with an order.\r\nThis can be optionally used to match transactions returned using\r\nthe FetchTransactions API",
      "type": "object",
      "properties": {
        "TransactionID": {
          "format": "uuid",
          "description": "Transaction information returned with an order.\r\nThis can be optionally used to match transactions returned using\r\nthe FetchTransactions API",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.OrderSerializableV2": {
      "type": "object",
      "properties": {
        "IsDeleted": {
          "description": "Indicates if a previously existing order is now deleted.\r\nOrders from both FetchOrders and FetchOrder will return deleted orders so that the third party system can \r\neasily update the status in the 3rd party system.",
          "default": false,
          "type": "boolean",
          "example": false
        },
        "Planned": {
          "description": "Indicates if an order is specified with enough detail to be made active and be used.\r\nPlanned orders are missing detail but have been persisted.\r\nValidations: Read only",
          "default": false,
          "type": "boolean",
          "example": false
        },
        "PlannedReasons": {
          "description": "Reasons this order is in the planned status\r\nValidations: Read only",
          "default": "",
          "type": "string",
          "example": ""
        },
        "OrderNumber": {
          "description": "The unique order number\r\nValidations: Read-only.\r\nSpecify a valid OrderNumber when updating an existing order\r\nLeave blank when creating a new order. The returned order will include the system issued order number.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CustomerNumber": {
          "description": "The customer number of the associated customer.\r\nValidations: A valid customer number",
          "default": "",
          "type": "string",
          "example": ""
        },
        "SubContractorCustomerNumber": {
          "description": "The customer number of the associated sub-contractor.\r\nTo be used when the order is for another customer (the 'Farmer' model).\r\nValidations: A valid customer number and associated as a sub-contractor to the customer",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CustomerReference": {
          "description": "A reference from the customer system or process\r\nValidations: Max length 100 characters\r\nNote: Not used when entry-level references are enabled for this customer. In that case, set CustomerReference on each entry instead.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "EntriesCompleteAfterFirstUse": {
          "description": "True if order entries complete after first usage.",
          "default": false,
          "type": "boolean",
          "example": false
        },
        "MaxAllocation": {
          "format": "double",
          "description": "The maximum litres (for fuel products) or maximum ZAR amount (for non fuel products)\r\nthat can be allocated to this order.\r\nOnly applicable for sub-contractor orders (i.e. when SubContractorCustomerNumber is specified).\r\nValidations: Not 0.00 and not negative",
          "type": "number"
        },
        "SubContractorAccepted": {
          "description": "True when a sub-contractor has accepted this order\r\nValidations: Cannot be true at the same time SubContractorDeclined is true",
          "default": false,
          "type": "boolean",
          "example": false
        },
        "SubContractorDeclined": {
          "description": "True when a sub-contractor has declined this order\r\nValidations: Cannot be true at the same time SubContractorAccepted is true",
          "default": false,
          "type": "boolean",
          "example": false
        },
        "StatusTitle": {
          "description": "The current status that the order is in",
          "default": "",
          "type": "string",
          "example": ""
        },
        "SkipSMS": {
          "description": "Skips sending of SMS on order creation. Defaults to false.",
          "default": false,
          "type": "boolean",
          "example": false
        },
        "Entries": {
          "description": "Individual order entry instructions associated with this parent level order",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.OrderEntrySerializable"
          }
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.OrderProcessingResult": {
      "description": "The result returned when calling UpdateOrCreateOrder.\r\nThe message field returns information in addition to the validation category.",
      "type": "object",
      "properties": {
        "ValidationResult": {
          "default": "",
          "enum": [
            "Successful",
            "InvalidVehicle",
            "InvalidDriver",
            "InvalidCustomer",
            "InvalidSubContractor",
            "InvalidProduct",
            "InvalidDepot",
            "InvalidOrderNumber",
            "InvalidOrderID",
            "InvalidOrderEntryID",
            "InvalidOrderEntry",
            "MixedCardAndVirtualCardEntries",
            "InvalidSubContractorAccepted",
            "NoEntries",
            "OrderEntryWithActivityRemoved",
            "InvalidMaxAllocation",
            "InvalidDates",
            "RequireUniqueOrderReference",
            "OrdersNotEnabled",
            "UnspecifiedError",
            "DormantDepot",
            "OrderLimitViolation",
            "OrderComplete",
            "OrderEntryComplete"
          ],
          "type": "string",
          "example": ""
        },
        "Order": {
          "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.OrderSerializable"
        },
        "Message": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.UserManagement.WebApi.OTPPOCO": {
      "type": "object",
      "properties": {
        "cellPhone": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "applicationNameToMention": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "resend": {
          "default": false,
          "type": "boolean",
          "example": false
        }
      }
    },
    "Tranzact.UserManagement.Services.OTPResult": {
      "type": "object",
      "properties": {
        "success": {
          "default": false,
          "type": "boolean",
          "example": false
        },
        "extraInfo": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.EcosystemPaymaster.EcosystemPartnerAmountSubmissionRequest": {
      "description": "The body of POST api/paymaster/v1/arrangements/{id}/amounts: the amounts a partner's\r\nsystem posts for its customers for one period of one arrangement (architecture D14).\r\n            \r\nEvery row is keyed by the partner's own customer reference - the partner holds no TFN ids,\r\nand none are accepted here. The period is not sent as text: it is derived from\r\n{Tranzact.Transport.BusinessLogic.Services.EcosystemPaymaster.EcosystemPartnerAmountSubmissionRequest.ProcessDate} (or the arrangement's next collection date when that is omitted)\r\nby {Tranzact.Transport.BusinessLogic.Services.EcosystemPaymaster.EcosystemPeriodKey}, so a retried POST always lands on the same period.",
      "type": "object",
      "properties": {
        "ProcessDate": {
          "format": "date-time",
          "description": "Optional. The collection date the amounts are for. When omitted, the arrangement's next\r\ncollection date is used. Only the period it falls in matters: any date in the same month\r\n(monthly), ISO week (weekly) or any date at all (once-off) gives the same period.\r\nSend a date only, yyyy-MM-dd (for example 2026-10-01). A value carrying a time\r\nzone (+02:00 or Z) is read as its calendar date in South African time.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Amounts": {
          "description": "One row per customer. At most {Tranzact.Transport.BusinessLogic.Services.EcosystemPaymaster.EcosystemPartnerAmountSubmissionService.MaxAmountsPerRequest} rows.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.EcosystemPaymaster.EcosystemPartnerAmountSubmissionItem"
          }
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.EcosystemPaymaster.EcosystemPartnerAmountSubmissionItem": {
      "description": "One customer's amount in an {Tranzact.Transport.BusinessLogic.Services.EcosystemPaymaster.EcosystemPartnerAmountSubmissionRequest}.",
      "type": "object",
      "properties": {
        "PartnerCustomerReference": {
          "description": "The partner's own reference for the customer, as linked on the partner service. At most 100 characters.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Amount": {
          "format": "double",
          "description": "The amount to collect from the customer. Not negative and not above the arrangement's maximum per customer.",
          "type": "number"
        },
        "ExternalReference": {
          "description": "Optional. The partner's own reference for the amount (an invoice or fine number). At most 100 characters.",
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.EcosystemPaymaster.EcosystemPartnerAmountSubmissionResult": {
      "description": "What happened to each row of an {Tranzact.Transport.BusinessLogic.Services.EcosystemPaymaster.EcosystemPartnerAmountSubmissionRequest}.\r\n            \r\nD13: the partner is answered in its own keys only. There is deliberately no TFN customer id,\r\ncustomer name or account number anywhere on this type or on\r\n{Tranzact.Transport.BusinessLogic.Services.EcosystemPaymaster.EcosystemPartnerAmountSubmissionRow} - a resolved reference is reported as\r\nCreated or Updated, never as the customer it resolved to.",
      "type": "object",
      "properties": {
        "PeriodKey": {
          "description": "The period the amounts were staged against, derived from the arrangement's frequency (e.g. 2026-09, 2026-W40, ONCE).",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CreatedCount": {
          "format": "int32",
          "description": "Rows staged for the first time and resolved to a linked customer.",
          "type": "integer"
        },
        "UpdatedCount": {
          "format": "int32",
          "description": "Rows that replaced an amount already staged for the same reference and period, resolved to a linked customer.",
          "type": "integer"
        },
        "UnmatchedCount": {
          "format": "int32",
          "description": "Rows whose reference matches no linked customer. They are staged unresolved, not dropped.",
          "type": "integer"
        },
        "AmbiguousCount": {
          "format": "int32",
          "description": "Rows whose reference matches more than one linked customer. They are staged unresolved.",
          "type": "integer"
        },
        "RejectedCount": {
          "format": "int32",
          "description": "Rows refused and not staged; each row's Message says why.",
          "type": "integer"
        },
        "LockedCount": {
          "format": "int32",
          "description": "Rows not staged because a collection already exists for the period.",
          "type": "integer"
        },
        "Rows": {
          "description": "One entry per request row, in request order.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.EcosystemPaymaster.EcosystemPartnerAmountSubmissionRow"
          }
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.EcosystemPaymaster.EcosystemPartnerAmountSubmissionRow": {
      "description": "The outcome of one request row. See {Tranzact.Transport.BusinessLogic.Services.EcosystemPaymaster.EcosystemPartnerAmountSubmissionOutcome} for the values.",
      "type": "object",
      "properties": {
        "PartnerCustomerReference": {
          "description": "The partner customer reference as received (trimmed).",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Outcome": {
          "description": "Created, Updated, Unmatched, Ambiguous, Rejected or Locked.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Message": {
          "description": "Why the row was not resolved or not staged; empty for Created and Updated.",
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.PermissionListPOCOSummary": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "permissionTitle": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.PhoneNumberPOCOSummary": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "linkedEntityId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "fullNumberLocal": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "fullNumberInternational": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "displayTitle": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "secureDisplayTitle": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.PhoneNumberTypePOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "title": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.PostalCodeWithCityAreaPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "postalCodeId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "displayTitle": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "areaId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "cityAreaId": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "cityAreaDisplayTitle": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "areaTitle": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "code": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.CustomerPriceSerializable": {
      "type": "object",
      "properties": {
        "SupplierName": {
          "description": "The name of the supplier (when applicable)",
          "default": "",
          "type": "string",
          "example": ""
        },
        "SupplierNumber": {
          "description": "The TFN account number for the supplier (when applicable)",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Price": {
          "format": "double",
          "description": "The final price (including volume and promotional discounts) paid by the logged in customer.\r\nFor a fuel product this is the price per litre, relative to grid.\r\nFor a non fuel product this is the price of a single quantity of the product.",
          "type": "number"
        },
        "PriceIncludingGrid": {
          "format": "double",
          "description": "The final price (including volume and promotional discounts) paid by the logged in customer.\r\nFor a fuel product this is the price per litre.\r\nFor a non fuel product this is the price of a single quantity of the product.",
          "type": "number"
        },
        "VolumeDiscount": {
          "format": "double",
          "description": "Volume discount received",
          "type": "number"
        },
        "PromotionalDiscount": {
          "format": "double",
          "description": "Promotional discount received",
          "type": "number"
        },
        "HasSpecificPricing": {
          "description": "Has Specific Pricing",
          "default": false,
          "type": "boolean",
          "example": false
        },
        "SpecificPricing": {
          "description": "If it has specific pricing then a list of specific prices is returned",
          "type": "array",
          "items": {
            "$ref": "#/definitions/POCOs.SupplySiteSpecificPricingPOCO"
          }
        },
        "CustomerExternalReference": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "ParentExternalReference": {
          "description": "The external reference for the parent customer at this supply site and product.\r\nOnly populated for sub-account customers where the parent has external references enabled.\r\nWill be empty for normal (non-sub-account) customers.",
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "POCOs.SupplySiteSpecificPricingPOCO": {
      "type": "object",
      "properties": {
        "Description": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "Price": {
          "format": "double",
          "type": "number"
        },
        "CurrencySymbol": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.CustomerProductSerializable": {
      "type": "object",
      "properties": {
        "Title": {
          "description": "Product title",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Code": {
          "description": "Product code",
          "default": "",
          "type": "string",
          "example": ""
        },
        "ProductCategoryTitle": {
          "description": "Product category title",
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.WebHookTransactionExport.WebhookTransaction": {
      "type": "object",
      "properties": {
        "TransactionID": {
          "format": "uuid",
          "description": "Unique Transaction Identifier",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "CustomerNumber": {
          "description": "The customer number of the associated customer",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CustomerExternalNumber": {
          "description": "The external account reference of the associated customer",
          "default": "",
          "type": "string",
          "example": ""
        },
        "ChildCustomerNumber": {
          "description": "The child customer number of the associated child customer (only applicable to service provider transactions)",
          "default": "",
          "type": "string",
          "example": ""
        },
        "ChildCustomerExternalNumber": {
          "description": "The external account reference of the associated child customer (only applicable to service provider transactions)",
          "default": "",
          "type": "string",
          "example": ""
        },
        "ProductCode": {
          "description": "The code of the purchased product (when applicable)\r\nExample codes:\r\n- SHO:\tShower\r\n- WB:\tWeigh bridge\r\n- D1:\tDiesel (500ppm)\r\n- ULP93:\tPetrol (ULP93)\r\n- D0:\tDiesel (50ppm)\r\n- PAR:\tParts\r\n- IPB:\tIP (Bulk)\r\n- F2:\tAdBlue\r\n- OS:\tOvernight stay\r\n- F:\tOil\r\n- ULP95:\tPetrol (ULP95)\r\n- L1:\tLaundry\r\n- WKS:\tWorkshop\r\n- CAN:\tCanteen\r\n- SHP:\tShop\r\n- W:\tTruck wash\r\n- D3:\tDiesel (10ppm)\r\n- EW:\teWallet Allocation",
          "default": "",
          "type": "string",
          "example": ""
        },
        "TransactionTypeCode": {
          "description": "The type of transaction\r\nWhen a product code is specified then the transaction type is assumed to be a purchase.\r\nExample codes:\r\n- CX: Correction\r\n- ETMF: eToll account management fee\r\n- EWF: eWallet fee\r\n- SMS: SMS Monitor fee\r\n- ASF: Account setup fee\r\n- ACF: Annual card fee\r\n- CD: Account debit\r\n- LCP: Lost card protection fee\r\n- CDR: Cash deposit fee\r\n- CC: Customer deposit\r\n- OF: Order setup fee\r\n- MCF: Monthly account fee\r\n- CDF: Cheque deposit fee\r\n- OR: Monthly orders and route management fee\r\n- ER: Exception reporting service fee\r\n- HBDF: Home base depot fee\r\n- EM: Email monitor fee",
          "default": "",
          "type": "string",
          "example": ""
        },
        "TransactionDate": {
          "format": "date-time",
          "description": "The date the transaction took place",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CapturedDate": {
          "format": "date-time",
          "description": "The date the transaction was captured in the TFN system",
          "default": "",
          "type": "string",
          "example": ""
        },
        "DepotName": {
          "description": "The name of the supplier (when applicable)",
          "default": "",
          "type": "string",
          "example": ""
        },
        "DepotNumber": {
          "description": "The TFN account number for the supplier (when applicable)",
          "default": "",
          "type": "string",
          "example": ""
        },
        "VehicleRegistration": {
          "description": "Vehicle registration",
          "default": "",
          "type": "string",
          "example": ""
        },
        "VehicleFleetNumber": {
          "description": "Vehicle fleet number",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Amount": {
          "format": "double",
          "description": "Transaction Amount\r\n - Positive amounts increase customer balance\r\n - Negative amounts decrease customer balance",
          "type": "number"
        },
        "VAT": {
          "format": "double",
          "description": "Transaction VAT Amount",
          "type": "number"
        },
        "ChildAccountAmount": {
          "format": "double",
          "description": "The amount charged to the child customer (only applicable to service provider transactions)\r\n - Positive amounts increase child customer balance\r\n - Negative amounts decrease child customer balance",
          "type": "number"
        },
        "ChildAccountVAT": {
          "format": "double",
          "description": "The VAT amount charged to the child customer (only applicable to service provider transactions)",
          "type": "number"
        },
        "Litres": {
          "format": "double",
          "description": "The Litres pumped (when applicable)",
          "type": "number"
        },
        "Odometer": {
          "format": "double",
          "description": "The odometer of the vehicle (when available)",
          "type": "number"
        },
        "UtilisedOrders": {
          "description": "Orders utilised to complete this transaction",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.TransactionOrder"
          }
        },
        "TransactionReference": {
          "description": "The Transaction reference number of the transaction",
          "default": "",
          "type": "string",
          "example": ""
        },
        "ReversedTransactionDetails": {
          "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.ReversedTransaction",
          "description": "A reference to the transaction that has been reversed.\r\nTypically this is a product purchase of some sort that has been cancelled or reprocessed.\r\nWill be set for transaction reversals and \r\ncan be used to determine if the current transaction is a reversal."
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.TransactionOrder": {
      "description": "An order utilised or partially utilised to complete a transaction",
      "type": "object",
      "properties": {
        "OrderNumber": {
          "description": "System generated order number",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CustomerReferences": {
          "description": "Any customer references specified on the order (entry and order level)",
          "default": "",
          "type": "string",
          "example": ""
        },
        "AllocatedLitres": {
          "format": "double",
          "description": "Number of litres allocated to the order by the transaction",
          "type": "number"
        },
        "AllocatedAmount": {
          "format": "double",
          "description": "Amount in ZAR allocated to the order by the transaction",
          "type": "number"
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.ReversedTransaction": {
      "description": "Information about a reversed transaction",
      "type": "object",
      "properties": {
        "TransactionID": {
          "format": "uuid",
          "description": "The TransactionID of the reversed transaction",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "IsFuel": {
          "description": "The transaction type of the reversed transaction (Fuel or Non Fuel)",
          "default": false,
          "type": "boolean",
          "example": false
        },
        "TransactionReference": {
          "description": "The authorisation reference of the reversed transaction.",
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.ServiceAgreementPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "title": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.SubAccountPricing.StatementLinesPage": {
      "description": "One page of statement lines.",
      "type": "object",
      "properties": {
        "Lines": {
          "description": "The lines on this page.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.SubAccountPricing.StatementLine"
          }
        },
        "NextContinuationCapturedDate": {
          "format": "date-time",
          "description": "The captured date to pass as the continuation to get the next page, or null on the last page. A page\r\ncan be empty and still carry a continuation, when a long run of rows was left off the statement.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "NextContinuationID": {
          "format": "uuid",
          "description": "The transaction ID to pass as the continuation to get the next page, or null on the last page.",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.SubAccountPricing.StatementLine": {
      "description": "One transaction line on a statement, with its price breakdown.",
      "type": "object",
      "properties": {
        "TransactionID": {
          "format": "uuid",
          "description": "The transaction's ID.",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "CapturedDate": {
          "format": "date-time",
          "description": "When the transaction was captured.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "TransactionDate": {
          "format": "date-time",
          "description": "When the transaction took place.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CustomerNumber": {
          "description": "The customer number of the account the transaction belongs to.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CustomerName": {
          "description": "The name of the account the transaction belongs to.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "DepotName": {
          "description": "The depot the transaction took place at.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "ProductName": {
          "description": "The product on the transaction.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "TransactionType": {
          "description": "The type of transaction.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Litres": {
          "format": "double",
          "description": "Litres on the transaction.",
          "type": "number"
        },
        "Amount": {
          "format": "double",
          "description": "The amount the statement shows for the line, in Rand including VAT. Positive amounts increase the\r\naccount's balance (deposits, reversals of purchases) and negative amounts decrease it (purchases,\r\nfees), the same sign convention as the transaction export's Amount. Every line carries it,\r\nincluding those without a price breakdown. For a sub-account fuel transaction seen with the\r\nsub-account view it is the sub-account's amount, never the main account's.",
          "type": "number"
        },
        "PriceBreakdown": {
          "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.SubAccountPricing.TransactionPriceBreakdown",
          "description": "The transaction's price breakdown, or null for a line that is not a product transaction\r\n(a deposit, payment or fee without a product)."
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.SubAccountPricing.TransactionPriceBreakdown": {
      "description": "The price breakdown of one product transaction. {Tranzact.Transport.BusinessLogic.Services.SubAccountPricing.TransactionPriceBreakdown.MainAccount} is null when the caller\r\nis only allowed to see the sub-account's side of that transaction.",
      "type": "object",
      "properties": {
        "MainAccount": {
          "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.SubAccountPricing.MainAccountPriceBreakdown",
          "description": "The main account's side, or null when the caller may not see it for this transaction."
        },
        "SubAccount": {
          "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.SubAccountPricing.SubAccountPriceBreakdown",
          "description": "The sub-account's side, or null for a transaction that is not a sub-account transaction."
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.SubAccountPricing.MainAccountPriceBreakdown": {
      "description": "The main account's side of a transaction's price breakdown.",
      "type": "object",
      "properties": {
        "GrossAmount": {
          "format": "double",
          "description": "Amount before any discounts.",
          "type": "number"
        },
        "VolumeDiscountAmount": {
          "format": "double",
          "description": "Volume discount given.",
          "type": "number"
        },
        "PromotionDiscountAmount": {
          "format": "double",
          "description": "Promotion discount given.",
          "type": "number"
        },
        "NetAmount": {
          "format": "double",
          "description": "Amount after discounts, including VAT.",
          "type": "number"
        },
        "NetAmountExclVat": {
          "format": "double",
          "description": "Net amount excluding VAT.",
          "type": "number"
        },
        "VatAmount": {
          "format": "double",
          "description": "VAT on the net amount.",
          "type": "number"
        },
        "NetAmountInclVat": {
          "format": "double",
          "description": "Net amount including VAT.",
          "type": "number"
        },
        "GrossPricePerLitre": {
          "format": "double",
          "description": "Gross price per litre.",
          "type": "number"
        },
        "VolumeDiscountPerLitre": {
          "format": "double",
          "description": "Volume discount per litre.",
          "type": "number"
        },
        "PromotionDiscountPerLitre": {
          "format": "double",
          "description": "Promotion discount per litre.",
          "type": "number"
        },
        "NetPricePerLitre": {
          "format": "double",
          "description": "Net price per litre.",
          "type": "number"
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.SubAccountPricing.SubAccountPriceBreakdown": {
      "description": "The sub-account's side of a transaction's price breakdown.",
      "type": "object",
      "properties": {
        "GrossAmount": {
          "format": "double",
          "description": "Amount before the markup and any discount passed on.",
          "type": "number"
        },
        "MarkupAmount": {
          "format": "double",
          "description": "Markup the service provider added.",
          "type": "number"
        },
        "MarkupPerLitre": {
          "format": "double",
          "description": "Markup per litre the service provider added.",
          "type": "number"
        },
        "DiscountPassedOnAmount": {
          "format": "double",
          "description": "Discount passed on to the sub-account.",
          "type": "number"
        },
        "DiscountPassedOnPerLitre": {
          "format": "double",
          "description": "Discount passed on to the sub-account, per litre.",
          "type": "number"
        },
        "NetAmount": {
          "format": "double",
          "description": "Amount the sub-account pays, including VAT.",
          "type": "number"
        },
        "NetAmountExclVat": {
          "format": "double",
          "description": "Net amount excluding VAT.",
          "type": "number"
        },
        "VatAmount": {
          "format": "double",
          "description": "VAT on the net amount.",
          "type": "number"
        },
        "NetAmountInclVat": {
          "format": "double",
          "description": "Net amount including VAT.",
          "type": "number"
        },
        "GrossPricePerLitre": {
          "format": "double",
          "description": "Gross price per litre.",
          "type": "number"
        },
        "NetPricePerLitre": {
          "format": "double",
          "description": "Net price per litre.",
          "type": "number"
        },
        "MarkupLoaded": {
          "description": "True when a markup was found for the transaction.",
          "default": false,
          "type": "boolean",
          "example": false
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.SubAccountAggregateLitresSerializable": {
      "description": "A single sub-account's aggregated fuel volume for one product over the reporting period.",
      "type": "object",
      "properties": {
        "SubAccountNumber": {
          "description": "The sub-account's customer number.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "SubAccountName": {
          "description": "The name of the sub-account.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "ProductName": {
          "description": "The name of the fuel product.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "ProductAggregateLitres": {
          "format": "double",
          "description": "The total litres of the product consumed by the sub-account over the reporting period.",
          "type": "number"
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.SubAccountBalanceSerializable": {
      "description": "The current balance for a sub-account.",
      "type": "object",
      "properties": {
        "CustomerNumber": {
          "description": "The sub-account's customer number.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "AccountBalance": {
          "format": "double",
          "description": "The current statement balance on the account.",
          "type": "number"
        },
        "AccountAvailableBalance": {
          "format": "double",
          "description": "The amount still available to spend, after accounting for pending transactions.",
          "type": "number"
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.SubAccountCreditLimitSerializable": {
      "description": "The credit limit for a sub-account.",
      "type": "object",
      "properties": {
        "SubAccountNumber": {
          "description": "The sub-account's customer number.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "SubAccountName": {
          "description": "The name of the sub-account.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CreditLimit": {
          "format": "double",
          "description": "The maximum credit available to this sub-account.",
          "type": "number"
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.CustomerService.SubAccountOnboardingRequest": {
      "description": "Request body for onboarding/updating driver sub-accounts. Each driver becomes its own\r\nsub-account of the parent organisation, with its vehicles assigned via driverVehicleLinks.",
      "type": "object",
      "properties": {
        "ExternalCustomerNumber": {
          "description": "The submitting party's own reference for this batch (stored on each sub-account). Optional.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "ParentCustomerNumber": {
          "description": "The parent organisation's customer number. The caller must be linked to it. Required.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Drivers": {
          "description": "The drivers to onboard/update. Each becomes its own sub-account. Required (at least one).",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.CustomerService.SubAccountDriver"
          }
        },
        "Vehicles": {
          "description": "The vehicles referenced by driverVehicleLinks.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.CustomerService.SubAccountVehicle"
          }
        },
        "DriverVehicleLinks": {
          "description": "Links each driver (by cell number) to one or more vehicles (by registration).",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.CustomerService.SubAccountDriverVehicleLink"
          }
        },
        "CustomerNumber": {
          "description": "The sub-account's own customer number (its FullNumber). Blank on create (the system\r\nassigns it); required on update/get/delete as the unique identifier.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CustomerName": {
          "description": "The sub-account's display name (Customer.Title). If blank on create, it is defaulted to\r\nthe first driver's name and surname.",
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.CustomerService.SubAccountDriver": {
      "description": "A driver to onboard as a sub-account.",
      "type": "object",
      "properties": {
        "CellPhone": {
          "description": "The driver's cell number. Required. Used as the driver's app login and as the update match key.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Name": {
          "description": "The driver's first name. Required.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Surname": {
          "description": "The driver's surname. Required.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "IdNumber": {
          "description": "The driver's ID number. Optional.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Email": {
          "description": "The driver's email address. Optional.",
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.CustomerService.SubAccountVehicle": {
      "description": "A vehicle to capture for a sub-account.",
      "type": "object",
      "properties": {
        "Registration": {
          "description": "The vehicle registration. Required.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "FleetNumber": {
          "description": "The fleet number. Optional.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Make": {
          "description": "The vehicle make. Optional.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Model": {
          "description": "The vehicle model. Optional.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Year": {
          "format": "int32",
          "description": "The vehicle year. Optional.",
          "type": "integer"
        },
        "FuelType": {
          "description": "The fuel type (e.g. Petrol, Diesel) — mapped to a product category. Optional.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "FuelTankSize": {
          "format": "int32",
          "description": "The fuel tank size in litres. Defaults to 75 if not supplied.",
          "type": "integer"
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.CustomerService.SubAccountDriverVehicleLink": {
      "description": "Links a driver (by cell number) to a vehicle (by registration).",
      "type": "object",
      "properties": {
        "DriverCellNumber": {
          "description": "The driver's cell number (must match a driver in the request).",
          "default": "",
          "type": "string",
          "example": ""
        },
        "VehicleRegistration": {
          "description": "The vehicle registration (must match a vehicle in the request).",
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.SubAccountPricing.SubAccountPricingSettingsPage": {
      "description": "One page of sub-account pricing settings.",
      "type": "object",
      "properties": {
        "Settings": {
          "description": "The settings on this page.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.SubAccountPricing.SubAccountDepotPricingSetting"
          }
        },
        "NextContinuationCustomerNumber": {
          "description": "The customer number to pass as the continuation to get the next page, or null on the last page.",
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.SubAccountPricing.SubAccountDepotPricingSetting": {
      "description": "The pricing a service provider applies to one sub-account at one depot.",
      "type": "object",
      "properties": {
        "SubAccountCustomerNumber": {
          "description": "The sub-account's customer number.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "SubAccountName": {
          "description": "The sub-account's name.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "SupplySiteID": {
          "format": "uuid",
          "description": "The depot's ID.",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "DepotName": {
          "description": "The depot's name.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "DefaultMarkupPerLitre": {
          "format": "double",
          "description": "The sub-account's default markup per litre.",
          "type": "number"
        },
        "DepotSpecificMarkupPerLitre": {
          "format": "double",
          "description": "The markup per litre set for this depot specifically, when there is one.",
          "type": "number"
        },
        "DepotSpecificMarkupLoaded": {
          "description": "True when a depot-specific markup is set, so {Tranzact.Transport.BusinessLogic.Services.SubAccountPricing.SubAccountDepotPricingSetting.DepotSpecificMarkupPerLitre} applies.",
          "default": false,
          "type": "boolean",
          "example": false
        },
        "MarkupPerLitreInEffect": {
          "format": "double",
          "description": "The markup per litre that applies at this depot: the depot-specific one when loaded, otherwise the default.",
          "type": "number"
        },
        "VolumeDiscountPercentagePassedOn": {
          "format": "double",
          "description": "The volume discount percentage passed on to the sub-account.",
          "type": "number"
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.SystemUserTypePOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "title": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "webApiMethodName": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "hasWebApiMethod": {
          "default": false,
          "type": "boolean",
          "example": false
        },
        "dashboardLayoutList": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.EntityInformation.WebApi.DashboardLayoutPOCO"
          }
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.TransactionAggregateSerializable": {
      "description": "The transaction aggregates for one caller and one period, grouped by sub-account and then by\r\nproduct and fee type. Every amount is a net figure with sales positive and reversals negative,\r\ntaken from the same transaction values the Organisation statement is built from.",
      "type": "object",
      "properties": {
        "Currency": {
          "description": "The currency every amount in the response is expressed in.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "PeriodStart": {
          "format": "date-time",
          "description": "The start of the period the aggregates cover (inclusive).",
          "default": "",
          "type": "string",
          "example": ""
        },
        "PeriodEnd": {
          "format": "date-time",
          "description": "The end of the period the aggregates cover (inclusive).",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CustomerNumber": {
          "description": "The calling customer's account number.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CustomerName": {
          "description": "The calling customer's name.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "SubAccounts": {
          "description": "One block per sub-account (the caller's own transactions form a block for the caller itself),\r\nordered by account number. Accounts with nothing to report in the period are omitted.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.TransactionAggregateSubAccountSerializable"
          }
        },
        "Totals": {
          "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.TransactionAggregateTotalsSerializable",
          "description": "The totals across every sub-account block in the response."
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.TransactionAggregateSubAccountSerializable": {
      "description": "The aggregates for a single sub-account over the period.",
      "type": "object",
      "properties": {
        "SubAccountNumber": {
          "description": "The sub-account's customer number.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "SubAccountName": {
          "description": "The name of the sub-account.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Products": {
          "description": "One line per product, and per reversal of that product, ordered by product code.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.TransactionAggregateProductSerializable"
          }
        },
        "Fees": {
          "description": "One line per fee type, and per reversal of that fee type, ordered by fee type code.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.TransactionAggregateFeeSerializable"
          }
        },
        "Totals": {
          "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.TransactionAggregateTotalsSerializable",
          "description": "The totals for this sub-account."
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.TransactionAggregateTotalsSerializable": {
      "description": "Totals over a set of product and fee lines. Quantities and amounts are net of reversals.",
      "type": "object",
      "properties": {
        "Litres": {
          "format": "double",
          "description": "The net litres across the fuel lines (reversals are negative).",
          "type": "number"
        },
        "NonFuelQuantity": {
          "format": "double",
          "description": "The net item quantity across the non-fuel product lines (reversals are negative).",
          "type": "number"
        },
        "TransactionCount": {
          "format": "int32",
          "description": "The number of fuel and non-fuel sales. Reversals and fees are not counted here.",
          "type": "integer"
        },
        "ReversalCount": {
          "format": "int32",
          "description": "The number of reversals, of products and of fees.",
          "type": "integer"
        },
        "FeeCount": {
          "format": "int32",
          "description": "The number of fees charged. Reversals of fees are counted under the reversal count.",
          "type": "integer"
        },
        "AmountExclVat": {
          "format": "double",
          "description": "The net amount excluding VAT across products, fees and reversals.",
          "type": "number"
        },
        "Vat": {
          "format": "double",
          "description": "The net VAT across products, fees and reversals.",
          "type": "number"
        },
        "AmountInclVat": {
          "format": "double",
          "description": "The net amount including VAT across products, fees and reversals.",
          "type": "number"
        },
        "SubAccountAmount": {
          "format": "double",
          "description": "The net amount charged to the sub-accounts by the service provider across the product and\r\nfee lines.",
          "type": "number"
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.TransactionAggregateProductSerializable": {
      "description": "The aggregate for one product (or for the reversals of that product) for one sub-account.",
      "type": "object",
      "properties": {
        "ProductCode": {
          "description": "The product code.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "ProductName": {
          "description": "The product name.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "ProductType": {
          "description": "\"Fuel\" for a fuel product, \"NonFuel\" for any other product.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "IsReversal": {
          "description": "True when this line holds reversals of earlier sales, which come out negative.\r\nFalse for sales.",
          "default": false,
          "type": "boolean",
          "example": false
        },
        "TransactionCount": {
          "format": "int32",
          "description": "The number of transactions (or, on a reversal line, reversals) on this line.",
          "type": "integer"
        },
        "Quantity": {
          "format": "double",
          "description": "The litres for a fuel product, or the item quantity for a non-fuel product.\r\nNegative on a reversal line.",
          "type": "number"
        },
        "AmountExclVat": {
          "format": "double",
          "description": "The amount excluding VAT.",
          "type": "number"
        },
        "Vat": {
          "format": "double",
          "description": "The VAT.",
          "type": "number"
        },
        "AmountInclVat": {
          "format": "double",
          "description": "The amount including VAT.",
          "type": "number"
        },
        "SubAccountAmount": {
          "format": "double",
          "description": "The amount charged to the sub-account by the service provider (the \"sub account amount\"\r\ncolumn on the Organisation statement). Zero when the sale was not made through a service\r\nprovider.",
          "type": "number"
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.TransactionAggregateFeeSerializable": {
      "description": "The aggregate for one fee type (or for the reversals of that fee type) for one sub-account.",
      "type": "object",
      "properties": {
        "FeeTypeCode": {
          "description": "The fee type code.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "FeeTypeName": {
          "description": "The fee type name, for example \"Monthly account fee\".",
          "default": "",
          "type": "string",
          "example": ""
        },
        "IsReversal": {
          "description": "True when this line holds reversals of earlier fees, which come out negative.\r\nFalse for fees charged.",
          "default": false,
          "type": "boolean",
          "example": false
        },
        "TransactionCount": {
          "format": "int32",
          "description": "The number of fees (or, on a reversal line, reversals) on this line.",
          "type": "integer"
        },
        "AmountExclVat": {
          "format": "double",
          "description": "The amount excluding VAT.",
          "type": "number"
        },
        "Vat": {
          "format": "double",
          "description": "The VAT.",
          "type": "number"
        },
        "AmountInclVat": {
          "format": "double",
          "description": "The amount including VAT.",
          "type": "number"
        },
        "SubAccountAmount": {
          "format": "double",
          "description": "The amount charged to the sub-account by the service provider (the \"sub account amount\"\r\ncolumn on the Organisation statement). Zero when the fee was not charged through a service\r\nprovider.",
          "type": "number"
        }
      }
    },
    "CustomerAPI.Integration.TransactionSerializable": {
      "description": "A fuel transaction as the Customer API returns it.",
      "type": "object",
      "properties": {
        "TransactionID": {
          "format": "uuid",
          "description": "Unique Transaction Identifier",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "CustomerNumber": {
          "description": "The customer number of the associated customer",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CustomerExternalNumber": {
          "description": "The external account reference of the associated customer",
          "default": "",
          "type": "string",
          "example": ""
        },
        "ChildCustomerNumber": {
          "description": "The child customer number of the associated child customer (only applicable to service provider transactions)",
          "default": "",
          "type": "string",
          "example": ""
        },
        "ChildCustomerExternalNumber": {
          "description": "The external account reference of the associated child customer (only applicable to service provider transactions)",
          "default": "",
          "type": "string",
          "example": ""
        },
        "ProductCode": {
          "description": "The code of the purchased product (when applicable)\r\nExample codes:\r\n- SHO:\tShower\r\n- WB:\tWeigh bridge\r\n- D1:\tDiesel (500ppm)\r\n- ULP93:\tPetrol (ULP93)\r\n- D0:\tDiesel (50ppm)\r\n- PAR:\tParts\r\n- IPB:\tIP (Bulk)\r\n- F2:\tAdBlue\r\n- OS:\tOvernight stay\r\n- F:\tOil\r\n- ULP95:\tPetrol (ULP95)\r\n- L1:\tLaundry\r\n- WKS:\tWorkshop\r\n- CAN:\tCanteen\r\n- SHP:\tShop\r\n- W:\tTruck wash\r\n- D3:\tDiesel (10ppm)\r\n- EW:\teWallet Allocation",
          "default": "",
          "type": "string",
          "example": ""
        },
        "TransactionTypeCode": {
          "description": "The type of transaction\r\nWhen a product code is specified then the transaction type is assumed to be a purchase.\r\nExample codes:\r\n- CX: Correction\r\n- ETMF: eToll account management fee\r\n- EWF: eWallet fee\r\n- SMS: SMS Monitor fee\r\n- ASF: Account setup fee\r\n- ACF: Annual card fee\r\n- CD: Account debit\r\n- LCP: Lost card protection fee\r\n- CDR: Cash deposit fee\r\n- CC: Customer deposit\r\n- OF: Order setup fee\r\n- MCF: Monthly account fee\r\n- CDF: Cheque deposit fee\r\n- OR: Monthly orders and route management fee\r\n- ER: Exception reporting service fee\r\n- HBDF: Home base depot fee\r\n- EM: Email monitor fee",
          "default": "",
          "type": "string",
          "example": ""
        },
        "TransactionDate": {
          "format": "date-time",
          "description": "The date the transaction took place",
          "default": "",
          "type": "string",
          "example": ""
        },
        "CapturedDate": {
          "format": "date-time",
          "description": "The date the transaction was captured in the TFN system",
          "default": "",
          "type": "string",
          "example": ""
        },
        "SupplierName": {
          "description": "The name of the supplier (when applicable)",
          "default": "",
          "type": "string",
          "example": ""
        },
        "SupplierNumber": {
          "description": "The TFN account number for the supplier (when applicable)",
          "default": "",
          "type": "string",
          "example": ""
        },
        "VehicleRegistration": {
          "description": "Vehicle registration",
          "default": "",
          "type": "string",
          "example": ""
        },
        "VehicleFleetNumber": {
          "description": "Vehicle fleet number",
          "default": "",
          "type": "string",
          "example": ""
        },
        "VehicleExternalNumber": {
          "description": "Vehicle external number",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Amount": {
          "format": "double",
          "description": "Transaction Amount\r\n - Positive amounts increase customer balance\r\n - Negative amounts decrease customer balance",
          "type": "number"
        },
        "VAT": {
          "format": "double",
          "description": "Transaction VAT Amount",
          "type": "number"
        },
        "ChildAccountAmount": {
          "format": "double",
          "description": "The amount charged to the child customer (only applicable to service provider transactions)\r\n - Positive amounts increase child customer balance\r\n - Negative amounts decrease child customer balance",
          "type": "number"
        },
        "ChildAccountVAT": {
          "format": "double",
          "description": "The VAT amount charged to the child customer (only applicable to service provider transactions)",
          "type": "number"
        },
        "Litres": {
          "format": "double",
          "description": "The Litres pumped (when applicable)",
          "type": "number"
        },
        "Odometer": {
          "format": "double",
          "description": "The odometer of the vehicle (when available)",
          "type": "number"
        },
        "UtilisedOrders": {
          "description": "Orders utilised to complete this transaction",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.TransactionOrder"
          }
        },
        "TransactionReference": {
          "description": "The Transaction reference number of the transaction",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Identifier": {
          "description": "The identifiers used to identify the customer",
          "default": "",
          "type": "string",
          "example": ""
        },
        "ReversedTransaction": {
          "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.ReversedTransaction",
          "description": "A reference to the transaction that has been reversed.\r\nTypically this is a product purchase of some sort that has been cancelled or reprocessed.\r\nWill be set for transaction reversals and \r\ncan be used to determine if the current transaction is a reversal."
        },
        "PriceBreakdown": {
          "$ref": "#/definitions/Tranzact.Transport.BusinessLogic.Services.SubAccountPricing.TransactionPriceBreakdown",
          "description": "The price breakdown of the transaction: gross, discounts, markup and net, in Rand and per litre.\r\nA caller who is the transaction's sub-account only gets the sub-account side\r\n(SubAccount); a caller who is the main account also gets the main account side\r\n(MainAccount) on the transactions of its own account and its sub-accounts. SubAccount\r\nis null for a transaction that is not a sub-account transaction. The whole breakdown is null for a\r\ntransaction that is not a product transaction (a deposit, payment or fee without a product)."
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.UserListPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "title": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "username": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "systemUserDashboardListCount": {
          "format": "int32",
          "type": "integer"
        }
      }
    },
    "Tranzact.EntityInformation.WebApi.SystemUserPOCO": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "default": "",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "title": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "username": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "surname": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "newPassword": {
          "default": "",
          "type": "string",
          "example": ""
        },
        "isNew": {
          "default": false,
          "type": "boolean",
          "example": false
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.CustomerService.UserStatusPOCO": {
      "description": "The current status of a user account.",
      "type": "object",
      "properties": {
        "Username": {
          "description": "The account username.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Email": {
          "description": "The email address associated with the account.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Locked": {
          "description": "Whether the account is locked. A locked account cannot sign in.",
          "default": false,
          "type": "boolean",
          "example": false
        },
        "LoginAttempts": {
          "format": "int32",
          "description": "The number of consecutive failed sign-in attempts.",
          "type": "integer"
        },
        "LastActivity": {
          "format": "date-time",
          "description": "The date and time of the user's last activity.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "Status": {
          "description": "A description of the account's current status (e.g. Active, Locked).",
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.VehicleSerializable": {
      "type": "object",
      "properties": {
        "Registration": {
          "description": "The vehicle registration number (mandatory)",
          "default": "",
          "type": "string",
          "example": ""
        },
        "FleetNumber": {
          "description": "The vehicle fleet number  (optional)",
          "default": "",
          "type": "string",
          "example": ""
        },
        "TankSize": {
          "format": "int32",
          "description": "Tank size in litres  (mandatory)",
          "type": "integer"
        },
        "Status": {
          "format": "int32",
          "description": "Status of the vehicle\r\n - WrittenOff\r\n - Dormant\r\n - Unused\r\n - Active\r\n - Stolen\r\n - Moved\r\n - Sold",
          "enum": [
            0,
            1,
            2,
            3,
            4,
            5,
            6,
            7
          ],
          "type": "integer"
        },
        "ExternalNumber": {
          "description": "The vehicle external number  (optional)",
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.Services.VehicleResult": {
      "type": "object",
      "properties": {
        "Successful": {
          "type": "boolean"
        },
        "Message": {
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "CustomerAPI.Controllers.VersionPOCO": {
      "description": "The version details the version endpoint returns.",
      "type": "object",
      "properties": {
        "Version": {
          "description": "The application version, with this assembly's revision.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "SupportVersion": {
          "description": "The pipeline's build version, for support.",
          "default": "",
          "type": "string",
          "example": ""
        }
      }
    },
    "Tranzact.Transport.BusinessLogic.VirtualCardSerialisable": {
      "description": "The virtual card number assigned to a vehicle.",
      "type": "object",
      "properties": {
        "VirtualCardNumber": {
          "description": "The virtual card number to use for transactions.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "VehicleRegistration": {
          "description": "The registration number of the vehicle this card is assigned to.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "StartDate": {
          "format": "date-time",
          "description": "The date and time from which this card number is valid.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "ExpiryDate": {
          "format": "date-time",
          "description": "The date and time after which this card number can no longer be used.",
          "default": "",
          "type": "string",
          "example": ""
        },
        "IsOneUse": {
          "description": "Whether this card number is single-use. When true, the number expires after one transaction.",
          "default": false,
          "type": "boolean",
          "example": false
        }
      }
    }
  },
  "securityDefinitions": {
    "apiKey": {
      "type": "apiKey",
      "description": "API Key Authentication",
      "name": "Authorization",
      "in": "header"
    }
  },
  "tags": [
    {
      "name": "Authentication"
    },
    {
      "name": "System Health"
    },
    {
      "name": "Order Management"
    },
    {
      "name": "Pricing & Fuel Network"
    },
    {
      "name": "Driver Management"
    },
    {
      "name": "Account Settings"
    },
    {
      "name": "Session Management"
    },
    {
      "name": "Transactions"
    },
    {
      "name": "User Status"
    },
    {
      "name": "Vehicle Management"
    },
    {
      "name": "Virtual Card Number"
    },
    {
      "name": "Sub-Account Management"
    },
    {
      "name": "Ecosystem Paymaster"
    }
  ]
}