o if@sddlmZddlmZddlmZddlmZddlm Z ddl m Z ddl m Z ddlmZmZdd lmZmZmZmZmZmZdd lmZmZmZerdd lmZdd lmZdd l m!Z!ddl"m#Z#ddl$m%Z%ddl&m'Z(ddl)m*Z*ddl+m,Z,ddl-m.Z.ddl/m0Z0ddl1m2Z2ddl3m4Z4ddl5m6Z6ddl7m8Z8ddl9m:Z:ddl;mZ>e dGdddedede dZ?dS) )CreateableAPIResource)ExpandableField) ListObject)ListableAPIResource)nested_resource_class_methods) StripeObject)UpdateableAPIResource)class_method_variant sanitize_id)ClassVarDictListOptionalcastoverload)LiteralUnpack TYPE_CHECKING)CreditNoteLineItem)Customer)CustomerBalanceTransaction)Discount)Invoice)Refund) ShippingRate)TaxRate)CreditBalanceTransaction)CreditNoteCreateParams)CreditNoteListLinesParams)CreditNoteListParams)CreditNoteModifyParams)CreditNotePreviewLinesParams)CreditNotePreviewParams)CreditNoteRetrieveParams)CreditNoteVoidCreditNoteParamslinec@seZdZUdZdZeeded<GdddeZ GdddeZ Gdd d eZ Gd d d eZ Gd d d eZ eed< eed< eed< eed< eded< eeded< eed< ee ed< eeed< eed< eded< eded< eed< eeed< eeeefed < eed!< eded"< eeed#< eed$< eed%< eed&< ee ed'< eed(ed)< ee ed*< ee ed+< ed,ed-< eed.< eeed/< eed0< eeed1< eee ed2< ed3ed4< eeed5< ed6ed7d8dfd9d:Zed6ed7d8dfd;d<Zed6ed=d8edfd>d?Zed6ed=d8edfd@dAZeded6edBd8dfdCdDZeded6edBd8dfdEdFZed6edGd8dfdHdIZed6edGd8dfdJdKZed6edLd8edfdMdNZ ed6edLd8edfdOdPZ!eded6edQd8dfdRdSZ"eded6edQd8dfdTdUZ#eded6edVd8dfdWdXZ$e%e&ded6edVd8dfdYdZZ'e%d6edVd8dfd[dZZ'e(d\d6edVd8dfd]dZZ'eded6edVd8dfd^d_Z)e%e&ded6edVd8dfd`daZ*e%d6edVd8dfdbdaZ*e(dcd6edVd8dfdddaZ*eded6eded8edfdfdgZ+eded6eded8edfdhdiZ,e e e e e djZ-dkS)l CreditNotez Issue a credit note to adjust an invoice's amount after the invoice is finalized. Related guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes) credit_note OBJECT_NAMEc@s$eZdZUeed< eded<dS)zCreditNote.DiscountAmountamountrdiscountN)__name__ __module__ __qualname__int__annotations__rr0r0s/var/www/snowflake_co_dev_github/snow_flake_back_end_deploy/env/lib/python3.10/site-packages/stripe/_credit_note.pyDiscountAmount<s  r2c@sHeZdZUeed< eeded< eeded< eded<dS) zCreditNote.PretaxCreditAmountr)rcredit_balance_transactionrr*)r3r*typeN)r+r,r-r.r/rrrr0r0r0r1PretaxCreditAmountFs  r5c@s^eZdZUGdddeZeed< eeed< eded< ee ded< deiZ d S) zCreditNote.Refundc@s eZdZUeed< eed<dS)z%CreditNote.Refund.PaymentRecordRefundpayment_record refund_groupNr+r,r-strr/r0r0r0r1PaymentRecordRefund[s r:amount_refundedpayment_record_refundRefundResourcerefund)r<r>r4N) r+r,r-rr:r.r/rrr_inner_class_typesr0r0r0r1rZs     rc@sheZdZUGdddeZeed< eed< eed< eeded< ee eed< deiZ d S) zCreditNote.ShippingCostc@s@eZdZUeed< ded< eeded< eeed<dS)zCreditNote.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/rrr0r0r0r1Taxxs  rRamount_subtotal amount_tax amount_totalr shipping_ratetaxesN) r+r,r-rrRr.r/rrr r?r0r0r0r1 ShippingCostws & rXc@sveZdZUGdddeZeed< eded< eeed< eded< eeed < eded < deiZ d S) zCreditNote.TotalTaxc@seZdZUeed<dS)z"CreditNote.TotalTax.TaxRateDetailstax_rateNr8r0r0r0r1TaxRateDetailss rZr)) exclusive inclusive tax_behaviortax_rate_details)rA not_availablerBrCrDrErFrGrHrIrJrKrLrMrNrOrPrQr4N) r+r,r-rrZr.r/rrr?r0r0r0r1TotalTaxs"      r`r)amount_shippingcreatedcurrencyrcustomerrcustomer_balance_transactiondiscount_amountdiscount_amounts effective_atidrinvoicerlineslivemodememometadatanumberobjectout_of_band_amountpdfpost_payment_amountpre_payment_amountpretax_credit_amounts) duplicate fraudulent order_changeproduct_unsatisfactoryreasonrefunds shipping_cost)issuedvoidstatussubtotalsubtotal_excluding_taxtotaltotal_excluding_tax total_taxes)mixed post_payment pre_paymentr4 voided_atparamsrreturncKstd|jd||dS) Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero. This amount is indicated by the credit note's pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following: Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds). 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). The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount. You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount, post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation. r&postr)r_static_request class_urlclsrr0r0r1createnszCreditNote.createcs"td|jd||dIdHS)rr&rrN)r_static_request_asyncrrr0r0r1 create_asyncs zCreditNote.create_asyncrcKs4|jd||d}t|tstdt|j|S)1 Returns a list of credit notes. getr%Expected list object from API, got %s)rr isinstancer TypeErrorr4r+rrresultr0r0r1lists zCreditNote.listcs<|jd||dIdH}t|tstdt|j|S)rrrNr)rrrrrr4r+rr0r0r1 list_asyncs zCreditNote.list_asyncr cKs*d|t|f}td|jd||dS)2 Updates an existing credit note. %s/%sr&rr)rr rrrrirurlr0r0r1modifyszCreditNote.modifycs2d|t|f}td|jd||dIdHS)rrr&rrN)rr rrrr0r0r1 modify_asyncs zCreditNote.modify_asyncr"cKstd|jdd|dS)E Get a preview of a credit note without creating it. r&r/v1/credit_notes/previewr)rrrr0r0r1previewszCreditNote.previewcstd|jdd|dIdHS)rr&rrrN)rrrr0r0r1 preview_asyncs zCreditNote.preview_asyncr!cKsttd|jdd|dS) 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)rrrrr0r0r1 preview_linesszCreditNote.preview_linescs"ttd|jdd|dIdHS)rrrrrN)rrrrr0r0r1preview_lines_async s zCreditNote.preview_lines_asyncr#cKs||fi|}||S)M Retrieves the credit note object with the given identifier. )refreshrririnstancer0r0r1retrieve0szCreditNote.retrievecs$||fi|}|IdH|S)rN) refresh_asyncrr0r0r1retrieve_async;szCreditNote.retrieve_asyncr$cKs"td|jddjt|d|dS) Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding). r&r/v1/credit_notes/{id}/voidrir)rrformatr rrirr0r0r1_cls_void_credit_noteFsz CreditNote._cls_void_credit_notecKdSrNr0rirr0r0r1void_credit_noteVszCreditNote.void_credit_notecKrrr0selfrr0r0r1r`src Ks(td|jddjt|dd|dS)rr&rrrirr)r_requestrr rrr0r0r1ris cs*td|jddjt|d|dIdHS)rr&rrrrN)rrrr rr0r0r1_cls_void_credit_note_async{s z&CreditNote._cls_void_credit_note_asynccdSrr0rr0r0r1void_credit_note_asyncsz!CreditNote.void_credit_note_asynccrrr0rr0r0r1rsrc s0td|jddjt|dd|dIdHS)rr&rrrirrN)r_request_asyncrr rrr0r0r1rs  rcKs&ttd|jddjt|d|dS) 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)rrrrr rr'rr0r0r1 list_linesszCreditNote.list_linescs.ttd|jddjt|d|dIdHS)rrrrrrN)rrrrr rr0r0r1list_lines_asyncs zCreditNote.list_lines_async)rgrur{r|rN).r+r,r-__doc__r(r rr/rr2r5rrXr`r.r9rrr rboolr classmethodrrrrrrrrrrrrrrr staticmethodrr rrrrr?r0r0r0r1r&.s  =/                                       r&N)@stripe._createable_api_resourcerstripe._expandable_fieldrstripe._list_objectrstripe._listable_api_resourcer%stripe._nested_resource_class_methodsrstripe._stripe_objectrstripe._updateable_api_resourcer stripe._utilr r typingr r r rrrtyping_extensionsrrrstripe._credit_note_line_itemrstripe._customerr$stripe._customer_balance_transactionrstripe._discountrstripe._invoicerstripe._refundrr=stripe._shipping_raterstripe._tax_rater*stripe.billing._credit_balance_transactionr(stripe.params._credit_note_create_paramsr,stripe.params._credit_note_list_lines_paramsr&stripe.params._credit_note_list_paramsr(stripe.params._credit_note_modify_paramsr /stripe.params._credit_note_preview_lines_paramsr!)stripe.params._credit_note_preview_paramsr"*stripe.params._credit_note_retrieve_paramsr#2stripe.params._credit_note_void_credit_note_paramsr$r&r0r0r0r1sD