-
Notifications
You must be signed in to change notification settings - Fork 0
/
invoice.go
3709 lines (3395 loc) · 214 KB
/
invoice.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package orb
import (
"context"
"errors"
"fmt"
"net/http"
"net/url"
"reflect"
"time"
"github.com/orbcorp/orb-go/internal/apijson"
"github.com/orbcorp/orb-go/internal/apiquery"
"github.com/orbcorp/orb-go/internal/pagination"
"github.com/orbcorp/orb-go/internal/param"
"github.com/orbcorp/orb-go/internal/requestconfig"
"github.com/orbcorp/orb-go/option"
"github.com/orbcorp/orb-go/shared"
"github.com/tidwall/gjson"
)
// InvoiceService contains methods and other services that help with interacting
// with the orb API.
//
// Note, unlike clients, this service does not read variables from the environment
// automatically. You should not instantiate this service directly, and instead use
// the [NewInvoiceService] method instead.
type InvoiceService struct {
Options []option.RequestOption
}
// NewInvoiceService generates a new service that applies the given options to each
// request. These options are applied after the parent client's options (if there
// is one), and before any request-specific options.
func NewInvoiceService(opts ...option.RequestOption) (r *InvoiceService) {
r = &InvoiceService{}
r.Options = opts
return
}
// This endpoint is used to create a one-off invoice for a customer.
func (r *InvoiceService) New(ctx context.Context, body InvoiceNewParams, opts ...option.RequestOption) (res *Invoice, err error) {
opts = append(r.Options[:], opts...)
path := "invoices"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return
}
// This endpoint returns a list of all [`Invoice`](../guides/concepts#invoice)s for
// an account in a list format.
//
// The list of invoices is ordered starting from the most recently issued invoice
// date. The response also includes
// [`pagination_metadata`](../reference/pagination), which lets the caller retrieve
// the next page of results if they exist.
//
// By default, this only returns invoices that are `issued`, `paid`, or `synced`.
func (r *InvoiceService) List(ctx context.Context, query InvoiceListParams, opts ...option.RequestOption) (res *pagination.Page[Invoice], err error) {
var raw *http.Response
opts = append(r.Options, opts...)
opts = append([]option.RequestOption{option.WithResponseInto(&raw)}, opts...)
path := "invoices"
cfg, err := requestconfig.NewRequestConfig(ctx, http.MethodGet, path, query, &res, opts...)
if err != nil {
return nil, err
}
err = cfg.Execute()
if err != nil {
return nil, err
}
res.SetPageConfig(cfg, raw)
return res, nil
}
// This endpoint returns a list of all [`Invoice`](../guides/concepts#invoice)s for
// an account in a list format.
//
// The list of invoices is ordered starting from the most recently issued invoice
// date. The response also includes
// [`pagination_metadata`](../reference/pagination), which lets the caller retrieve
// the next page of results if they exist.
//
// By default, this only returns invoices that are `issued`, `paid`, or `synced`.
func (r *InvoiceService) ListAutoPaging(ctx context.Context, query InvoiceListParams, opts ...option.RequestOption) *pagination.PageAutoPager[Invoice] {
return pagination.NewPageAutoPager(r.List(ctx, query, opts...))
}
// This endpoint is used to fetch an [`Invoice`](../guides/concepts#invoice) given
// an identifier.
func (r *InvoiceService) Fetch(ctx context.Context, invoiceID string, opts ...option.RequestOption) (res *Invoice, err error) {
opts = append(r.Options[:], opts...)
if invoiceID == "" {
err = errors.New("missing required invoice_id parameter")
return
}
path := fmt.Sprintf("invoices/%s", invoiceID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &res, opts...)
return
}
// This endpoint can be used to fetch the upcoming
// [invoice](../guides/concepts#invoice) for the current billing period given a
// subscription.
func (r *InvoiceService) FetchUpcoming(ctx context.Context, query InvoiceFetchUpcomingParams, opts ...option.RequestOption) (res *InvoiceFetchUpcomingResponse, err error) {
opts = append(r.Options[:], opts...)
path := "invoices/upcoming"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &res, opts...)
return
}
// This endpoint allows an eligible invoice to be issued manually. This is only
// possible with invoices where status is `draft`, `will_auto_issue` is false, and
// an `eligible_to_issue_at` is a time in the past. Issuing an invoice could
// possibly trigger side effects, some of which could be customer-visible (e.g.
// sending emails, auto-collecting payment, syncing the invoice to external
// providers, etc).
func (r *InvoiceService) Issue(ctx context.Context, invoiceID string, opts ...option.RequestOption) (res *Invoice, err error) {
opts = append(r.Options[:], opts...)
if invoiceID == "" {
err = errors.New("missing required invoice_id parameter")
return
}
path := fmt.Sprintf("invoices/%s/issue", invoiceID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, nil, &res, opts...)
return
}
// This endpoint allows an invoice's status to be set the `paid` status. This can
// only be done to invoices that are in the `issued` status.
func (r *InvoiceService) MarkPaid(ctx context.Context, invoiceID string, body InvoiceMarkPaidParams, opts ...option.RequestOption) (res *Invoice, err error) {
opts = append(r.Options[:], opts...)
if invoiceID == "" {
err = errors.New("missing required invoice_id parameter")
return
}
path := fmt.Sprintf("invoices/%s/mark_paid", invoiceID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return
}
// This endpoint allows an invoice's status to be set the `void` status. This can
// only be done to invoices that are in the `issued` status.
//
// If the associated invoice has used the customer balance to change the amount
// due, the customer balance operation will be reverted. For example, if the
// invoice used $10 of customer balance, that amount will be added back to the
// customer balance upon voiding.
func (r *InvoiceService) Void(ctx context.Context, invoiceID string, opts ...option.RequestOption) (res *Invoice, err error) {
opts = append(r.Options[:], opts...)
if invoiceID == "" {
err = errors.New("missing required invoice_id parameter")
return
}
path := fmt.Sprintf("invoices/%s/void", invoiceID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, nil, &res, opts...)
return
}
// An [`Invoice`](../guides/concepts#invoice) is a fundamental billing entity,
// representing the request for payment for a single subscription. This includes a
// set of line items, which correspond to prices in the subscription's plan and can
// represent fixed recurring fees or usage-based fees. They are generated at the
// end of a billing period, or as the result of an action, such as a cancellation.
type Invoice struct {
ID string `json:"id,required"`
// This is the final amount required to be charged to the customer and reflects the
// application of the customer balance to the `total` of the invoice.
AmountDue string `json:"amount_due,required"`
AutoCollection InvoiceAutoCollection `json:"auto_collection,required"`
BillingAddress InvoiceBillingAddress `json:"billing_address,required,nullable"`
// The creation time of the resource in Orb.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// A list of credit notes associated with the invoice
CreditNotes []InvoiceCreditNote `json:"credit_notes,required"`
// An ISO 4217 currency string or `credits`
Currency string `json:"currency,required"`
Customer InvoiceCustomer `json:"customer,required"`
CustomerBalanceTransactions []InvoiceCustomerBalanceTransaction `json:"customer_balance_transactions,required"`
// Tax IDs are commonly required to be displayed on customer invoices, which are
// added to the headers of invoices.
//
// ### Supported Tax ID Countries and Types
//
// | Country | Type | Description |
// | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
// | Andorra | `ad_nrt` | Andorran NRT Number |
// | Argentina | `ar_cuit` | Argentinian Tax ID Number |
// | Australia | `au_abn` | Australian Business Number (AU ABN) |
// | Australia | `au_arn` | Australian Taxation Office Reference Number |
// | Austria | `eu_vat` | European VAT Number |
// | Bahrain | `bh_vat` | Bahraini VAT Number |
// | Belgium | `eu_vat` | European VAT Number |
// | Bolivia | `bo_tin` | Bolivian Tax ID |
// | Brazil | `br_cnpj` | Brazilian CNPJ Number |
// | Brazil | `br_cpf` | Brazilian CPF Number |
// | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
// | Bulgaria | `eu_vat` | European VAT Number |
// | Canada | `ca_bn` | Canadian BN |
// | Canada | `ca_gst_hst` | Canadian GST/HST Number |
// | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
// | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
// | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
// | Canada | `ca_qst` | Canadian QST Number (Québec) |
// | Chile | `cl_tin` | Chilean TIN |
// | China | `cn_tin` | Chinese Tax ID |
// | Colombia | `co_nit` | Colombian NIT Number |
// | Costa Rica | `cr_tin` | Costa Rican Tax ID |
// | Croatia | `eu_vat` | European VAT Number |
// | Cyprus | `eu_vat` | European VAT Number |
// | Czech Republic | `eu_vat` | European VAT Number |
// | Denmark | `eu_vat` | European VAT Number |
// | Dominican Republic | `do_rcn` | Dominican RCN Number |
// | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
// | Egypt | `eg_tin` | Egyptian Tax Identification Number |
// | El Salvador | `sv_nit` | El Salvadorian NIT Number |
// | Estonia | `eu_vat` | European VAT Number |
// | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
// | Finland | `eu_vat` | European VAT Number |
// | France | `eu_vat` | European VAT Number |
// | Georgia | `ge_vat` | Georgian VAT |
// | Germany | `eu_vat` | European VAT Number |
// | Greece | `eu_vat` | European VAT Number |
// | Hong Kong | `hk_br` | Hong Kong BR Number |
// | Hungary | `eu_vat` | European VAT Number |
// | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
// | Iceland | `is_vat` | Icelandic VAT |
// | India | `in_gst` | Indian GST Number |
// | Indonesia | `id_npwp` | Indonesian NPWP Number |
// | Ireland | `eu_vat` | European VAT Number |
// | Israel | `il_vat` | Israel VAT |
// | Italy | `eu_vat` | European VAT Number |
// | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
// | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
// | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
// | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
// | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
// | Latvia | `eu_vat` | European VAT Number |
// | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
// | Lithuania | `eu_vat` | European VAT Number |
// | Luxembourg | `eu_vat` | European VAT Number |
// | Malaysia | `my_frp` | Malaysian FRP Number |
// | Malaysia | `my_itn` | Malaysian ITN |
// | Malaysia | `my_sst` | Malaysian SST Number |
// | Malta | `eu_vat ` | European VAT Number |
// | Mexico | `mx_rfc` | Mexican RFC Number |
// | Netherlands | `eu_vat` | European VAT Number |
// | New Zealand | `nz_gst` | New Zealand GST Number |
// | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
// | Norway | `no_vat` | Norwegian VAT Number |
// | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
// | Oman | `om_vat` | Omani VAT Number |
// | Peru | `pe_ruc` | Peruvian RUC Number |
// | Philippines | `ph_tin ` | Philippines Tax Identification Number |
// | Poland | `eu_vat` | European VAT Number |
// | Portugal | `eu_vat` | European VAT Number |
// | Romania | `eu_vat` | European VAT Number |
// | Romania | `ro_tin` | Romanian Tax ID Number |
// | Russia | `ru_inn` | Russian INN |
// | Russia | `ru_kpp` | Russian KPP |
// | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
// | Serbia | `rs_pib` | Serbian PIB Number |
// | Singapore | `sg_gst` | Singaporean GST |
// | Singapore | `sg_uen` | Singaporean UEN |
// | Slovakia | `eu_vat` | European VAT Number |
// | Slovenia | `eu_vat` | European VAT Number |
// | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
// | South Africa | `za_vat` | South African VAT Number |
// | South Korea | `kr_brn` | Korean BRN |
// | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
// | Spain | `eu_vat` | European VAT Number |
// | Sweden | `eu_vat` | European VAT Number |
// | Switzerland | `ch_vat` | Switzerland VAT Number |
// | Taiwan | `tw_vat` | Taiwanese VAT |
// | Thailand | `th_vat` | Thai VAT |
// | Turkey | `tr_tin` | Turkish Tax Identification Number |
// | Ukraine | `ua_vat` | Ukrainian VAT |
// | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
// | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
// | United Kingdom | `gb_vat` | United Kingdom VAT Number |
// | United States | `us_ein` | United States EIN |
// | Uruguay | `uy_ruc` | Uruguayan RUC Number |
// | Venezuela | `ve_rif` | Venezuelan RIF Number |
// | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
CustomerTaxID InvoiceCustomerTaxID `json:"customer_tax_id,required,nullable"`
Discount shared.Discount `json:"discount,required,nullable"`
Discounts []shared.Discount `json:"discounts,required"`
// When the invoice payment is due.
DueDate time.Time `json:"due_date,required" format:"date-time"`
// If the invoice has a status of `draft`, this will be the time that the invoice
// will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is
// true, the invoice will automatically begin issuing at this time.
EligibleToIssueAt time.Time `json:"eligible_to_issue_at,required,nullable" format:"date-time"`
// A URL for the invoice portal.
HostedInvoiceURL string `json:"hosted_invoice_url,required,nullable"`
// The scheduled date of the invoice
InvoiceDate time.Time `json:"invoice_date,required" format:"date-time"`
// Automatically generated invoice number to help track and reconcile invoices.
// Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per
// account or customer.
InvoiceNumber string `json:"invoice_number,required"`
// The link to download the PDF representation of the `Invoice`.
InvoicePdf string `json:"invoice_pdf,required,nullable"`
InvoiceSource InvoiceInvoiceSource `json:"invoice_source,required"`
// If the invoice failed to issue, this will be the last time it failed to issue
// (even if it is now in a different state.)
IssueFailedAt time.Time `json:"issue_failed_at,required,nullable" format:"date-time"`
// If the invoice has been issued, this will be the time it transitioned to
// `issued` (even if it is now in a different state.)
IssuedAt time.Time `json:"issued_at,required,nullable" format:"date-time"`
// The breakdown of prices in this invoice.
LineItems []InvoiceLineItem `json:"line_items,required"`
Maximum InvoiceMaximum `json:"maximum,required,nullable"`
MaximumAmount string `json:"maximum_amount,required,nullable"`
// Free-form text which is available on the invoice PDF and the Orb invoice portal.
Memo string `json:"memo,required,nullable"`
// User specified key-value pairs for the resource. If not present, this defaults
// to an empty dictionary. Individual keys can be removed by setting the value to
// `null`, and the entire metadata mapping can be cleared by setting `metadata` to
// `null`.
Metadata map[string]string `json:"metadata,required"`
Minimum InvoiceMinimum `json:"minimum,required,nullable"`
MinimumAmount string `json:"minimum_amount,required,nullable"`
// If the invoice has a status of `paid`, this gives a timestamp when the invoice
// was paid.
PaidAt time.Time `json:"paid_at,required,nullable" format:"date-time"`
// If payment was attempted on this invoice but failed, this will be the time of
// the most recent attempt.
PaymentFailedAt time.Time `json:"payment_failed_at,required,nullable" format:"date-time"`
// If payment was attempted on this invoice, this will be the start time of the
// most recent attempt. This field is especially useful for delayed-notification
// payment mechanisms (like bank transfers), where payment can take 3 days or more.
PaymentStartedAt time.Time `json:"payment_started_at,required,nullable" format:"date-time"`
// If the invoice is in draft, this timestamp will reflect when the invoice is
// scheduled to be issued.
ScheduledIssueAt time.Time `json:"scheduled_issue_at,required,nullable" format:"date-time"`
ShippingAddress InvoiceShippingAddress `json:"shipping_address,required,nullable"`
Status InvoiceStatus `json:"status,required"`
Subscription InvoiceSubscription `json:"subscription,required,nullable"`
// The total before any discounts and minimums are applied.
Subtotal string `json:"subtotal,required"`
// If the invoice failed to sync, this will be the last time an external invoicing
// provider sync was attempted. This field will always be `null` for invoices using
// Orb Invoicing.
SyncFailedAt time.Time `json:"sync_failed_at,required,nullable" format:"date-time"`
// The total after any minimums and discounts have been applied.
Total string `json:"total,required"`
// If the invoice has a status of `void`, this gives a timestamp when the invoice
// was voided.
VoidedAt time.Time `json:"voided_at,required,nullable" format:"date-time"`
// This is true if the invoice will be automatically issued in the future, and
// false otherwise.
WillAutoIssue bool `json:"will_auto_issue,required"`
JSON invoiceJSON `json:"-"`
}
// invoiceJSON contains the JSON metadata for the struct [Invoice]
type invoiceJSON struct {
ID apijson.Field
AmountDue apijson.Field
AutoCollection apijson.Field
BillingAddress apijson.Field
CreatedAt apijson.Field
CreditNotes apijson.Field
Currency apijson.Field
Customer apijson.Field
CustomerBalanceTransactions apijson.Field
CustomerTaxID apijson.Field
Discount apijson.Field
Discounts apijson.Field
DueDate apijson.Field
EligibleToIssueAt apijson.Field
HostedInvoiceURL apijson.Field
InvoiceDate apijson.Field
InvoiceNumber apijson.Field
InvoicePdf apijson.Field
InvoiceSource apijson.Field
IssueFailedAt apijson.Field
IssuedAt apijson.Field
LineItems apijson.Field
Maximum apijson.Field
MaximumAmount apijson.Field
Memo apijson.Field
Metadata apijson.Field
Minimum apijson.Field
MinimumAmount apijson.Field
PaidAt apijson.Field
PaymentFailedAt apijson.Field
PaymentStartedAt apijson.Field
ScheduledIssueAt apijson.Field
ShippingAddress apijson.Field
Status apijson.Field
Subscription apijson.Field
Subtotal apijson.Field
SyncFailedAt apijson.Field
Total apijson.Field
VoidedAt apijson.Field
WillAutoIssue apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *Invoice) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r invoiceJSON) RawJSON() string {
return r.raw
}
type InvoiceAutoCollection struct {
// True only if auto-collection is enabled for this invoice.
Enabled bool `json:"enabled,required,nullable"`
// If the invoice is scheduled for auto-collection, this field will reflect when
// the next attempt will occur. If dunning has been exhausted, or auto-collection
// is not enabled for this invoice, this field will be `null`.
NextAttemptAt time.Time `json:"next_attempt_at,required,nullable" format:"date-time"`
// If Orb has ever attempted payment auto-collection for this invoice, this field
// will reflect when that attempt occurred. In conjunction with `next_attempt_at`,
// this can be used to tell whether the invoice is currently in dunning (that is,
// `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or
// if dunning has been exhausted (`previously_attempted_at` is non-null, but
// `next_attempt_time` is null).
PreviouslyAttemptedAt time.Time `json:"previously_attempted_at,required,nullable" format:"date-time"`
JSON invoiceAutoCollectionJSON `json:"-"`
}
// invoiceAutoCollectionJSON contains the JSON metadata for the struct
// [InvoiceAutoCollection]
type invoiceAutoCollectionJSON struct {
Enabled apijson.Field
NextAttemptAt apijson.Field
PreviouslyAttemptedAt apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *InvoiceAutoCollection) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r invoiceAutoCollectionJSON) RawJSON() string {
return r.raw
}
type InvoiceBillingAddress struct {
City string `json:"city,required,nullable"`
Country string `json:"country,required,nullable"`
Line1 string `json:"line1,required,nullable"`
Line2 string `json:"line2,required,nullable"`
PostalCode string `json:"postal_code,required,nullable"`
State string `json:"state,required,nullable"`
JSON invoiceBillingAddressJSON `json:"-"`
}
// invoiceBillingAddressJSON contains the JSON metadata for the struct
// [InvoiceBillingAddress]
type invoiceBillingAddressJSON struct {
City apijson.Field
Country apijson.Field
Line1 apijson.Field
Line2 apijson.Field
PostalCode apijson.Field
State apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *InvoiceBillingAddress) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r invoiceBillingAddressJSON) RawJSON() string {
return r.raw
}
type InvoiceCreditNote struct {
ID string `json:"id,required"`
CreditNoteNumber string `json:"credit_note_number,required"`
// An optional memo supplied on the credit note.
Memo string `json:"memo,required,nullable"`
Reason string `json:"reason,required"`
Total string `json:"total,required"`
Type string `json:"type,required"`
// If the credit note has a status of `void`, this gives a timestamp when the
// credit note was voided.
VoidedAt time.Time `json:"voided_at,required,nullable" format:"date-time"`
JSON invoiceCreditNoteJSON `json:"-"`
}
// invoiceCreditNoteJSON contains the JSON metadata for the struct
// [InvoiceCreditNote]
type invoiceCreditNoteJSON struct {
ID apijson.Field
CreditNoteNumber apijson.Field
Memo apijson.Field
Reason apijson.Field
Total apijson.Field
Type apijson.Field
VoidedAt apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *InvoiceCreditNote) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r invoiceCreditNoteJSON) RawJSON() string {
return r.raw
}
type InvoiceCustomer struct {
ID string `json:"id,required"`
ExternalCustomerID string `json:"external_customer_id,required,nullable"`
JSON invoiceCustomerJSON `json:"-"`
}
// invoiceCustomerJSON contains the JSON metadata for the struct [InvoiceCustomer]
type invoiceCustomerJSON struct {
ID apijson.Field
ExternalCustomerID apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *InvoiceCustomer) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r invoiceCustomerJSON) RawJSON() string {
return r.raw
}
type InvoiceCustomerBalanceTransaction struct {
// A unique id for this transaction.
ID string `json:"id,required"`
Action InvoiceCustomerBalanceTransactionsAction `json:"action,required"`
// The value of the amount changed in the transaction.
Amount string `json:"amount,required"`
// The creation time of this transaction.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
CreditNote InvoiceCustomerBalanceTransactionsCreditNote `json:"credit_note,required,nullable"`
// An optional description provided for manual customer balance adjustments.
Description string `json:"description,required,nullable"`
// The new value of the customer's balance prior to the transaction, in the
// customer's currency.
EndingBalance string `json:"ending_balance,required"`
Invoice InvoiceCustomerBalanceTransactionsInvoice `json:"invoice,required,nullable"`
// The original value of the customer's balance prior to the transaction, in the
// customer's currency.
StartingBalance string `json:"starting_balance,required"`
Type InvoiceCustomerBalanceTransactionsType `json:"type,required"`
JSON invoiceCustomerBalanceTransactionJSON `json:"-"`
}
// invoiceCustomerBalanceTransactionJSON contains the JSON metadata for the struct
// [InvoiceCustomerBalanceTransaction]
type invoiceCustomerBalanceTransactionJSON struct {
ID apijson.Field
Action apijson.Field
Amount apijson.Field
CreatedAt apijson.Field
CreditNote apijson.Field
Description apijson.Field
EndingBalance apijson.Field
Invoice apijson.Field
StartingBalance apijson.Field
Type apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *InvoiceCustomerBalanceTransaction) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r invoiceCustomerBalanceTransactionJSON) RawJSON() string {
return r.raw
}
type InvoiceCustomerBalanceTransactionsAction string
const (
InvoiceCustomerBalanceTransactionsActionAppliedToInvoice InvoiceCustomerBalanceTransactionsAction = "applied_to_invoice"
InvoiceCustomerBalanceTransactionsActionManualAdjustment InvoiceCustomerBalanceTransactionsAction = "manual_adjustment"
InvoiceCustomerBalanceTransactionsActionProratedRefund InvoiceCustomerBalanceTransactionsAction = "prorated_refund"
InvoiceCustomerBalanceTransactionsActionRevertProratedRefund InvoiceCustomerBalanceTransactionsAction = "revert_prorated_refund"
InvoiceCustomerBalanceTransactionsActionReturnFromVoiding InvoiceCustomerBalanceTransactionsAction = "return_from_voiding"
InvoiceCustomerBalanceTransactionsActionCreditNoteApplied InvoiceCustomerBalanceTransactionsAction = "credit_note_applied"
InvoiceCustomerBalanceTransactionsActionCreditNoteVoided InvoiceCustomerBalanceTransactionsAction = "credit_note_voided"
InvoiceCustomerBalanceTransactionsActionOverpaymentRefund InvoiceCustomerBalanceTransactionsAction = "overpayment_refund"
)
func (r InvoiceCustomerBalanceTransactionsAction) IsKnown() bool {
switch r {
case InvoiceCustomerBalanceTransactionsActionAppliedToInvoice, InvoiceCustomerBalanceTransactionsActionManualAdjustment, InvoiceCustomerBalanceTransactionsActionProratedRefund, InvoiceCustomerBalanceTransactionsActionRevertProratedRefund, InvoiceCustomerBalanceTransactionsActionReturnFromVoiding, InvoiceCustomerBalanceTransactionsActionCreditNoteApplied, InvoiceCustomerBalanceTransactionsActionCreditNoteVoided, InvoiceCustomerBalanceTransactionsActionOverpaymentRefund:
return true
}
return false
}
type InvoiceCustomerBalanceTransactionsCreditNote struct {
// The id of the Credit note
ID string `json:"id,required"`
JSON invoiceCustomerBalanceTransactionsCreditNoteJSON `json:"-"`
}
// invoiceCustomerBalanceTransactionsCreditNoteJSON contains the JSON metadata for
// the struct [InvoiceCustomerBalanceTransactionsCreditNote]
type invoiceCustomerBalanceTransactionsCreditNoteJSON struct {
ID apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *InvoiceCustomerBalanceTransactionsCreditNote) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r invoiceCustomerBalanceTransactionsCreditNoteJSON) RawJSON() string {
return r.raw
}
type InvoiceCustomerBalanceTransactionsInvoice struct {
// The Invoice id
ID string `json:"id,required"`
JSON invoiceCustomerBalanceTransactionsInvoiceJSON `json:"-"`
}
// invoiceCustomerBalanceTransactionsInvoiceJSON contains the JSON metadata for the
// struct [InvoiceCustomerBalanceTransactionsInvoice]
type invoiceCustomerBalanceTransactionsInvoiceJSON struct {
ID apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *InvoiceCustomerBalanceTransactionsInvoice) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r invoiceCustomerBalanceTransactionsInvoiceJSON) RawJSON() string {
return r.raw
}
type InvoiceCustomerBalanceTransactionsType string
const (
InvoiceCustomerBalanceTransactionsTypeIncrement InvoiceCustomerBalanceTransactionsType = "increment"
InvoiceCustomerBalanceTransactionsTypeDecrement InvoiceCustomerBalanceTransactionsType = "decrement"
)
func (r InvoiceCustomerBalanceTransactionsType) IsKnown() bool {
switch r {
case InvoiceCustomerBalanceTransactionsTypeIncrement, InvoiceCustomerBalanceTransactionsTypeDecrement:
return true
}
return false
}
// Tax IDs are commonly required to be displayed on customer invoices, which are
// added to the headers of invoices.
//
// ### Supported Tax ID Countries and Types
//
// | Country | Type | Description |
// | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
// | Andorra | `ad_nrt` | Andorran NRT Number |
// | Argentina | `ar_cuit` | Argentinian Tax ID Number |
// | Australia | `au_abn` | Australian Business Number (AU ABN) |
// | Australia | `au_arn` | Australian Taxation Office Reference Number |
// | Austria | `eu_vat` | European VAT Number |
// | Bahrain | `bh_vat` | Bahraini VAT Number |
// | Belgium | `eu_vat` | European VAT Number |
// | Bolivia | `bo_tin` | Bolivian Tax ID |
// | Brazil | `br_cnpj` | Brazilian CNPJ Number |
// | Brazil | `br_cpf` | Brazilian CPF Number |
// | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
// | Bulgaria | `eu_vat` | European VAT Number |
// | Canada | `ca_bn` | Canadian BN |
// | Canada | `ca_gst_hst` | Canadian GST/HST Number |
// | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
// | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
// | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
// | Canada | `ca_qst` | Canadian QST Number (Québec) |
// | Chile | `cl_tin` | Chilean TIN |
// | China | `cn_tin` | Chinese Tax ID |
// | Colombia | `co_nit` | Colombian NIT Number |
// | Costa Rica | `cr_tin` | Costa Rican Tax ID |
// | Croatia | `eu_vat` | European VAT Number |
// | Cyprus | `eu_vat` | European VAT Number |
// | Czech Republic | `eu_vat` | European VAT Number |
// | Denmark | `eu_vat` | European VAT Number |
// | Dominican Republic | `do_rcn` | Dominican RCN Number |
// | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
// | Egypt | `eg_tin` | Egyptian Tax Identification Number |
// | El Salvador | `sv_nit` | El Salvadorian NIT Number |
// | Estonia | `eu_vat` | European VAT Number |
// | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
// | Finland | `eu_vat` | European VAT Number |
// | France | `eu_vat` | European VAT Number |
// | Georgia | `ge_vat` | Georgian VAT |
// | Germany | `eu_vat` | European VAT Number |
// | Greece | `eu_vat` | European VAT Number |
// | Hong Kong | `hk_br` | Hong Kong BR Number |
// | Hungary | `eu_vat` | European VAT Number |
// | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
// | Iceland | `is_vat` | Icelandic VAT |
// | India | `in_gst` | Indian GST Number |
// | Indonesia | `id_npwp` | Indonesian NPWP Number |
// | Ireland | `eu_vat` | European VAT Number |
// | Israel | `il_vat` | Israel VAT |
// | Italy | `eu_vat` | European VAT Number |
// | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
// | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
// | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
// | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
// | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
// | Latvia | `eu_vat` | European VAT Number |
// | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
// | Lithuania | `eu_vat` | European VAT Number |
// | Luxembourg | `eu_vat` | European VAT Number |
// | Malaysia | `my_frp` | Malaysian FRP Number |
// | Malaysia | `my_itn` | Malaysian ITN |
// | Malaysia | `my_sst` | Malaysian SST Number |
// | Malta | `eu_vat ` | European VAT Number |
// | Mexico | `mx_rfc` | Mexican RFC Number |
// | Netherlands | `eu_vat` | European VAT Number |
// | New Zealand | `nz_gst` | New Zealand GST Number |
// | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
// | Norway | `no_vat` | Norwegian VAT Number |
// | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
// | Oman | `om_vat` | Omani VAT Number |
// | Peru | `pe_ruc` | Peruvian RUC Number |
// | Philippines | `ph_tin ` | Philippines Tax Identification Number |
// | Poland | `eu_vat` | European VAT Number |
// | Portugal | `eu_vat` | European VAT Number |
// | Romania | `eu_vat` | European VAT Number |
// | Romania | `ro_tin` | Romanian Tax ID Number |
// | Russia | `ru_inn` | Russian INN |
// | Russia | `ru_kpp` | Russian KPP |
// | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
// | Serbia | `rs_pib` | Serbian PIB Number |
// | Singapore | `sg_gst` | Singaporean GST |
// | Singapore | `sg_uen` | Singaporean UEN |
// | Slovakia | `eu_vat` | European VAT Number |
// | Slovenia | `eu_vat` | European VAT Number |
// | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
// | South Africa | `za_vat` | South African VAT Number |
// | South Korea | `kr_brn` | Korean BRN |
// | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
// | Spain | `eu_vat` | European VAT Number |
// | Sweden | `eu_vat` | European VAT Number |
// | Switzerland | `ch_vat` | Switzerland VAT Number |
// | Taiwan | `tw_vat` | Taiwanese VAT |
// | Thailand | `th_vat` | Thai VAT |
// | Turkey | `tr_tin` | Turkish Tax Identification Number |
// | Ukraine | `ua_vat` | Ukrainian VAT |
// | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
// | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
// | United Kingdom | `gb_vat` | United Kingdom VAT Number |
// | United States | `us_ein` | United States EIN |
// | Uruguay | `uy_ruc` | Uruguayan RUC Number |
// | Venezuela | `ve_rif` | Venezuelan RIF Number |
// | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
type InvoiceCustomerTaxID struct {
Country InvoiceCustomerTaxIDCountry `json:"country,required"`
Type InvoiceCustomerTaxIDType `json:"type,required"`
Value string `json:"value,required"`
JSON invoiceCustomerTaxIDJSON `json:"-"`
}
// invoiceCustomerTaxIDJSON contains the JSON metadata for the struct
// [InvoiceCustomerTaxID]
type invoiceCustomerTaxIDJSON struct {
Country apijson.Field
Type apijson.Field
Value apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *InvoiceCustomerTaxID) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r invoiceCustomerTaxIDJSON) RawJSON() string {
return r.raw
}
type InvoiceCustomerTaxIDCountry string
const (
InvoiceCustomerTaxIDCountryAd InvoiceCustomerTaxIDCountry = "AD"
InvoiceCustomerTaxIDCountryAe InvoiceCustomerTaxIDCountry = "AE"
InvoiceCustomerTaxIDCountryAr InvoiceCustomerTaxIDCountry = "AR"
InvoiceCustomerTaxIDCountryAt InvoiceCustomerTaxIDCountry = "AT"
InvoiceCustomerTaxIDCountryAu InvoiceCustomerTaxIDCountry = "AU"
InvoiceCustomerTaxIDCountryBe InvoiceCustomerTaxIDCountry = "BE"
InvoiceCustomerTaxIDCountryBg InvoiceCustomerTaxIDCountry = "BG"
InvoiceCustomerTaxIDCountryBh InvoiceCustomerTaxIDCountry = "BH"
InvoiceCustomerTaxIDCountryBo InvoiceCustomerTaxIDCountry = "BO"
InvoiceCustomerTaxIDCountryBr InvoiceCustomerTaxIDCountry = "BR"
InvoiceCustomerTaxIDCountryCa InvoiceCustomerTaxIDCountry = "CA"
InvoiceCustomerTaxIDCountryCh InvoiceCustomerTaxIDCountry = "CH"
InvoiceCustomerTaxIDCountryCl InvoiceCustomerTaxIDCountry = "CL"
InvoiceCustomerTaxIDCountryCn InvoiceCustomerTaxIDCountry = "CN"
InvoiceCustomerTaxIDCountryCo InvoiceCustomerTaxIDCountry = "CO"
InvoiceCustomerTaxIDCountryCr InvoiceCustomerTaxIDCountry = "CR"
InvoiceCustomerTaxIDCountryCy InvoiceCustomerTaxIDCountry = "CY"
InvoiceCustomerTaxIDCountryCz InvoiceCustomerTaxIDCountry = "CZ"
InvoiceCustomerTaxIDCountryDe InvoiceCustomerTaxIDCountry = "DE"
InvoiceCustomerTaxIDCountryDk InvoiceCustomerTaxIDCountry = "DK"
InvoiceCustomerTaxIDCountryEe InvoiceCustomerTaxIDCountry = "EE"
InvoiceCustomerTaxIDCountryDo InvoiceCustomerTaxIDCountry = "DO"
InvoiceCustomerTaxIDCountryEc InvoiceCustomerTaxIDCountry = "EC"
InvoiceCustomerTaxIDCountryEg InvoiceCustomerTaxIDCountry = "EG"
InvoiceCustomerTaxIDCountryEs InvoiceCustomerTaxIDCountry = "ES"
InvoiceCustomerTaxIDCountryEu InvoiceCustomerTaxIDCountry = "EU"
InvoiceCustomerTaxIDCountryFi InvoiceCustomerTaxIDCountry = "FI"
InvoiceCustomerTaxIDCountryFr InvoiceCustomerTaxIDCountry = "FR"
InvoiceCustomerTaxIDCountryGB InvoiceCustomerTaxIDCountry = "GB"
InvoiceCustomerTaxIDCountryGe InvoiceCustomerTaxIDCountry = "GE"
InvoiceCustomerTaxIDCountryGr InvoiceCustomerTaxIDCountry = "GR"
InvoiceCustomerTaxIDCountryHk InvoiceCustomerTaxIDCountry = "HK"
InvoiceCustomerTaxIDCountryHr InvoiceCustomerTaxIDCountry = "HR"
InvoiceCustomerTaxIDCountryHu InvoiceCustomerTaxIDCountry = "HU"
InvoiceCustomerTaxIDCountryID InvoiceCustomerTaxIDCountry = "ID"
InvoiceCustomerTaxIDCountryIe InvoiceCustomerTaxIDCountry = "IE"
InvoiceCustomerTaxIDCountryIl InvoiceCustomerTaxIDCountry = "IL"
InvoiceCustomerTaxIDCountryIn InvoiceCustomerTaxIDCountry = "IN"
InvoiceCustomerTaxIDCountryIs InvoiceCustomerTaxIDCountry = "IS"
InvoiceCustomerTaxIDCountryIt InvoiceCustomerTaxIDCountry = "IT"
InvoiceCustomerTaxIDCountryJp InvoiceCustomerTaxIDCountry = "JP"
InvoiceCustomerTaxIDCountryKe InvoiceCustomerTaxIDCountry = "KE"
InvoiceCustomerTaxIDCountryKr InvoiceCustomerTaxIDCountry = "KR"
InvoiceCustomerTaxIDCountryKz InvoiceCustomerTaxIDCountry = "KZ"
InvoiceCustomerTaxIDCountryLi InvoiceCustomerTaxIDCountry = "LI"
InvoiceCustomerTaxIDCountryLt InvoiceCustomerTaxIDCountry = "LT"
InvoiceCustomerTaxIDCountryLu InvoiceCustomerTaxIDCountry = "LU"
InvoiceCustomerTaxIDCountryLv InvoiceCustomerTaxIDCountry = "LV"
InvoiceCustomerTaxIDCountryMt InvoiceCustomerTaxIDCountry = "MT"
InvoiceCustomerTaxIDCountryMx InvoiceCustomerTaxIDCountry = "MX"
InvoiceCustomerTaxIDCountryMy InvoiceCustomerTaxIDCountry = "MY"
InvoiceCustomerTaxIDCountryNg InvoiceCustomerTaxIDCountry = "NG"
InvoiceCustomerTaxIDCountryNl InvoiceCustomerTaxIDCountry = "NL"
InvoiceCustomerTaxIDCountryNo InvoiceCustomerTaxIDCountry = "NO"
InvoiceCustomerTaxIDCountryNz InvoiceCustomerTaxIDCountry = "NZ"
InvoiceCustomerTaxIDCountryOm InvoiceCustomerTaxIDCountry = "OM"
InvoiceCustomerTaxIDCountryPe InvoiceCustomerTaxIDCountry = "PE"
InvoiceCustomerTaxIDCountryPh InvoiceCustomerTaxIDCountry = "PH"
InvoiceCustomerTaxIDCountryPl InvoiceCustomerTaxIDCountry = "PL"
InvoiceCustomerTaxIDCountryPt InvoiceCustomerTaxIDCountry = "PT"
InvoiceCustomerTaxIDCountryRo InvoiceCustomerTaxIDCountry = "RO"
InvoiceCustomerTaxIDCountryRs InvoiceCustomerTaxIDCountry = "RS"
InvoiceCustomerTaxIDCountryRu InvoiceCustomerTaxIDCountry = "RU"
InvoiceCustomerTaxIDCountrySa InvoiceCustomerTaxIDCountry = "SA"
InvoiceCustomerTaxIDCountrySe InvoiceCustomerTaxIDCountry = "SE"
InvoiceCustomerTaxIDCountrySg InvoiceCustomerTaxIDCountry = "SG"
InvoiceCustomerTaxIDCountrySi InvoiceCustomerTaxIDCountry = "SI"
InvoiceCustomerTaxIDCountrySk InvoiceCustomerTaxIDCountry = "SK"
InvoiceCustomerTaxIDCountrySv InvoiceCustomerTaxIDCountry = "SV"
InvoiceCustomerTaxIDCountryTh InvoiceCustomerTaxIDCountry = "TH"
InvoiceCustomerTaxIDCountryTr InvoiceCustomerTaxIDCountry = "TR"
InvoiceCustomerTaxIDCountryTw InvoiceCustomerTaxIDCountry = "TW"
InvoiceCustomerTaxIDCountryUa InvoiceCustomerTaxIDCountry = "UA"
InvoiceCustomerTaxIDCountryUs InvoiceCustomerTaxIDCountry = "US"
InvoiceCustomerTaxIDCountryUy InvoiceCustomerTaxIDCountry = "UY"
InvoiceCustomerTaxIDCountryVe InvoiceCustomerTaxIDCountry = "VE"
InvoiceCustomerTaxIDCountryVn InvoiceCustomerTaxIDCountry = "VN"
InvoiceCustomerTaxIDCountryZa InvoiceCustomerTaxIDCountry = "ZA"
)
func (r InvoiceCustomerTaxIDCountry) IsKnown() bool {
switch r {
case InvoiceCustomerTaxIDCountryAd, InvoiceCustomerTaxIDCountryAe, InvoiceCustomerTaxIDCountryAr, InvoiceCustomerTaxIDCountryAt, InvoiceCustomerTaxIDCountryAu, InvoiceCustomerTaxIDCountryBe, InvoiceCustomerTaxIDCountryBg, InvoiceCustomerTaxIDCountryBh, InvoiceCustomerTaxIDCountryBo, InvoiceCustomerTaxIDCountryBr, InvoiceCustomerTaxIDCountryCa, InvoiceCustomerTaxIDCountryCh, InvoiceCustomerTaxIDCountryCl, InvoiceCustomerTaxIDCountryCn, InvoiceCustomerTaxIDCountryCo, InvoiceCustomerTaxIDCountryCr, InvoiceCustomerTaxIDCountryCy, InvoiceCustomerTaxIDCountryCz, InvoiceCustomerTaxIDCountryDe, InvoiceCustomerTaxIDCountryDk, InvoiceCustomerTaxIDCountryEe, InvoiceCustomerTaxIDCountryDo, InvoiceCustomerTaxIDCountryEc, InvoiceCustomerTaxIDCountryEg, InvoiceCustomerTaxIDCountryEs, InvoiceCustomerTaxIDCountryEu, InvoiceCustomerTaxIDCountryFi, InvoiceCustomerTaxIDCountryFr, InvoiceCustomerTaxIDCountryGB, InvoiceCustomerTaxIDCountryGe, InvoiceCustomerTaxIDCountryGr, InvoiceCustomerTaxIDCountryHk, InvoiceCustomerTaxIDCountryHr, InvoiceCustomerTaxIDCountryHu, InvoiceCustomerTaxIDCountryID, InvoiceCustomerTaxIDCountryIe, InvoiceCustomerTaxIDCountryIl, InvoiceCustomerTaxIDCountryIn, InvoiceCustomerTaxIDCountryIs, InvoiceCustomerTaxIDCountryIt, InvoiceCustomerTaxIDCountryJp, InvoiceCustomerTaxIDCountryKe, InvoiceCustomerTaxIDCountryKr, InvoiceCustomerTaxIDCountryKz, InvoiceCustomerTaxIDCountryLi, InvoiceCustomerTaxIDCountryLt, InvoiceCustomerTaxIDCountryLu, InvoiceCustomerTaxIDCountryLv, InvoiceCustomerTaxIDCountryMt, InvoiceCustomerTaxIDCountryMx, InvoiceCustomerTaxIDCountryMy, InvoiceCustomerTaxIDCountryNg, InvoiceCustomerTaxIDCountryNl, InvoiceCustomerTaxIDCountryNo, InvoiceCustomerTaxIDCountryNz, InvoiceCustomerTaxIDCountryOm, InvoiceCustomerTaxIDCountryPe, InvoiceCustomerTaxIDCountryPh, InvoiceCustomerTaxIDCountryPl, InvoiceCustomerTaxIDCountryPt, InvoiceCustomerTaxIDCountryRo, InvoiceCustomerTaxIDCountryRs, InvoiceCustomerTaxIDCountryRu, InvoiceCustomerTaxIDCountrySa, InvoiceCustomerTaxIDCountrySe, InvoiceCustomerTaxIDCountrySg, InvoiceCustomerTaxIDCountrySi, InvoiceCustomerTaxIDCountrySk, InvoiceCustomerTaxIDCountrySv, InvoiceCustomerTaxIDCountryTh, InvoiceCustomerTaxIDCountryTr, InvoiceCustomerTaxIDCountryTw, InvoiceCustomerTaxIDCountryUa, InvoiceCustomerTaxIDCountryUs, InvoiceCustomerTaxIDCountryUy, InvoiceCustomerTaxIDCountryVe, InvoiceCustomerTaxIDCountryVn, InvoiceCustomerTaxIDCountryZa:
return true
}
return false
}
type InvoiceCustomerTaxIDType string
const (
InvoiceCustomerTaxIDTypeAdNrt InvoiceCustomerTaxIDType = "ad_nrt"
InvoiceCustomerTaxIDTypeAeTrn InvoiceCustomerTaxIDType = "ae_trn"
InvoiceCustomerTaxIDTypeArCuit InvoiceCustomerTaxIDType = "ar_cuit"
InvoiceCustomerTaxIDTypeEuVat InvoiceCustomerTaxIDType = "eu_vat"
InvoiceCustomerTaxIDTypeAuAbn InvoiceCustomerTaxIDType = "au_abn"
InvoiceCustomerTaxIDTypeAuArn InvoiceCustomerTaxIDType = "au_arn"
InvoiceCustomerTaxIDTypeBgUic InvoiceCustomerTaxIDType = "bg_uic"
InvoiceCustomerTaxIDTypeBhVat InvoiceCustomerTaxIDType = "bh_vat"
InvoiceCustomerTaxIDTypeBoTin InvoiceCustomerTaxIDType = "bo_tin"
InvoiceCustomerTaxIDTypeBrCnpj InvoiceCustomerTaxIDType = "br_cnpj"
InvoiceCustomerTaxIDTypeBrCpf InvoiceCustomerTaxIDType = "br_cpf"
InvoiceCustomerTaxIDTypeCaBn InvoiceCustomerTaxIDType = "ca_bn"
InvoiceCustomerTaxIDTypeCaGstHst InvoiceCustomerTaxIDType = "ca_gst_hst"
InvoiceCustomerTaxIDTypeCaPstBc InvoiceCustomerTaxIDType = "ca_pst_bc"
InvoiceCustomerTaxIDTypeCaPstMB InvoiceCustomerTaxIDType = "ca_pst_mb"
InvoiceCustomerTaxIDTypeCaPstSk InvoiceCustomerTaxIDType = "ca_pst_sk"
InvoiceCustomerTaxIDTypeCaQst InvoiceCustomerTaxIDType = "ca_qst"
InvoiceCustomerTaxIDTypeChVat InvoiceCustomerTaxIDType = "ch_vat"
InvoiceCustomerTaxIDTypeClTin InvoiceCustomerTaxIDType = "cl_tin"
InvoiceCustomerTaxIDTypeCnTin InvoiceCustomerTaxIDType = "cn_tin"
InvoiceCustomerTaxIDTypeCoNit InvoiceCustomerTaxIDType = "co_nit"
InvoiceCustomerTaxIDTypeCrTin InvoiceCustomerTaxIDType = "cr_tin"
InvoiceCustomerTaxIDTypeDoRcn InvoiceCustomerTaxIDType = "do_rcn"
InvoiceCustomerTaxIDTypeEcRuc InvoiceCustomerTaxIDType = "ec_ruc"
InvoiceCustomerTaxIDTypeEgTin InvoiceCustomerTaxIDType = "eg_tin"
InvoiceCustomerTaxIDTypeEsCif InvoiceCustomerTaxIDType = "es_cif"
InvoiceCustomerTaxIDTypeEuOssVat InvoiceCustomerTaxIDType = "eu_oss_vat"
InvoiceCustomerTaxIDTypeGBVat InvoiceCustomerTaxIDType = "gb_vat"
InvoiceCustomerTaxIDTypeGeVat InvoiceCustomerTaxIDType = "ge_vat"
InvoiceCustomerTaxIDTypeHkBr InvoiceCustomerTaxIDType = "hk_br"
InvoiceCustomerTaxIDTypeHuTin InvoiceCustomerTaxIDType = "hu_tin"
InvoiceCustomerTaxIDTypeIDNpwp InvoiceCustomerTaxIDType = "id_npwp"
InvoiceCustomerTaxIDTypeIlVat InvoiceCustomerTaxIDType = "il_vat"
InvoiceCustomerTaxIDTypeInGst InvoiceCustomerTaxIDType = "in_gst"
InvoiceCustomerTaxIDTypeIsVat InvoiceCustomerTaxIDType = "is_vat"
InvoiceCustomerTaxIDTypeJpCn InvoiceCustomerTaxIDType = "jp_cn"
InvoiceCustomerTaxIDTypeJpRn InvoiceCustomerTaxIDType = "jp_rn"
InvoiceCustomerTaxIDTypeJpTrn InvoiceCustomerTaxIDType = "jp_trn"
InvoiceCustomerTaxIDTypeKePin InvoiceCustomerTaxIDType = "ke_pin"
InvoiceCustomerTaxIDTypeKrBrn InvoiceCustomerTaxIDType = "kr_brn"
InvoiceCustomerTaxIDTypeKzBin InvoiceCustomerTaxIDType = "kz_bin"
InvoiceCustomerTaxIDTypeLiUid InvoiceCustomerTaxIDType = "li_uid"
InvoiceCustomerTaxIDTypeMxRfc InvoiceCustomerTaxIDType = "mx_rfc"
InvoiceCustomerTaxIDTypeMyFrp InvoiceCustomerTaxIDType = "my_frp"
InvoiceCustomerTaxIDTypeMyItn InvoiceCustomerTaxIDType = "my_itn"
InvoiceCustomerTaxIDTypeMySst InvoiceCustomerTaxIDType = "my_sst"
InvoiceCustomerTaxIDTypeNgTin InvoiceCustomerTaxIDType = "ng_tin"
InvoiceCustomerTaxIDTypeNoVat InvoiceCustomerTaxIDType = "no_vat"
InvoiceCustomerTaxIDTypeNoVoec InvoiceCustomerTaxIDType = "no_voec"
InvoiceCustomerTaxIDTypeNzGst InvoiceCustomerTaxIDType = "nz_gst"
InvoiceCustomerTaxIDTypeOmVat InvoiceCustomerTaxIDType = "om_vat"
InvoiceCustomerTaxIDTypePeRuc InvoiceCustomerTaxIDType = "pe_ruc"
InvoiceCustomerTaxIDTypePhTin InvoiceCustomerTaxIDType = "ph_tin"
InvoiceCustomerTaxIDTypeRoTin InvoiceCustomerTaxIDType = "ro_tin"
InvoiceCustomerTaxIDTypeRsPib InvoiceCustomerTaxIDType = "rs_pib"
InvoiceCustomerTaxIDTypeRuInn InvoiceCustomerTaxIDType = "ru_inn"
InvoiceCustomerTaxIDTypeRuKpp InvoiceCustomerTaxIDType = "ru_kpp"
InvoiceCustomerTaxIDTypeSaVat InvoiceCustomerTaxIDType = "sa_vat"
InvoiceCustomerTaxIDTypeSgGst InvoiceCustomerTaxIDType = "sg_gst"
InvoiceCustomerTaxIDTypeSgUen InvoiceCustomerTaxIDType = "sg_uen"
InvoiceCustomerTaxIDTypeSiTin InvoiceCustomerTaxIDType = "si_tin"
InvoiceCustomerTaxIDTypeSvNit InvoiceCustomerTaxIDType = "sv_nit"
InvoiceCustomerTaxIDTypeThVat InvoiceCustomerTaxIDType = "th_vat"
InvoiceCustomerTaxIDTypeTrTin InvoiceCustomerTaxIDType = "tr_tin"
InvoiceCustomerTaxIDTypeTwVat InvoiceCustomerTaxIDType = "tw_vat"
InvoiceCustomerTaxIDTypeUaVat InvoiceCustomerTaxIDType = "ua_vat"
InvoiceCustomerTaxIDTypeUsEin InvoiceCustomerTaxIDType = "us_ein"
InvoiceCustomerTaxIDTypeUyRuc InvoiceCustomerTaxIDType = "uy_ruc"
InvoiceCustomerTaxIDTypeVeRif InvoiceCustomerTaxIDType = "ve_rif"
InvoiceCustomerTaxIDTypeVnTin InvoiceCustomerTaxIDType = "vn_tin"
InvoiceCustomerTaxIDTypeZaVat InvoiceCustomerTaxIDType = "za_vat"
)
func (r InvoiceCustomerTaxIDType) IsKnown() bool {
switch r {
case InvoiceCustomerTaxIDTypeAdNrt, InvoiceCustomerTaxIDTypeAeTrn, InvoiceCustomerTaxIDTypeArCuit, InvoiceCustomerTaxIDTypeEuVat, InvoiceCustomerTaxIDTypeAuAbn, InvoiceCustomerTaxIDTypeAuArn, InvoiceCustomerTaxIDTypeBgUic, InvoiceCustomerTaxIDTypeBhVat, InvoiceCustomerTaxIDTypeBoTin, InvoiceCustomerTaxIDTypeBrCnpj, InvoiceCustomerTaxIDTypeBrCpf, InvoiceCustomerTaxIDTypeCaBn, InvoiceCustomerTaxIDTypeCaGstHst, InvoiceCustomerTaxIDTypeCaPstBc, InvoiceCustomerTaxIDTypeCaPstMB, InvoiceCustomerTaxIDTypeCaPstSk, InvoiceCustomerTaxIDTypeCaQst, InvoiceCustomerTaxIDTypeChVat, InvoiceCustomerTaxIDTypeClTin, InvoiceCustomerTaxIDTypeCnTin, InvoiceCustomerTaxIDTypeCoNit, InvoiceCustomerTaxIDTypeCrTin, InvoiceCustomerTaxIDTypeDoRcn, InvoiceCustomerTaxIDTypeEcRuc, InvoiceCustomerTaxIDTypeEgTin, InvoiceCustomerTaxIDTypeEsCif, InvoiceCustomerTaxIDTypeEuOssVat, InvoiceCustomerTaxIDTypeGBVat, InvoiceCustomerTaxIDTypeGeVat, InvoiceCustomerTaxIDTypeHkBr, InvoiceCustomerTaxIDTypeHuTin, InvoiceCustomerTaxIDTypeIDNpwp, InvoiceCustomerTaxIDTypeIlVat, InvoiceCustomerTaxIDTypeInGst, InvoiceCustomerTaxIDTypeIsVat, InvoiceCustomerTaxIDTypeJpCn, InvoiceCustomerTaxIDTypeJpRn, InvoiceCustomerTaxIDTypeJpTrn, InvoiceCustomerTaxIDTypeKePin, InvoiceCustomerTaxIDTypeKrBrn, InvoiceCustomerTaxIDTypeKzBin, InvoiceCustomerTaxIDTypeLiUid, InvoiceCustomerTaxIDTypeMxRfc, InvoiceCustomerTaxIDTypeMyFrp, InvoiceCustomerTaxIDTypeMyItn, InvoiceCustomerTaxIDTypeMySst, InvoiceCustomerTaxIDTypeNgTin, InvoiceCustomerTaxIDTypeNoVat, InvoiceCustomerTaxIDTypeNoVoec, InvoiceCustomerTaxIDTypeNzGst, InvoiceCustomerTaxIDTypeOmVat, InvoiceCustomerTaxIDTypePeRuc, InvoiceCustomerTaxIDTypePhTin, InvoiceCustomerTaxIDTypeRoTin, InvoiceCustomerTaxIDTypeRsPib, InvoiceCustomerTaxIDTypeRuInn, InvoiceCustomerTaxIDTypeRuKpp, InvoiceCustomerTaxIDTypeSaVat, InvoiceCustomerTaxIDTypeSgGst, InvoiceCustomerTaxIDTypeSgUen, InvoiceCustomerTaxIDTypeSiTin, InvoiceCustomerTaxIDTypeSvNit, InvoiceCustomerTaxIDTypeThVat, InvoiceCustomerTaxIDTypeTrTin, InvoiceCustomerTaxIDTypeTwVat, InvoiceCustomerTaxIDTypeUaVat, InvoiceCustomerTaxIDTypeUsEin, InvoiceCustomerTaxIDTypeUyRuc, InvoiceCustomerTaxIDTypeVeRif, InvoiceCustomerTaxIDTypeVnTin, InvoiceCustomerTaxIDTypeZaVat:
return true
}
return false
}
type InvoiceInvoiceSource string
const (
InvoiceInvoiceSourceSubscription InvoiceInvoiceSource = "subscription"
InvoiceInvoiceSourcePartial InvoiceInvoiceSource = "partial"
InvoiceInvoiceSourceOneOff InvoiceInvoiceSource = "one_off"
)
func (r InvoiceInvoiceSource) IsKnown() bool {
switch r {
case InvoiceInvoiceSourceSubscription, InvoiceInvoiceSourcePartial, InvoiceInvoiceSourceOneOff:
return true
}
return false
}
type InvoiceLineItem struct {
// A unique ID for this line item.
ID string `json:"id,required"`
// The final amount after any discounts or minimums.
Amount string `json:"amount,required"`
Discount shared.Discount `json:"discount,required,nullable"`
// The end date of the range of time applied for this line item's price.
EndDate time.Time `json:"end_date,required" format:"date-time"`
// [DEPRECATED] For configured prices that are split by a grouping key, this will
// be populated with the key and a value. The `amount` and `subtotal` will be the
// values for this particular grouping.
Grouping string `json:"grouping,required,nullable"`
Maximum InvoiceLineItemsMaximum `json:"maximum,required,nullable"`
MaximumAmount string `json:"maximum_amount,required,nullable"`
Minimum InvoiceLineItemsMinimum `json:"minimum,required,nullable"`
MinimumAmount string `json:"minimum_amount,required,nullable"`
// The name of the price associated with this line item.