{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"open-api","parameters":{"macroParams":{"__bodyContent":{"value":"openapi: \"3.0.0\"\ninfo:\n title: \"Freight Audit SelfService API\"\n description: \"This generic API allows shippers to request accruals, invoice data and confirmed transport cost.
\nThree endpoints offered:

\n1. Accruals “GET current accruals”
\nCan be obtained for both Cost Settlement Only and for Cost Settlement and Billing flows.
\nDetailed description: The accruals endpoint lists the costs of transports that are eligible for billing, excluding those transports which have been successfully invoiced (in CSB flow), or which have been confirmed by the carrier (in the CSO flow). All between the last request and current request, by loading date. In other words: The accruals endpoint lists the costs for transports that are not “Final”.
\n“Final” in this case means that no invoice is uploaded in CSB process or transport cost were not confirmed in CSO process.
\nHeaders show sum of the accrual amount per currency and the amount of transports to be accrued. Below the header, the transport cost are grouped by billing month*), by currency and by carrier ID.

\n*) billing month by Loading date of the transport. In case different deliveries of a transport have different loading dates, the earliest of those is used.

\n2. Invoices “GET new invoices”
\nOnly applies if the Cost settlement and Billing process is activated.
\nDetailed description: Provides invoice data of all verified single invoices with all the invoice items (transports on invoice), the account codes/ cost centers if applicable. Provided on shipper company level.
\nOnly the invoices which have been verified and approved since the last request are provided here. The header sums up the invoice amounts per same tax code and same currency.

\n3. Confirmed transport “GET new confirmed transports”
\nOnly applies if the cost settlement only (CSO) process is activated for at least one carrier.
\nDetailed description: Provides all transports and their cost that have been confirmed by carrier in FASS, since the last request was done. The output is cost information on transport level, with the cost breakdown per cost type.\"\n version: \"1.0.0\"\nservers:\n - url: \"https://eu1.api.trimblecloud.com/transportation/financials/v1\"\ncomponents:\n securitySchemes:\n OAuth2:\n type: oauth2\n flows:\n clientCredentials:\n tokenUrl: \"https://id.trimble-transportation.com/oauth2/token?grant_type=client_credentials&audience=sas_token\"\n scopes: {}\nsecurity:\n - OAuth2: []\npaths:\n /fass-invoices:\n get:\n tags: [\n \"Cost Settlement & Billing\"\n ]\n summary: \"GET new invoices\"\n description: \"Provides invoice data of all verified single invoices with all the invoice items (transports on invoice) since the last request.\"\n operationId: \"getInvoices\"\n responses:\n \"200\":\n description: \"OK\"\n content:\n 'application/json':\n schema:\n type: object\n properties:\n from:\n type: string\n description: \"Last export timestamp\"\n format: date-time\n example: \"2024-09-15T10:30:45.858+00:00\"\n until:\n type: string\n description: \"Current export timestamp\"\n format: date-time\n example: \"2024-09-16T10:30:45.858+00:00\"\n taxAmounts:\n type: array\n description: \"List of tax amounts\"\n items:\n type: object\n properties:\n taxCode:\n type: string\n description: \"Tax code\"\n example: \"XYZ\"\n amount:\n type: number\n description: \"Amount\"\n format: double\n example: 67.89\n currency:\n type: string\n description: \"Currency code\"\n example: \"EUR\"\n invoiceCount:\n type: integer\n description: \"Number of invoices\"\n example: 1\n invoices:\n type: array\n description: \"List of invoices\"\n items:\n type: object\n properties:\n number:\n type: string\n description: \"Invoice number\"\n example: \"invoice-123\"\n date:\n type: string\n description: \"Invoice date\"\n format: date\n example: \"2024-09-15\"\n approvalDate:\n type: string\n description: \"Approval date\"\n format: date-time\n example: \"2024-09-16T10:30:45.858+00:00\"\n prebillNumber:\n type: string\n description: \"Prebill number\"\n example: \"123\"\n carrierName:\n type: string\n description: \"Carrier name\"\n example: \"Wonderful Carrier\"\n carrierId:\n type: integer\n format: int64\n description: \"Carrier ID\"\n example: 123456\n carrierVendorCode:\n type: string\n description: \"Carrier vendor code\"\n example: \"ABC\"\n carrierTaxNumber:\n type: string\n description: \"Carrier tax number\"\n example: \"456-DEF\"\n shipperId:\n type: integer\n format: int64\n description: \"Shipper ID\"\n example: 234567\n billToCode:\n type: string\n description: \"Bill to code\"\n example: \"ABC\"\n billToId:\n type: integer\n format: int64\n description: \"Bill to ID\"\n example: 345678\n billToTaxNumber:\n type: string\n description: \"Bill to tax number\"\n example: \"789-GHI\"\n billToCountry:\n type: string\n description: \"Bill to country\"\n example: \"DE\"\n currency:\n type: string\n description: \"Currency code\"\n example: \"EUR\"\n netAmount:\n type: number\n format: double\n description: \"Net amount\"\n example: 123.45\n taxAmount:\n type: number\n format: double\n description: \"Tax amount\"\n example: 67.89\n fileId:\n type: integer\n format: int64\n description: \"File ID\"\n example: 123456\n taxAmounts:\n type: array\n description: \"List of tax amounts\"\n items:\n type: object\n properties:\n taxCode:\n type: string\n description: \"Tax code\"\n example: \"XYZ\"\n amount:\n type: number\n format: double\n description: \"Amount\"\n example: 67.89\n currency:\n type: string\n description: \"Currency code\"\n example: \"EUR\"\n totalAmount:\n type: number\n format: double\n description: \"Total amount\"\n example: 191.34\n transports:\n type: array\n description: \"List of transports\"\n items:\n type: object\n properties:\n id:\n type: integer\n format: int64\n description: \"TP Transport ID\"\n example: 1\n number:\n type: string\n description: \"Transport number\"\n example: \"TR-123\"\n schedulingUnit:\n type: string\n description: \"Scheduling unit\"\n example: \"Unit A\"\n loadingDate:\n type: string\n format: date\n description: \"Loading date\"\n example: \"2023-10-01\"\n originCountry:\n type: string\n description: \"Origin country code\"\n example: \"US\"\n originPostalCode:\n type: string\n description: \"Origin postal code\"\n example: \"12345\"\n originCity:\n type: string\n description: \"Origin city\"\n example: \"City A\"\n destinationCountry:\n type: string\n description: \"Destination country code\"\n example: \"CA\"\n destinationPostalCode:\n type: string\n description: \"Destination postal code\"\n example: \"54321\"\n destinationCity:\n type: string\n description: \"Destination city\"\n example: \"City B\"\n costs:\n type: array\n description: \"List of costs\"\n items:\n type: object\n properties:\n type:\n type: string\n description: \"Cost type\"\n example: \"transport\"\n originalCurrency:\n type: string\n description: \"Original currency\"\n example: \"USD\"\n originalAmount:\n type: number\n format: double\n description: \"Original amount\"\n example: 123.45\n conversionRate:\n type: number\n format: double\n description: \"Conversion rate\"\n example: 1.2345\n invoiceCurrency:\n type: string\n description: \"Invoice currency\"\n example: \"EUR\"\n invoiceAmount:\n type: number\n format: double\n description: \"Invoice amount\"\n example: 123.45\n taxType:\n type: string\n description: \"Tax type\"\n example: \"VAT\"\n taxRate:\n type: number\n format: double\n description: \"Tax rate\"\n example: 19.0\n taxAmount:\n type: number\n format: double\n description: \"Tax amount\"\n example: 23.45\n taxCode:\n type: string\n description: \"Tax code\"\n example: \"XYZ\"\n glAccount:\n type: string\n description: \"GL account\"\n example: \"GL-123\"\n costCenter:\n type: string\n description: \"Cost center\"\n example: \"CC-456\"\n accountCodes:\n type: array\n description: \"List of account codes\"\n items:\n type: object\n properties:\n name:\n type: string\n description: \"Account code name\"\n example: \"GL Account\"\n value:\n type: string\n description: \"Account code value\"\n example: \"ABC123\"\n /fass-confirmed-transports:\n get:\n tags: [\n \"Cost Settlement Only\"\n ]\n summary: \"GET new confirmed transports\"\n description: \"Provides all transports and their cost that have been confirmed by carrier in FASS, since the last request.\"\n operationId: \"getConfirmedTransports\"\n responses:\n \"200\":\n description: \"OK\"\n content:\n application/json:\n schema:\n type: object\n properties:\n from:\n type: string\n format: date-time\n description: \"Last export timestamp\"\n example: \"2024-09-15T10:30:45.858+00:00\"\n until:\n type: string\n format: date-time\n description: \"Current export timestamp\"\n example: \"2024-09-16T10:30:45.858+00:00\"\n transports:\n type: array\n description: \"List of transports\"\n items:\n type: object\n properties:\n id:\n type: integer\n description: \"TP Transport ID\"\n example: 123456\n number:\n type: string\n description: \"Transport number\"\n example: \"ABC-123\"\n shipperId:\n type: integer\n description: \"TP Shipper ID\"\n example: 234567\n shipperName:\n type: string\n description: \"Shipper name\"\n example: \"Wonderful Shipper\"\n schedulingUnit:\n type: string\n description: \"Scheduling unit\"\n example: \"DE Ulm\"\n carrierId:\n type: integer\n description: \"TP Carrier ID\"\n example: 345678\n carrierName:\n type: string\n description: \"Carrier name\"\n example: \"Best Carrier\"\n loadingDate:\n type: string\n format: date\n description: \"Loading date\"\n example: \"2024-09-15\"\n confirmationDate:\n type: string\n format: date-time\n description: \"Confirmation date\"\n example: \"2024-09-16T02:30:45.858+00:00\"\n originCountry:\n type: string\n description: \"Origin country\"\n example: \"DE\"\n originPostalCode:\n type: string\n description: \"Origin postal code\"\n example: \"89073\"\n originCity:\n type: string\n description: \"Origin city\"\n example: \"Ulm\"\n destinationCountry:\n type: string\n description: \"Destination country\"\n example: \"FR\"\n destinationPostalCode:\n type: string\n description: \"Destination postal code\"\n example: \"75001\"\n destinationCity:\n type: string\n description: \"Destination city\"\n example: \"Paris\"\n costs:\n type: array\n description: \"List of costs\"\n items:\n type: object\n properties:\n type:\n type: string\n description: \"Cost type\"\n example: \"Fuel Charge\"\n currency:\n type: string\n description: \"Currency\"\n example: \"EUR\"\n amount:\n type: number\n format: double\n description: \"Amount\"\n example: 123.45\n /fass-accruals:\n get:\n tags: [\n \"Cost Settlement & Billing\",\n \"Cost Settlement Only\"\n ]\n summary: \"GET current accruals\"\n description: \"Provides the current state of accruals.\"\n operationId: \"getAccruals\"\n responses:\n \"200\":\n description: \"OK\"\n content:\n application/json:\n schema:\n type: object\n properties:\n timestamp:\n type: string\n format: date-time\n description: \"Current export timestamp\"\n example: \"2024-09-16T10:30:45.858+00:00\"\n total:\n type: object\n description: \"Total accruals\"\n properties:\n currencies:\n type: array\n description: \"Amounts per currency\"\n items:\n type: object\n properties:\n code:\n type: string\n description: \"Currency code\"\n example: \"EUR\"\n amount:\n type: number\n format: double\n description: \"Amount\"\n example: 123.45\n transports:\n type: integer\n description: \"Number of transports\"\n example: 100\n billingProcess:\n type: object\n description: \"Accruals for billing process\"\n properties:\n total:\n type: object\n description: \"Total accruals\"\n properties:\n currencies:\n type: array\n description: \"Amounts per currency\"\n items:\n type: object\n properties:\n code:\n type: string\n description: \"Currency code\"\n example: \"EUR\"\n amount:\n type: number\n format: double\n description: \"Amount\"\n example: 123.45\n transports:\n type: integer\n description: \"Number of transports\"\n example: 100\n months:\n type: array\n description: \"Monthly accruals\"\n items:\n type: object\n properties:\n number:\n type: integer\n description: \"Month number\"\n example: 1\n name:\n type: string\n description: \"Month name\"\n example: \"JAN\"\n transports:\n type: integer\n description: \"Number of transports\"\n example: 50\n currencies:\n type: array\n description: \"Amounts per currency\"\n items:\n type: object\n properties:\n code:\n type: string\n description: \"Currency code\"\n example: \"EUR\"\n amount:\n type: number\n format: double\n description: \"Amount\"\n example: 123.45\n carriers:\n type: array\n description: \"Carrier accruals\"\n items:\n type: object\n properties:\n id:\n type: integer\n description: \"Carrier ID\"\n example: 123456\n name:\n type: string\n description: \"Carrier name\"\n example: \"Wonderful Carrier\"\n total:\n type: object\n description: \"Total accruals for carrier\"\n properties:\n currencies:\n type: array\n description: \"Amounts per currency\"\n items:\n type: object\n properties:\n code:\n type: string\n description: \"Currency code\"\n example: \"EUR\"\n amount:\n type: number\n format: double\n description: \"Amount\"\n example: 123.45\n transports:\n type: integer\n description: \"Number of transports\"\n example: 100\n months:\n type: array\n description: \"Monthly accruals for carrier\"\n items:\n type: object\n properties:\n number:\n type: integer\n description: \"Month number\"\n example: 1\n name:\n type: string\n description: \"Month name\"\n example: \"JAN\"\n transports:\n type: integer\n description: \"Number of transports\"\n example: 50\n currencies:\n type: array\n description: \"Amounts per currency\"\n items:\n type: object\n properties:\n code:\n type: string\n description: \"Currency code\"\n example: \"EUR\"\n amount:\n type: number\n format: double\n description: \"Amount\"\n example: 123.45\n settlementOnlyProcess:\n type: object\n description: \"Accruals for settlement only process\"\n properties:\n total:\n type: object\n description: \"Total accruals\"\n properties:\n currencies:\n type: array\n description: \"Amounts per currency\"\n items:\n type: object\n properties:\n code:\n type: string\n description: \"Currency code\"\n example: \"EUR\"\n amount:\n type: number\n format: double\n description: \"Amount\"\n example: 123.45\n transports:\n type: integer\n description: \"Number of transports\"\n example: 100\n months:\n type: array\n description: \"Monthly accruals\"\n items:\n type: object\n properties:\n number:\n type: integer\n description: \"Month number\"\n example: 1\n name:\n type: string\n description: \"Month name\"\n example: \"JAN\"\n transports:\n type: integer\n description: \"Number of transports\"\n example: 50\n currencies:\n type: array\n description: \"Amounts per currency\"\n items:\n type: object\n properties:\n code:\n type: string\n description: \"Currency code\"\n example: \"EUR\"\n amount:\n type: number\n format: double\n description: \"Amount\"\n example: 123.45\n carriers:\n type: array\n description: \"Carrier accruals\"\n items:\n type: object\n properties:\n id:\n type: integer\n description: \"Carrier ID\"\n example: 123456\n name:\n type: string\n description: \"Carrier name\"\n example: \"Wonderful Carrier\"\n total:\n type: object\n description: \"Total accruals for carrier\"\n properties:\n currencies:\n type: array\n description: \"Amounts per currency\"\n items:\n type: object\n properties:\n code:\n type: string\n description: \"Currency code\"\n example: \"EUR\"\n amount:\n type: number\n format: double\n description: \"Amount\"\n example: 123.45\n transports:\n type: integer\n description: \"Number of transports\"\n example: 100\n months:\n type: array\n description: \"Monthly accruals for carrier\"\n items:\n type: object\n properties:\n number:\n type: integer\n description: \"Month number\"\n example: 1\n name:\n type: string\n description: \"Month name\"\n example: \"JAN\"\n transports:\n type: integer\n description: \"Number of transports\"\n example: 50\n currencies:\n type: array\n description: \"Amounts per currency\"\n items:\n type: object\n properties:\n code:\n type: string\n description: \"Currency code\"\n example: \"EUR\"\n amount:\n type: number\n format: double\n description: \"Amount\"\n example: 123.45"}},"macroMetadata":{"macroId":{"value":"8a1f47e3-ba2f-459a-87c3-63fca24f5b6e"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://confluence-open-api.herokuapp.com/images/open-api-icon.png"}}],"title":"Open API (Swagger) Documentation"}},"localId":"f81ed47f-bd05-4762-9c1a-5dfebead2d54"}}],"version":1}

API for Freight Audit SelfService