CarrierInvoiceLineCharge
Fields
billedAtDateTimeTzWhen the carrier invoice line charge was billed.
billingStatusCarrierInvoiceChargeBillingStatus!Billing status of the carrier invoice line charge.
BILLEDNOT_BILLABLEPENDING_DRAFTREVIEW_REQUIREDcategoryCarrierInvoiceChargeCategory!Category of the carrier invoice line charge.
BASEDISCOUNTFEEFUEL_SURCHARGEOPTIONSURCHARGETAXchargeGroupKeyString!Charge group key of the carrier invoice line charge.
currencyString!ISO 4217 currency code
valueString!Amount
createdAtDateTimeTz!When the carrier invoice line charge was created.
externalCodeStringExternal code of the carrier invoice line charge.
externalNameStringExternal name of the carrier invoice line charge.
idID!Unique primary key.
invoiceDescriptionStringInvoice description of the carrier invoice line charge.
invoiceLineAggregationModeCarrierInvoiceLineAggregationMode!Invoice line aggregation mode of the carrier invoice line charge.
AVERAGE_AMOUNTGROUP_BY_AMOUNTTOTAL_AMOUNTapplyShipmentFuelSurchargeBoolean!Whether the matched shipment fuel surcharge is applied after pricing.
categoryCarrierInvoiceChargeCategory!Category of the carrier charge mapping.
BASEDISCOUNTFEEFUEL_SURCHARGEOPTIONSURCHARGETAXcreatedAtDateTimeTz!When the carrier charge mapping was created.
externalCodeStringExternal code of the carrier charge mapping.
externalNamePatternStringExternal name pattern of the carrier charge mapping.
idID!Unique primary key.
invoiceDescriptionStringInvoice description of the carrier charge mapping.
invoiceLineAggregationModeCarrierInvoiceLineAggregationMode!Invoice line aggregation mode of the carrier charge mapping.
AVERAGE_AMOUNTGROUP_BY_AMOUNTTOTAL_AMOUNTisActiveBoolean!Whether this carrier charge mapping is active.
codeStringCode of the ledger.
createdAtDateTimeTz!When the ledger was created.
idID!Unique primary key.
integrationReferenceString!Integration reference of the ledger.
isActiveBoolean!Whether this ledger is active.
nameString!Name of the ledger.
syncedAtDateTimeTzWhen the ledger was last synchronized.
updatedAtDateTimeTz!When the ledger was last updated.
currencyString!ISO 4217 currency code
valueString!Amount
priceBasisCarrierChargePriceBasisSource amount used to price the mapped charge.
CARRIER_COSTFIXED_AMOUNTSHIPPING_PRODUCT_BASESpriceOperatorCarrierChargePriceOperatorOptional operation applied to the source amount.
ADD_FIXEDADD_PERCENTAGEPERCENTAGE_OF_BASISpricePercentageStringPercentage used by percentage operators.
carrierCodeStringCarrier code of the carrier invoice schema.
chargeMappingsCarrierChargeMappingConnection!The charge mappings associated with this carrier invoice schema.
createdAtDateTimeTz!When the carrier invoice schema was created.
headerRowInt!Header row of the carrier invoice schema.
idID!Unique primary key.
isActiveBoolean!Whether this carrier invoice schema is active.
nameString!Name of the carrier invoice schema.
schemaMixed!Schema of the carrier invoice schema.
sheetNameStringSheet name of the carrier invoice schema.
updatedAtDateTimeTz!When the carrier invoice schema was last updated.
updatedAtDateTimeTz!When the carrier charge mapping was last updated.
businessUnitBusinessUnitBusiness unit of the VAT profile.
createdAtDateTimeTz!When the VAT profile was created.
descriptionStringDescription of the VAT profile.
idID!Unique primary key.
nameString!Name of the VAT profile.
The rules associated with this VAT profile.
updatedAtDateTimeTz!When the VAT profile was last updated.
reviewReasonStringWhy the charge needs review, in the request language.
currencyString!ISO 4217 currency code
valueString!Amount
currencyString!ISO 4217 currency code
valueString!Amount
sequenceInt!Sequence of the carrier invoice line charge.
updatedAtDateTimeTz!When the carrier invoice line charge was last updated.