Create credit note by transaction id
Create a new credit note for a specific transaction.
Authorization
Your secret API key. Include it with every request.
Identifies the organization this request acts on.
Path parameters
Body
Unique identifier for the credit note in the external system.
Date when the credit note was issued or created.
Current state of the credit note in its lifecycle.
PENDINGCANCELLEDCOMMITTEDBrief explanation or reason for issuing the credit note.
Total monetary value of the credit note, including all items and taxes.
Indicates whether this credit note is associated with a marketplace transaction.
Pre-calculated total tax amount for the entire credit note, if provided by the external system.
Pre-calculated overall tax rate for the credit note, if provided by the external system.
Total portion of the credit note amount subject to taxation.
The currency used for all amounts in this credit note.
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTNBWPBYNBZDCADCDFCHFCLPCNYCOPCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGGPGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSIMPINRIQDIRRISKJEPJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSPLSRDSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTVDTWDTZSUAHUGXUSDUYUUZSVEFVNDVUVWSTXAFXCDXDRXOFXPFYERZARZMWZWDA list of TransactionAddressBuilder objects or None if no addresses are provided. This field represents the addresses associated with the transaction.
Detailed list of individual items included in this credit note.
Response
Indicates if transaction requires tax exemption.
Unique identifier of the organization. This field is deprecated, and should no longer be used. The value is populated through the 'x-organization-id' header.
External identifier of the transaction.
Transaction date and time
Transaction date in the shop's local timezone
Timezone of the shop
Description of the transaction.
Status of refund, if applicable
FULLY_REFUNDEDPARTIALLY_REFUNDEDTotal amount of the transaction.
Unique identifier of the customer.
Indicates if transaction is marketplace-based.
Exemption status (e.g., NOT_EXEMPT)
NOT_EXEMPTPARTIALLY_EXEMPTFULLY_EXEMPTZERO_RATE_NOT_EXEMPTList of exemptions applied (if any).
Related transaction identifier.
Secondary External Identifier.
Secondary source information
Friendly identifier of the original item.
Imported tax amount.
Imported tax rate.
Calculated tax amount.
Calculated tax rate.
Total tax liability amount.
Source of tax liability.
CALCULATEDCOLLECTEDTaxable amount.
Currency code (ISO 4217, e.g., USD)
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTNBWPBYNBZDCADCDFCHFCLPCNYCOPCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGGPGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSIMPINRIQDIRRISKJEPJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSPLSRDSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTVDTWDTZSUAHUGXUSDUYUUZSVEFVNDVUVWSTXAFXCDXDRXOFXPFYERZARZMWZWDTransaction lock status.
Source platform (e.g., STRIPE)
BIGCOMMERCEBESTBUYBUNNYCHARGEBEESHOPIFYSTRIPEAMAZONTIKTOKCUSTOMUNKNOWNIMPORTZUORAAPIDECKQUICKBOOKSAPIAPPLE_APP_STOREGOOGLE_APP_STOREWALMARTPAYPALNETSUITEXEROMAXIORECURLYSALESFORCEETSYEBAYWIXSQUARESPACEWOOCOMMERCEMAGENTOBILLING_PLATFORMDEELRIPPLINGGUSTOFACEBOOKOTHERORDWAYINSTAGRAMPINTERESTWAYFAIRWISHPOSTARGETNEWEGGGROUPONGOOGLE_EXPRESSNOCNOCMERCADO_LIBREMODALYSTNORDSTROMFAIRESHOPWAREZOHOSAGE-INTACCTAIRWALLEXORBZENSKARMICROSOFT_DYNAMICS_365KICKSTARTERINTERNAL_ERPConnection Identifier
Filing identifier.
City of the transaction address.
County of the transaction address.
State of the transaction address.
Country code (ISO Alpha-2).
AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCGCDCKCRHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMKMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZWXKZZ_EUPostal code of the transaction.
Tax ID associated with the transaction. DEPRECATED: This field is only populated for QuickBooks integrations and will be removed in a future version.
Transaction status (e.g., COMMITTED)
PENDINGCOMMITTEDCANCELLEDFULLY_REFUNDEDPARTIALLY_REFUNDEDINVALIDARCHIVEDAddress verification status (e.g., VERIFIED).
UNVERIFIEDINVALIDPARTIALLY_VERIFIEDVERIFIEDUNVERIFIABLEBLANKStatus of processing (e.g., ADDRESS_DONE)
NEWUPDATEDQUEUEDADDRESS_DONEEXEMPT_DONENEXUS_DONEPROCESSEDFILING_STARTEDFILING_DONELOCKEDPENDINGARCHIVEDNEEDS_REFETCHEXCLUDED_IN_CALCULATIONDestination currency code (ISO 4217, e.g., USD)
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTNBWPBYNBZDCADCDFCHFCLPCNYCOPCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGGPGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSIMPINRIQDIRRISKJEPJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSPLSRDSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTVDTWDTZSUAHUGXUSDUYUUZSVEFVNDVUVWSTXAFXCDXDRXOFXPFYERZARZMWZWDConverted total amount.
Converted imported tax amount.
Converted calculated tax amount.
Currency conversion rate.
Converted taxable amount.
Converted total discount amount.
Converted subtotal amount.
Converted total tax liability amount.
The unique transaction identifier.
List of addresses associated.
List of items in the transaction.
Customer information associated with the transaction.
The type of transaction (e.g., SALE, REFUND, PARTIAL_CREDIT_NOTE).
SALEFULL_CREDIT_NOTEPARTIAL_CREDIT_NOTETAX_REFUNDARCHIVETotal amount of all discounts applied to the transaction.
Subtotal amount before any discounts are applied.
Final total amount including tax liability.
Converted final total amount including tax liability.
Successful Response
Validation Error