[v2.6] FreightInvoice
Megan Stanage
Overview
This endpoint covers the ability to upload and/or update freight invoices into SCC.
It includes elements that allow it to be related to a transportation tender that exists in the system.
POST /FreightInvoice
Represents the freight invoice request structure.
Gets or sets the transaction DTO.
| Property | Data Type | Notes |
|---|---|---|
| workflowTransactionCode | string | Sets the workflow transaction code for the data to be posted against. |
| referenceNum | string | Sets the reference number for the freight invoice. Note Should match the information on the tender if associated to one. |
| externalReferenceNum | string | Sets the external reference number for the freight invoice. This is usually the carrier's invoice number. Note Should match the information on the tender if associated to one. |
| note | string | Sets the note. |
| reasonCode | string | Sets the reason code. Note This requires that the workflow transaction code used above has been set up to have a reason code as part of the step. |
| transactionType | string | Sets the transaction type associated to the freight invoice. |
| businessTransactionType | string | Gets or sets the business transaction type.
|
Gets or sets the list of business transaction partners.
| Property | Data Type | Notes |
|---|---|---|
| name | string | Name of the trading partner. Note Should match the information on the tender if associated to one. |
| type | String | Gets or sets the trading partner type.
Note There are other possible values here, but for an invoice, this is the only appropriate value. |
| isPrimary | boolean | Sets the value indicating whether the business transaction partner is primary. Note Should always be set to true |
Gets or sets the freight invoice DTO.
| Property | Data Type | Notes |
|---|---|---|
| carrierName | string | Sets the name of the carrier submitting the invoice. Note Should match the information on the tender if associated to one. |
| carrierServiceName | string | Sets the carrier service name used. Note Should match the information on the tender if associated to one. |
| transportationTenderReferenceNumber | string | Sets the reference number for the transportation tender that the freight invoice is associated with. |
| stopNumber | integer | Sets the stop number.
Note Only used in instances where the freight invoice is of the Stop cost type. |
| costType | String | Sets the cost type for the freight invoice. Possible values:
Note Must match the cost type value of the transportation tender associated above. |
| carrierInvoiceNumber | string | Sets the carrier invoice number. |
| load | string | Sets the load number. Note Should match the information on the tender if associated to one. |
| invoiceDate | string | Sets the invoice date.
|
| currencyCode | enum | Sets the currency code. USD, CAD, AUD, GBP, EUR, DKK, SEK, NOK, CZK, CHF, HUF, PLN, MXN, PHP, SAR, JPY, AFN, ALL, DZD, AOA, XCD, ARS, AMD, AWG, AZN, BSD, BHD, BDT, BBD, BYN, BZD, XOF, BMD, INR, BTN, BOB, BOV, BAM, BWP, BRL, BND, BGN, BIF, CVE, KHR, XAF, KYD, CLP, CLF, CNY, COP, COU, KMF, CDF, NZD, CRC, CUP, CUC, ANG, DJF, DOP, EGP, SVC, ERN, SZL, ETB, FKP, FJD, XPF, GMD, GEL, GHS, GIP, GTQ, GNF, GYD, HTG, HNL, HKD, ISK, IDR, XDR, IRR, IQD, ILS, JMD, JOD, KZT, KES, KPW, KRW, KWD, KGS, LAK, LBP, LSL, ZAR, LRD, LYD, MOP, MKD, MGA, MWK, MYR, MVR, MRU, MUR, XUA, MXV, MDL, MNT, MAD, MZN, MMK, NAD, NPR, NIO, NGN, OMR, PKR, PAB, PGK, PYG, PEN, QAR, RON, RUB, RWF, SHP, WST, STN, RSD, SCR, SLL, SLE, SGD, XSU, SBD, SOS, SSP, LKR, SDG, SRD, CHE, CHW, SYP, TWD, TJS, TZS, THB, TOP, TTD, TND, TRY, TMT, UGX, UAH, AED, USN, UYU, UYI, UYW, UZS, VUV, VES, VED, VND, YER, ZMW, ZWL, XBA, XBB, XBC, XBD, XTS, XXX, XAU, XPD, XPT, XAG |
If there are any defined for the freight invoice you can pass the information here.
| Property | Data Type | Notes |
|---|---|---|
| attributeName | string | Gets or sets the attribute name. |
| attributeDescription | string | Gets or sets the attribute description. |
| value | string | Gets or sets the system attribute value. |
Sets the lines of the freight invoice.
| Property | Data Type | Notes |
|---|---|---|
| lineNumber | integer | Sets the line number.
|
| freightItem | string | Sets the name of the freight item. Note Must match a freight invoice set up in the system AND must be assigned to the carrier referenced above. |
| amount | integer | Sets the amount.
|
| Property | Data Type | Notes |
|---|---|---|
| businessTransactionReferenceNum | string | |
| businessTransactionStatus | string |