creditEntryCreate
Record carrier recovery on a claim credit; a zero amount only attaches the carrier charge as evidence.
Arguments
creditIdID!currencyString!ISO 4217 currency code
valueString!Amount
carrierInvoiceLineChargeIdIDThe carrier charge the amount is recovered from; required for a zero amount.
referenceString!Returns
currencyString!ISO 4217 currency code
valueString!Amount
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.
ledgerLedgerLedger of the carrier charge mapping.
priceAmountMoneyFixed amount used by fixed pricing or a fixed addition.
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.
schemaCarrierInvoiceSchema!Schema of the carrier charge mapping.
updatedAtDateTimeTz!When the carrier charge mapping was last updated.
vatProfileVatProfileVAT profile of the carrier charge mapping.
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.
createdAtDateTimeTz!applicationBlockingReasonStringapprovalStatusCreditApprovalStatus!APPROVEDPROPOSEDREJECTEDREVERTEDcurrencyString!ISO 4217 currency code
valueString!Amount
A list of CarrierInvoiceLineCharge edges.
pageInfoPageInfo!Pagination information about the list of edges.
carrierCodeStringcurrencyString!ISO 4217 currency code
valueString!Amount
currencyString!ISO 4217 currency code
valueString!Amount
currencyString!ISO 4217 currency code
valueString!Amount
currencyString!ISO 4217 currency code
valueString!Amount
currencyString!ISO 4217 currency code
valueString!Amount
createdAtDateTimeTz!edges[CreditEntryEdge!]!A list of CreditEntry edges.
pageInfoPageInfo!Pagination information about the list of edges.
edges[EventEdge!]!A list of Event edges.
pageInfoPageInfo!Pagination information about the list of edges.
idID!edges[InvoiceEdge!]!A list of Invoice edges.
pageInfoPageInfo!Pagination information about the list of edges.
edges[CreditLineEdge!]!A list of CreditLine edges.
pageInfoPageInfo!Pagination information about the list of edges.
appliedPrices[AppliedPrice!]!Prices billing applies to this client on a date for the rules and tiers of a fulfillment service and/or the bases and options of a shipping product.
billingChargesBillingChargeConnection!Billing charges prepared for this client.
contactsClientContactConnection!Contacts for this tenant–client relationship. Contact roles do not grant application access.
features[OrganizationFeature!]!The features associated with this client.
DEMOSUPPORT_AUTOMATIONSUPPORT_TICKETSfulfillmentServicesFulfillmentServiceConnection!List fulfillment services provided by tenant
fulfillmentsInvoiceLineBillableFulfillmentConnection!Shipped fulfillments of the client in a warehouse of the tenant.
goodsReceiptsInvoiceLineBillableGoodsReceiptConnection!Completed goods receipts of the client in a warehouse of the tenant.
idID!Unique primary key.
invoiceContactsInvoiceContactConnection!Invoice contacts of the client.
invoicesInvoiceConnection!Invoices issued for this client.
nameString!Name of the client
Orders of the client.
priceListsPriceListConnection!Price lists attached to this client
returnReceiptsInvoiceLineBillableReturnReceiptConnection!Completed return receipts of the client in a warehouse of the tenant.
Shipped shipments of the client, to find the resource a support ticket is about.
shippingProductsTenantShippingProductConnection!List shipping products provided by tenant
usersUserConnection!Users with active access to the client organization.
warehousesWarehouseConnection!List warehouses provided by tenant
reasonString!subjectInvoiceLineBillableThe shipment, fulfilment, goods receipt or return receipt the credit is about.
typeCreditType!CLAIMCOMPENSATIONCORRECTIONDISCOUNTidID!kindCreditEntryKind!EVIDENCESETTLEMENTreferenceString!field[String!]messageString!