h bddlmZddlmZddlmZddlmZddlm Z ddl m Z ddl m Z ddlmZdd lmZmZdd lmZmZmZmZmZmZdd lmZmZmZmZmZer6dd l m!Z!dd l"m#Z#ddl$m%Z%ddl&m'Z'ddl(m)Z)ddl*m+Z,ddl-m.Z.ddl/m0Z0ddl1m2Z2e dGddedededZ3y))CreateableAPIResource)ExpandableField) ListObject)ListableAPIResource)nested_resource_class_methods)RequestOptions) StripeObject)UpdateableAPIResource)class_method_variant sanitize_id)ClassVarDictListOptionalcastoverload)Literal NotRequired TypedDictUnpack TYPE_CHECKING)CreditNoteLineItem)Customer)CustomerBalanceTransaction)Discount)Invoice)Refund) ShippingRate)TaxRate)CreditBalanceTransactionlineceZdZUdZdZeeded<GddeZ GddeZ Gdd eZ Gd d eZ Gd d eZ GddeZGddeZGddeZGddeZGddeZGddeZGddeZGddeZGddeZGd d!eZGd"d#eZGd$d%eZGd&d'eZGd(d)eZGd*d+eZGd,d-eZGd.d/eZ Gd0d1eZ!Gd2d3eZ"Gd4d5eZ#Gd6d7eZ$e%ed8< e%ed9< e%ed:< e&ed;< e'd<ed=< e(e'd>ed?< e%ed@< e)e edA< e(e%edB< e&edC< e'dDedE< e*dFedG< e+edH< e(e&edI< e(e,e&e&fedJ< e&edK< ededL< e(e%edM< e&edN< e)e edO< e(edPedQ< e)e edR< e(e edS< edTedU< e%edV< e(e%edW< e%edX< e(e%edY< e(e)e edZ< ed[ed\< e(e%ed]< e-d^e.d_d`dfdaZ/e-d^e.d_d`dfdbZ0e-d^e.dcd`e*dfddZ1e-d^e.dcd`e*dfdeZ2e-dCe&d^e.dfd`dfdgZ3e-dCe&d^e.dfd`dfdhZ4e-d^e.did`dfdjZ5e-d^e.did`dfdkZ6e-d^e.dld`e*dFfdmZ7e-d^e.dld`e*dFfdnZ8e-dCe&d^e.dod`dfdpZ9e-dCe&d^e.dod`dfdqZ:e-dCe&d^e.drd`dfdsZ;eee?dvd^e.drd`dfdwZ>e-dCe&d^e.drd`dfdxZ@e?? r1r8c*eZdZUeed< eded<y)CreditNote.Refundamount_refundedRefundResourcerefundNr*r0r1r2rr:Os   011 r1rceZdZUGddeZeed< eed< eed< eeded< ee eed< deiZ y ) CreditNote.ShippingCostcNeZdZUeed< ded< eeded< eeed<y)CreditNote.ShippingCost.Taxr(rrate)customer_exemptnot_collectingnot_subject_to_tax not_supportedportion_product_exemptportion_reduced_ratedportion_standard_ratedproduct_exemptproduct_exempt_holidayproportionally_rated reduced_ratedreverse_chargestandard_ratedtaxable_basis_reduced zero_ratedtaxability_reasontaxable_amountN)r+r,r-r.r/rrr0r1r2TaxrAZsJK O  ("  & %SM ) r1rTamount_subtotal amount_tax amount_totalr shipping_ratetaxesN) r+r,r-r rTr.r/rrr_inner_class_typesr0r1r2 ShippingCostr?Ysn$ ,$ L     ?@@ S "" &s^r1r[ceZdZUGddeZeed< eded< eeed< eded< eeed < eded < deiZ y ) CreditNote.TotalTaxceZdZUeed<y)"CreditNote.TotalTax.TaxRateDetailstax_rateN)r+r,r-strr/r0r1r2TaxRateDetailsr_sMr1rbr() exclusive inclusive tax_behaviortax_rate_details)rC not_availablerDrErFrGrHrIrJrKrLrMrNrOrPrQrRrSr7N) r+r,r-r rbr.r/rrrZr0r1r2TotalTaxr]s \   677 #>22 #   $ ! % ()) 1.Ar1rhc*eZdZUeeed< eeed< eeed< eeded< eeeed< eed< eeded < eeed < ee eefed < eeed < eed ed< eeed< eeded< eded<y)CreditNote.CreateParamsr( credit_amount effective_atr$none email_typeexpandinvoiceCreditNote.CreateParamsLinelinesmemometadataout_of_band_amount duplicate fraudulent order_changeproduct_unsatisfactoryreason refund_amountCreditNote.CreateParamsRefundrefunds#CreditNote.CreateParamsShippingCost shipping_costN r+r,r-rr.r/rrrarr0r1r2 CreateParamsrjs$C   #3'' "#&&  (= >?? DI&&   4 =>?? # d38n-- (,,  *    #3'' T"ABCC ##HII r1rceZdZUeeed< eeed< eeed< eeed< eded< eded< ed ed < eeed < eeed <y )rrr( descriptioninvoice_line_itemquantityz6Literal['']|List[CreditNote.CreateParamsLineTaxAmount] tax_amountsLiteral['']|List[str] tax_ratescustom_line_itemrr7 unit_amountunit_amount_decimalNr+r,r-rr.r/rarr0r1r2CreateParamsLinezCreditNote.CreateParamsLinesC   !%% 's++ c"" ! D   677 =>> !%% )-- r1rc0eZdZUeed< eed< eed<y)$CreditNote.CreateParamsLineTaxAmountr(r`rSNr+r,r-r.r/rar0r1r2CreateParamsLineTaxAmountr.%     r1rc0eZdZUeeed< eeed<y)r~r;r=Nr+r,r-rr.r/rar0r1r2CreateParamsRefundzCreditNote.CreateParamsRefund<$$S)) C   r1rceZdZUeeed<y)rrXNr+r,r-rrar/r0r1r2CreateParamsShippingCostz#CreditNote.CreateParamsShippingCostF"3'' r1rcZeZdZUeeed< eeeed< eeed< eeed<y)CreditNote.ListLinesParams ending_beforerplimitstarting_afterN)r+r,r-rrar/rr.r0r1r2ListLinesParamsrLsL"3'' DI&& 3 $C(( r1rceZdZUeded< eeed< eeed< eeeed< eeed< eeed< eeed<y ) CreditNote.ListParamsz CreditNote.ListParamsCreated|intcreatedcustomerrrprqrrN)r+r,r-rr/rarr.r0r1r2 ListParamsr^s?@@ c"" #3'' DI&& S!! 3 $C(( r1rcTeZdZUeeed< eeed< eeed< eeed<y)CreditNote.ListParamsCreatedgtgteltlteN)r+r,r-rr.r/r0r1r2ListParamsCreatedr|sH          r1rcReZdZUeeeed< eeed< eeeefed<y)CreditNote.ModifyParamsrprtruN)r+r,r-rrrar/rr0r1r2 ModifyParamsrsBDI&& # d38n-- r1rc`eZdZUeeed< eeed< eeed< eeded< eeed< eeeed< eed< eeed < eed ed < eeed < ee eefed < eeed< eeded< eeed< eeded< eded< eeed<y)CreditNote.PreviewLinesParamsr(rkrlrmrorrprqr!CreditNote.PreviewLinesParamsLinersrtrurvrwr|r}#CreditNote.PreviewLinesParamsRefundr)CreditNote.PreviewLinesParamsShippingCostrrN) r+r,r-rr.r/rrarrr0r1r2PreviewLinesParamsrsZC   #3'' "#&&  (= >?? #3'' DI&&   3 4 CDEE # d38n-- (,,  *    #3'' T"GHII ##NOO $C(( r1rceZdZUeeed< eeed< eeed< eeed< eded< eded< ed ed < eeed < eeed <y )rr(rrrz> !%% )-- r1rc0eZdZUeed< eed< eed<y)*CreditNote.PreviewLinesParamsLineTaxAmountr(r`rSNrr0r1r2PreviewLinesParamsLineTaxAmountrrr1rc0eZdZUeeed< eeed<y)rr;r=Nrr0r1r2PreviewLinesParamsRefundz#CreditNote.PreviewLinesParamsRefundrr1rceZdZUeeed<y)rrXNrr0r1r2PreviewLinesParamsShippingCostz)CreditNote.PreviewLinesParamsShippingCost)rr1rc*eZdZUeeed< eeed< eeed< eeded< eeeed< eed< eeded < eeed < ee eefed < eeed < eed ed< eeed< eeded< eded<y)CreditNote.PreviewParamsr(rkrlrmrorprqCreditNote.PreviewParamsLinersrtrurvrwr|r}CreditNote.PreviewParamsRefundr$CreditNote.PreviewParamsShippingCostrNrr0r1r2 PreviewParamsr/s$C   #3'' "#&&  (= >?? DI&&   4 >?@@ # d38n-- (,,  *    #3'' T"BCDD ##IJJ r1rceZdZUeeed< eeed< eeed< eeed< eded< eded< ed ed < eeed < eeed <y )rr(rrrz7Literal['']|List[CreditNote.PreviewParamsLineTaxAmount]rrrrr7rrNrr0r1r2PreviewParamsLinezCreditNote.PreviewParamsLinepsC   !%% 's++ c"" ! E   677 =>> !%% )-- r1rc0eZdZUeed< eed< eed<y)%CreditNote.PreviewParamsLineTaxAmountr(r`rSNrr0r1r2PreviewParamsLineTaxAmountrrr1rc0eZdZUeeed< eeed<y)rr;r=Nrr0r1r2PreviewParamsRefundzCreditNote.PreviewParamsRefundrr1rceZdZUeeed<y)rrXNrr0r1r2PreviewParamsShippingCostz$CreditNote.PreviewParamsShippingCostrr1rc$eZdZUeeeed<y)CreditNote.RetrieveParamsrpNr+r,r-rrrar/r0r1r2RetrieveParamsrDI&& r1rc$eZdZUeeeed<y)CreditNote.VoidCreditNoteParamsrpNrr0r1r2VoidCreditNoteParamsrrr1rr(amount_shippingrcurrencyrrrcustomer_balance_transactiondiscount_amountdiscount_amountsrlidrrqrrslivemodertrunumberobjectrvpdfpretax_credit_amountsrwr|rr)issuedvoidstatussubtotalsubtotal_excluding_taxtotaltotal_excluding_tax total_taxes) post_payment pre_paymentr7 voided_atparamsrjreturnc Ztd|jd|j|S)+ Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result in any combination of the following: Refund: create a new refund (using refund_amount) or link an existing refund (using refund). Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized. Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount). For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total. You may issue multiple credit notes for an invoice. Each credit note will increment the invoice's pre_payment_credit_notes_amount or post_payment_credit_notes_amount depending on its status at the time of credit note creation. r#postr)r_static_request class_urlclsrs r2createzCreditNote.createEs6(         r1cvKtd|jd|j|d{S7w)rr#rrN)r_static_request_asyncrrs r2 create_asynczCreditNote.create_asyncbsD( ++ ,    s ,97 9rc |jd|j|}t|ts!t dt |j z|S)1 Returns a list of credit notes. getr%Expected list object from API, got %s)rr isinstancer TypeErrorr7r+rrresults r2listzCreditNote.lists]$$  MMO%  &*-7<((*   r1cK|jd|j|d{}t|ts!t dt |j z|S77w)rrrNr)rrrrrr7r+rs r2 list_asynczCreditNote.list_asyncsk00  MMO1   &*-7<((*    s&A"A 8A"rc z|jdt|}td|jd||S)2 Updates an existing credit note. /r#rr)rr rrrrrurls r2modifyzCreditNote.modifysD+b/:        r1cK|jdt|}td|jd||d{S7w)r r r#rrN)rr rrr s r2 modify_asynczCreditNote.modify_asyncsR+b/: ++,    std|jdd|S)E Get a preview of a credit note without creating it. r#r/v1/credit_notes/previewr)rrrs r2previewzCreditNote.previews0    *    r1cZKtd|jdd|d{S7w)rr#rrrN)rrrs r2 preview_asynczCreditNote.preview_asyncs> ++*,    s +) +rc Lttd|jdd|S) When retrieving a credit note preview, you'll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items. rr/v1/credit_notes/preview/linesr)rrrrs r2 preview_lineszCreditNote.preview_liness6 + ,   0    r1chKttd|jdd|d{S7w)rrrrrN)rrrrs r2preview_lines_asynczCreditNote.preview_lines_asyncsD + ,++0,    s %20 2rc 8||fi|}|j|S)M Retrieves the credit note object with the given identifier. )refreshrrrinstances r2retrievezCreditNote.retrieve s$r$V$r1cTK||fi|}|jd{|S7w)rN) refresh_asyncrs r2retrieve_asynczCreditNote.retrieve_asyncs3r$V$$$&&& 's (&(rc ptd|jddjt||S) Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). r#r/v1/credit_notes/{id}/voidrr)rrformatr rrrs r2_cls_void_credit_notez CreditNote._cls_void_credit_notesB    ,33{23G    r1c yr&Nr0rrs r2void_credit_notezCreditNote.void_credit_note/s r1c yr-r0selfrs r2r/zCreditNote.void_credit_note9s r1r+c td|jddjt|j d|S)r&r#rr'rr(r)r_requestr)r rr1s r2r/zCreditNote.void_credit_noteBsP  MM,33"488D>24    r1c Ktd|jddjt||d{S7w)r&r#rr'r(rN)rrr)r r*s r2_cls_void_credit_note_asyncz&CreditNote._cls_void_credit_note_asyncTsP ++,33{23G,    s7AA Ac Kywr-r0r.s r2void_credit_note_asyncz!CreditNote.void_credit_note_asyncds  c Kywr-r0r1s r2r8z!CreditNote.void_credit_note_asyncns  r9r6c Ktd|jddjt|j d|d{S7w)r&r#rr'rr(rN)r_request_asyncr)r rr1s r2r8z!CreditNote.void_credit_note_asyncws` %%,33"488D>24 &    sAAA Arc ~ttd|jddjt ||S) When retrieving a credit note, you'll get a lines property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items. rr$/v1/credit_notes/{credit_note}/linesr$r)rrrr)r rr$rs r2 list_lineszCreditNote.list_linessP + ,   6== +K 8>    r1c Kttd|jddjt ||d{S7w)r>rrr?r@rN)rrrr)r rAs r2list_lines_asynczCreditNote.list_lines_asyncs^ + ,++6== +K 8> ,    s>A A  A )rrrrrN)Er+r,r-__doc__r%r rr/r r3r8rr[rhrrrrrrrrrrrrrrrrrrrrrrrr.rarrrrboolr classmethodrrrrrr rrrrrr!r$r+r staticmethodr/r r6r8rBrDrZr0r1r2r#r##s  5BK'-01A   \ (  ;,|;,z-B<-B^? ~? B& 9& P  I   Y  9  . $ ^ < I $  ~  K ^K Z& & P  )   9   ? ? B& I& P  Y   i  I    ~ KLMj))#+45#>**3- GY '' * ++N 3-tCH~&& K M ""! % H 233  O   &\L)) $ %%M%SM) J"#&$x.)) / 00} 78   8 78   856 L !&56 L !&  &'@ A     &'@ A     89        89        =>  ( )      =>  ( )     &'B C  &'B C     &'H I        !"CD    @A   12 @A  3 "    &'H I        !"CD    @A   78 @A  9 "  )/0L)M ( )  "  )/0L)M ( )  $+!3% r1r#N)4stripe._createable_api_resourcerstripe._expandable_fieldrstripe._list_objectrstripe._listable_api_resourcer%stripe._nested_resource_class_methodsrstripe._request_optionsrstripe._stripe_objectr stripe._updateable_api_resourcer stripe._utilr r typingr rrrrrtyping_extensionsrrrrrstripe._credit_note_line_itemrstripe._customerr$stripe._customer_balance_transactionrstripe._discountrstripe._invoicerstripe._refundrr<stripe._shipping_raterstripe._tax_rater*stripe.billing._credit_balance_transactionr r#r0r1r2r]sB4*=O2.A:AA@)O)'72( v&O,' %,'O'Or1