Create transaction by customer id
Create a new transaction for a specific customer.
Authorization
Your secret API key. Include it with every request.
Path parameters
Body
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)
BIGCOMMERCEBESTBUYBUNNYCHARGEBEESHOPIFYSHOPLINEECWIDSTRIPEAMAZONTIKTOKCUSTOMUNKNOWNIMPORTZUORAAPIDECKQUICKBOOKSAPIAPPLE_APP_STOREGOOGLE_APP_STOREWALMARTPAYPALNETSUITEXEROMAXIORECURLYSALESFORCEETSYEBAYWIXSQUARESPACEWOOCOMMERCEMAGENTOMACYSBILLING_PLATFORMDEELRIPPLINGGUSTOFACEBOOKOTHERORDWAYINSTAGRAMPINTERESTWAYFAIRWISHPOSTARGETNEWEGGGROUPONGOOGLE_EXPRESSNOCNOCMERCADO_LIBREMODALYSTNORDSTROMFAIRESHOPWAREZOHOSAGE-INTACCTAIRWALLEXORBZENSKARMICROSOFT_DYNAMICS_365KICKSTARTERINTERNAL_ERPRILLETCAMPFIREKILL_BILLPROVISIONVERTEX_O_SERIESCHECKOUTCHAMPDUALENTRYODOOBILL_COMINTUIT_ENTERPRISE_SUITEACUMATICAPLENTYONEHYPERLINEConnection 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_REFUNDEDINVALIDARCHIVEDDocument type distinguishing invoices from sales orders.
INVOICESALES_ORDERCASH_SALECASH_REFUNDIdentifier of the invoice that created from a sales order.
Address verification status (e.g., VERIFIED).
UNVERIFIEDINVALIDPARTIALLY_VERIFIEDVERIFIEDUNVERIFIABLEBLANKStatus of processing (e.g., ADDRESS_DONE)
NEWUPDATEDQUEUEDADDRESS_DONEEXEMPT_DONENEXUS_DONEPROCESSEDFILING_STARTEDFILING_DONELOCKEDPENDINGARCHIVEDNEEDS_REFETCHEXCLUDED_IN_CALCULATIONDEFERRED_FROM_FILINGDestination 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.
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)
BIGCOMMERCEBESTBUYBUNNYCHARGEBEESHOPIFYSHOPLINEECWIDSTRIPEAMAZONTIKTOKCUSTOMUNKNOWNIMPORTZUORAAPIDECKQUICKBOOKSAPIAPPLE_APP_STOREGOOGLE_APP_STOREWALMARTPAYPALNETSUITEXEROMAXIORECURLYSALESFORCEETSYEBAYWIXSQUARESPACEWOOCOMMERCEMAGENTOMACYSBILLING_PLATFORMDEELRIPPLINGGUSTOFACEBOOKOTHERORDWAYINSTAGRAMPINTERESTWAYFAIRWISHPOSTARGETNEWEGGGROUPONGOOGLE_EXPRESSNOCNOCMERCADO_LIBREMODALYSTNORDSTROMFAIRESHOPWAREZOHOSAGE-INTACCTAIRWALLEXORBZENSKARMICROSOFT_DYNAMICS_365KICKSTARTERINTERNAL_ERPRILLETCAMPFIREKILL_BILLPROVISIONVERTEX_O_SERIESCHECKOUTCHAMPDUALENTRYODOOBILL_COMINTUIT_ENTERPRISE_SUITEACUMATICAPLENTYONEHYPERLINEConnection 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_REFUNDEDINVALIDARCHIVEDDocument type distinguishing invoices from sales orders.
INVOICESALES_ORDERCASH_SALECASH_REFUNDIdentifier of the invoice that created from a sales order.
Address verification status (e.g., VERIFIED).
UNVERIFIEDINVALIDPARTIALLY_VERIFIEDVERIFIEDUNVERIFIABLEBLANKStatus of processing (e.g., ADDRESS_DONE)
NEWUPDATEDQUEUEDADDRESS_DONEEXEMPT_DONENEXUS_DONEPROCESSEDFILING_STARTEDFILING_DONELOCKEDPENDINGARCHIVEDNEEDS_REFETCHEXCLUDED_IN_CALCULATIONDEFERRED_FROM_FILINGDestination 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.
Display name of the store when the organization has multiple stores for a source.
Whether this transaction was deferred (rolled over) from a prior filing period.
SALEPURCHASEList of addresses associated.
List of items in the transaction.
Recoverable input VAT across this transaction's lines, in the transaction's currency. 0.00 for sales and outside the EU and UK.
Recoverable input VAT across this transaction's lines in the destination currency. Null when the transaction is unconverted.
Pro-rata coefficient 0-100 used to scale recoverable input VAT on this purchase. Null for sales and outside the EU and UK. 100 when the organization has no partial exemption rate for the tax-point year.
Customer information associated with the transaction.
The type of transaction (e.g., SALE, REFUND, PARTIAL_CREDIT_NOTE).
SALEFULL_CREDIT_NOTEPARTIAL_CREDIT_NOTETAX_REFUNDTAX_COLLECTIONARCHIVETotal 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