credit
Arguments
idID!Returns
applicationBlockingReasonStringapprovalStatusCreditApprovalStatus!APPROVEDPROPOSEDREJECTEDREVERTEDcurrencyString!ISO 4217 currency code
valueString!Amount
cursorString!A unique cursor that can be used for pagination.
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.
costAmountMoney!Cost amount of the carrier invoice line charge.
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_AMOUNTmappingCarrierChargeMappingMapping of the carrier invoice line charge.
reviewReasonStringWhy the charge needs review, in the request language.
sellAmountMoneySell amount of the carrier invoice line charge.
sellAmountOverrideMoneyManual sell amount override applied after mapping pricing.
sequenceInt!Sequence of the carrier invoice line charge.
updatedAtDateTimeTz!When the carrier invoice line charge was last updated.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
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!cursorString!A unique cursor that can be used for pagination.
amountMoney!carrierInvoiceLineChargeCarrierInvoiceLineChargecreatedAtDateTimeTz!creditCredit!idID!kindCreditEntryKind!EVIDENCESETTLEMENTreferenceString!endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
codeEventCodeEvent code
credit_approvedcredit_bookedcredit_charge_associatedcredit_recovery_recordedcredit_rejectedcredit_requestedcredit_revertedfulfillment_internal_label_generatedfulfillment_pickedfulfillment_pickingfulfillment_picklist_createdfulfillment_picklist_deletedfulfillment_shippedintegration_synchronization_failedintegration_updatedorder_address_corrected_consumerorder_address_incorrect_notificationorder_canceledorder_createdorder_exception_ignoredorder_holdorder_hold_releaseorder_shippedproduct_updatedpurchase_order_createdpurchase_order_status_orderedreturn_receipt_completedreturn_refund_deletedreturn_refund_errorreturn_refund_status_completedreturn_refund_status_createdreturn_refund_status_requestedreturn_request_createdreturn_request_status_acceptedreturn_request_status_canceledreturn_request_status_completedreturn_request_status_pendingreturn_request_status_rejectedshipment_canceledshipment_createdshipment_errorshipment_generatedshipment_readyshipment_requestedshipment_warehouse_departedshipment_warehouse_sortedsupport_automation_award_confirmedsupport_automation_case_reopenedsupport_automation_case_resolvedsupport_automation_claim_reference_registeredsupport_automation_claim_submittedsupport_automation_evidence_reviewedsupport_automation_handoversupport_automation_message_draftedsupport_automation_message_sentsupport_automation_pausedsupport_automation_resumedsupport_automation_shipment_linkedsupport_message_delivery_stoppedcreatedAtDateTimeTz!When the event was created
createdByEventCreatorWho created this event
idID!Unique primary key
messageStringEvent message, in the language of the request
occurredAtDateTimeTz!When the event occurred
updatedAtDateTimeTz!When the event was last updated
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
idID!cursorString!A unique cursor that can be used for pagination.
businessUnitBusinessUnitBusiness unit that issues the invoice.
createdAtDateTimeTz!When the invoice was created.
dueAtDateDue at
idID!Unique primary key.
issueCountInt!Blocked charges of this client and business unit whose billing period overlaps the invoice period; they are missing from the invoice until resolved.
The lines associated with this invoice.
numberStringInvoice number
organizationClient!Organization for which the invoice is issued.
periodEndAtDateLast day of the billing period this invoice covers.
periodStartAtDateFirst day of the billing period this invoice covers.
referenceStringOrder / invoice reference
sendingInvoiceSending!Sending of the invoice: whether it can be sent, when it is sent automatically and the progress of a dispatch.
sentAtDateSent at
totalAmountMoneyTotal amount excluding VAT.
totalAmountInclVatMoneyTotal amount including VAT.
updatedAtDateTimeTz!When the invoice was last updated.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
amountMoney!billingChargeBillingChargeThe charge this line credits, when it credits a charge.
descriptionStringidID!endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
amountMoney!Amount of the price.
contextableIdIDThe contextable ID
createdAtDateTimeTz!When the price was created.
idID!Unique primary key.
priceableIdID!The priceable ID
priceableTypePriceableType!The priceable type
FULFILLMENT_SERVICE_RULEFULFILLMENT_SERVICE_RULE_TIERSHIPPING_PRODUCT_BASESHIPPING_PRODUCT_OPTIONupdatedAtDateTimeTz!When the price was last updated.
validFromDate!The date from which the price is valid
validToDateThe date until which the price is valid
hasCurrencyConflictBoolean!Whether the client's price lists price the item in different currencies, so no price list price applies.
amountMoney!Amount of the price.
contextableIdIDThe contextable ID
createdAtDateTimeTz!When the price was created.
idID!Unique primary key.
priceableIdID!The priceable ID
priceableTypePriceableType!The priceable type
FULFILLMENT_SERVICE_RULEFULFILLMENT_SERVICE_RULE_TIERSHIPPING_PRODUCT_BASESHIPPING_PRODUCT_OPTIONupdatedAtDateTimeTz!When the price was last updated.
validFromDate!The date from which the price is valid
validToDateThe date until which the price is valid
createdAtDateTimeTz!When the price list was created.
fulfillmentServicesFulfillmentServiceConnection!Fulfillment services associated with this price list
idID!Unique primary key.
nameString!Name of the price list
shippingProductsTenantShippingProductConnection!Shipping products associated with this price list
updatedAtDateTimeTz!When the price list was last updated.
priceableIdID!ID of the priced item.
priceableTypePriceableType!Type of the priced item.
FULFILLMENT_SERVICE_RULEFULFILLMENT_SERVICE_RULE_TIERSHIPPING_PRODUCT_BASESHIPPING_PRODUCT_OPTIONcursorString!A unique cursor that can be used for pagination.
nodeBillingCharge!The BillingCharge node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
nodeClientContact!The ClientContact node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
features[OrganizationFeature!]!The features associated with this client.
DEMOSUPPORT_AUTOMATIONSUPPORT_TICKETScursorString!A unique cursor that can be used for pagination.
The FulfillmentService node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
The InvoiceLineBillableFulfillment node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
The InvoiceLineBillableGoodsReceipt node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
idID!Unique primary key.
cursorString!A unique cursor that can be used for pagination.
nodeInvoiceContact!The InvoiceContact node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
nodeInvoice!The Invoice node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
nameString!Name of the client
cursorString!A unique cursor that can be used for pagination.
The InvoiceLineBillableOrder node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
nodePriceList!The PriceList node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
The InvoiceLineBillableReturnReceipt node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
The InvoiceLineBillableShipment node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
The TenantShippingProduct node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
nodeUser!The User node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
nodeWarehouse!The Warehouse node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
reasonString!subjectInvoiceLineBillableThe shipment, fulfilment, goods receipt or return receipt the credit is about.
typeCreditType!CLAIMCOMPENSATIONCORRECTIONDISCOUNT