recurly 4.52.0 → 4.53.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.bumpversion.cfg +1 -1
- data/CHANGELOG.md +11 -0
- data/GETTING_STARTED.md +1 -1
- data/lib/recurly/client/operations.rb +106 -4
- data/lib/recurly/requests/add_on_create.rb +14 -2
- data/lib/recurly/requests/add_on_update.rb +13 -1
- data/lib/recurly/requests/general_ledger_account_create.rb +22 -0
- data/lib/recurly/requests/general_ledger_account_update.rb +18 -0
- data/lib/recurly/requests/item_create.rb +12 -0
- data/lib/recurly/requests/item_update.rb +12 -0
- data/lib/recurly/requests/line_item_create.rb +20 -0
- data/lib/recurly/requests/plan_create.rb +24 -0
- data/lib/recurly/requests/plan_update.rb +24 -0
- data/lib/recurly/requests/shipping_method_create.rb +12 -0
- data/lib/recurly/requests/shipping_method_update.rb +12 -0
- data/lib/recurly/resources/add_on.rb +12 -0
- data/lib/recurly/resources/business_entity.rb +16 -0
- data/lib/recurly/resources/external_payment_phase.rb +0 -4
- data/lib/recurly/resources/external_subscription.rb +8 -0
- data/lib/recurly/resources/general_ledger_account.rb +38 -0
- data/lib/recurly/resources/gift_card.rb +12 -0
- data/lib/recurly/resources/item.rb +12 -0
- data/lib/recurly/resources/line_item.rb +20 -0
- data/lib/recurly/resources/performance_obligation.rb +26 -0
- data/lib/recurly/resources/shipping_method.rb +12 -0
- data/lib/recurly/version.rb +1 -1
- data/openapi/api.yaml +861 -10
- metadata +7 -3
data/openapi/api.yaml
CHANGED
@@ -230,6 +230,8 @@ x-tagGroups:
|
|
230
230
|
- shipping_method
|
231
231
|
- dunning_campaigns
|
232
232
|
- business_entities
|
233
|
+
- general_ledger_account
|
234
|
+
- performance_obligations
|
233
235
|
tags:
|
234
236
|
- name: site
|
235
237
|
x-displayName: Site
|
@@ -242,7 +244,7 @@ tags:
|
|
242
244
|
description: |-
|
243
245
|
For merchants who sell the same things to many customers, documenting those offerings in a catalog allows for faster charge creation, easier management of offerings, and analytics about your offerings across all sales channels. Because your offerings can be physical, digital, or service-oriented, Recurly collectively calls these offerings "Items".
|
244
246
|
|
245
|
-
Recurly's item catalog requires the Credit Invoices
|
247
|
+
Recurly's item catalog requires the Credit Invoices feature to be enabled.
|
246
248
|
- name: plan
|
247
249
|
x-displayName: Plan
|
248
250
|
description: A plan tells Recurly how often and how much to charge your customers.
|
@@ -385,6 +387,55 @@ tags:
|
|
385
387
|
x-displayName: Business Entities
|
386
388
|
description: Describes the business address that will be used for invoices and taxes
|
387
389
|
depending on settings and subscriber location.
|
390
|
+
- name: general_ledger_account
|
391
|
+
x-displayName: General Ledger Account
|
392
|
+
description: |
|
393
|
+
A general ledger account is an account of record used to sort, store
|
394
|
+
and summarize a company's transactions. Recurly supports the balance
|
395
|
+
sheet (Liability) account and income (Revenue) account to be attached
|
396
|
+
to business entities, plans, or at the item level.
|
397
|
+
|
398
|
+
When invoices are created, system can default to the accounts based
|
399
|
+
on the GL Accounts attached at the plan/item level. The accounts can
|
400
|
+
be defaulted from the business entity level as well.
|
401
|
+
|
402
|
+
These accounts will be used in the Revenue Recognition module to create
|
403
|
+
the revenue journals that can be posted into Merchant GL system.
|
404
|
+
|
405
|
+
Revenue and Liability accounts can defined in the system using this
|
406
|
+
API or via the General Ledger Accounting page in the Admin UI and then
|
407
|
+
used at the plan/item level.
|
408
|
+
|
409
|
+
Recurly allows merchants to default the accounts at the following levels:
|
410
|
+
- Business Entities (default)
|
411
|
+
- Plans
|
412
|
+
- Base Price
|
413
|
+
- Setup Fee
|
414
|
+
- Add-ons
|
415
|
+
- Items
|
416
|
+
- Charges
|
417
|
+
- Gift Cards
|
418
|
+
- Shipping Methods
|
419
|
+
- Credits
|
420
|
+
|
421
|
+
If you are interested in Recurly Revenue Recognition features, please
|
422
|
+
contact a Recurly customer service representative.
|
423
|
+
- name: performance_obligations
|
424
|
+
x-displayName: Performance Obligations
|
425
|
+
description: |
|
426
|
+
A performance obligation is a promise to provide a distinct good or
|
427
|
+
service or a series of distinct goods or services as defined by the revenue standard.
|
428
|
+
Performance obligations are completed and revenue is recognized either at a point in
|
429
|
+
time or over a period of time, depending on the type of obligation.
|
430
|
+
- Point in time a company has to go through the criteria and determine if a performance
|
431
|
+
obligation is satisfied over time. If it does not meet those criteria, then the performance
|
432
|
+
obligation is satisfied and revenue recognized at the point in time when control of the good
|
433
|
+
or service is transferred to the customer.
|
434
|
+
- Over a period of time a performance obligation is satisfied and revenue is recognized over
|
435
|
+
time if at least one of the following are met:
|
436
|
+
- The customer receives and consumes the benefits of the goods or services as they are provided
|
437
|
+
by the entity (routine, recurring services like a cleaning service are an example of a series of
|
438
|
+
services that are substantially the same and have the same pattern of transfer)
|
388
439
|
paths:
|
389
440
|
"/sites":
|
390
441
|
get:
|
@@ -6566,7 +6617,7 @@ paths:
|
|
6566
6617
|
- "$ref": "#/components/parameters/custom_field_definition_id"
|
6567
6618
|
responses:
|
6568
6619
|
'200':
|
6569
|
-
description:
|
6620
|
+
description: A custom field definition.
|
6570
6621
|
content:
|
6571
6622
|
application/json:
|
6572
6623
|
schema:
|
@@ -6672,6 +6723,150 @@ paths:
|
|
6672
6723
|
{\n\t\tfmt.Printf(\"Resource not found: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
|
6673
6724
|
Recurly error: %v\", e)\n\treturn nil, err\n}\nfmt.Printf(\"Fetched Custom
|
6674
6725
|
Field Definition: %s\", definition.Id)"
|
6726
|
+
"/general_ledger_accounts":
|
6727
|
+
post:
|
6728
|
+
tags:
|
6729
|
+
- general_ledger_account
|
6730
|
+
operationId: create_general_ledger_account
|
6731
|
+
summary: Create a new general ledger account
|
6732
|
+
requestBody:
|
6733
|
+
content:
|
6734
|
+
application/json:
|
6735
|
+
schema:
|
6736
|
+
"$ref": "#/components/schemas/GeneralLedgerAccountCreate"
|
6737
|
+
required: true
|
6738
|
+
responses:
|
6739
|
+
'201':
|
6740
|
+
description: A new general ledger account.
|
6741
|
+
content:
|
6742
|
+
application/json:
|
6743
|
+
schema:
|
6744
|
+
"$ref": "#/components/schemas/GeneralLedgerAccount"
|
6745
|
+
default:
|
6746
|
+
description: Unexpected error.
|
6747
|
+
content:
|
6748
|
+
application/json:
|
6749
|
+
schema:
|
6750
|
+
"$ref": "#/components/schemas/Error"
|
6751
|
+
x-code-samples: []
|
6752
|
+
get:
|
6753
|
+
tags:
|
6754
|
+
- general_ledger_account
|
6755
|
+
operationId: list_general_ledger_accounts
|
6756
|
+
summary: List a site's general ledger accounts
|
6757
|
+
description: See the [Pagination Guide](/developers/guides/pagination.html)
|
6758
|
+
to learn how to use pagination in the API and Client Libraries.
|
6759
|
+
parameters:
|
6760
|
+
- "$ref": "#/components/parameters/ids"
|
6761
|
+
- "$ref": "#/components/parameters/limit"
|
6762
|
+
- "$ref": "#/components/parameters/order"
|
6763
|
+
- "$ref": "#/components/parameters/sort_dates"
|
6764
|
+
- "$ref": "#/components/parameters/general_ledger_account_type_enum"
|
6765
|
+
responses:
|
6766
|
+
'200':
|
6767
|
+
description: A list of the site's general ledger accounts.
|
6768
|
+
content:
|
6769
|
+
application/json:
|
6770
|
+
schema:
|
6771
|
+
"$ref": "#/components/schemas/GeneralLedgerAccountList"
|
6772
|
+
'404':
|
6773
|
+
description: Incorrect site ID.
|
6774
|
+
content:
|
6775
|
+
application/json:
|
6776
|
+
schema:
|
6777
|
+
"$ref": "#/components/schemas/Error"
|
6778
|
+
x-code-samples: []
|
6779
|
+
"/general_ledger_accounts/{general_ledger_account_id}":
|
6780
|
+
get:
|
6781
|
+
tags:
|
6782
|
+
- general_ledger_account
|
6783
|
+
operationId: get_general_ledger_account
|
6784
|
+
summary: Fetch a general ledger account
|
6785
|
+
parameters:
|
6786
|
+
- "$ref": "#/components/parameters/general_ledger_account_id"
|
6787
|
+
responses:
|
6788
|
+
'200':
|
6789
|
+
description: A general ledger account.
|
6790
|
+
content:
|
6791
|
+
application/json:
|
6792
|
+
schema:
|
6793
|
+
"$ref": "#/components/schemas/GeneralLedgerAccount"
|
6794
|
+
'404':
|
6795
|
+
description: Incorrect site or general ledger account ID.
|
6796
|
+
content:
|
6797
|
+
application/json:
|
6798
|
+
schema:
|
6799
|
+
"$ref": "#/components/schemas/Error"
|
6800
|
+
x-code-samples: []
|
6801
|
+
put:
|
6802
|
+
tags:
|
6803
|
+
- general_ledger_account
|
6804
|
+
operationId: update_general_ledger_account
|
6805
|
+
summary: Update a general ledger account
|
6806
|
+
parameters:
|
6807
|
+
- "$ref": "#/components/parameters/general_ledger_account_id"
|
6808
|
+
requestBody:
|
6809
|
+
content:
|
6810
|
+
application/json:
|
6811
|
+
schema:
|
6812
|
+
"$ref": "#/components/schemas/GeneralLedgerAccountUpdate"
|
6813
|
+
required: true
|
6814
|
+
responses:
|
6815
|
+
'200':
|
6816
|
+
description: The updated general ledger account.
|
6817
|
+
content:
|
6818
|
+
application/json:
|
6819
|
+
schema:
|
6820
|
+
"$ref": "#/components/schemas/GeneralLedgerAccount"
|
6821
|
+
'404':
|
6822
|
+
description: Incorrect site or general ledger account ID.
|
6823
|
+
content:
|
6824
|
+
application/json:
|
6825
|
+
schema:
|
6826
|
+
"$ref": "#/components/schemas/Error"
|
6827
|
+
x-code-samples: []
|
6828
|
+
"/performance_obligations/{performance_obligation_id}":
|
6829
|
+
get:
|
6830
|
+
tags:
|
6831
|
+
- performance_obligations
|
6832
|
+
operationId: get_performance_obligation
|
6833
|
+
summary: Get a single Performance Obligation.
|
6834
|
+
parameters:
|
6835
|
+
- "$ref": "#/components/parameters/performance_obligation_id"
|
6836
|
+
responses:
|
6837
|
+
'200':
|
6838
|
+
description: A single Performance Obligation.
|
6839
|
+
content:
|
6840
|
+
application/json:
|
6841
|
+
schema:
|
6842
|
+
"$ref": "#/components/schemas/PerformanceObligation"
|
6843
|
+
default:
|
6844
|
+
description: Unexpected error.
|
6845
|
+
content:
|
6846
|
+
application/json:
|
6847
|
+
schema:
|
6848
|
+
"$ref": "#/components/schemas/Error"
|
6849
|
+
x-code-samples: []
|
6850
|
+
"/performance_obligations":
|
6851
|
+
get:
|
6852
|
+
tags:
|
6853
|
+
- performance_obligations
|
6854
|
+
operationId: get_performance_obligations
|
6855
|
+
summary: Get a site's Performance Obligations
|
6856
|
+
responses:
|
6857
|
+
'200':
|
6858
|
+
description: A list of Performance Obligations.
|
6859
|
+
content:
|
6860
|
+
application/json:
|
6861
|
+
schema:
|
6862
|
+
"$ref": "#/components/schemas/PerformanceObligationList"
|
6863
|
+
default:
|
6864
|
+
description: Unexpected error.
|
6865
|
+
content:
|
6866
|
+
application/json:
|
6867
|
+
schema:
|
6868
|
+
"$ref": "#/components/schemas/Error"
|
6869
|
+
x-code-samples: []
|
6675
6870
|
"/invoice_templates/{invoice_template_id}/accounts":
|
6676
6871
|
get:
|
6677
6872
|
tags:
|
@@ -8034,7 +8229,7 @@ paths:
|
|
8034
8229
|
x-code-samples: []
|
8035
8230
|
"/external_subscriptions/{external_subscription_id}":
|
8036
8231
|
parameters:
|
8037
|
-
- "$ref": "#/components/parameters/
|
8232
|
+
- "$ref": "#/components/parameters/external_subscription_id_fetch"
|
8038
8233
|
get:
|
8039
8234
|
tags:
|
8040
8235
|
- external_subscriptions
|
@@ -16093,10 +16288,10 @@ paths:
|
|
16093
16288
|
tags:
|
16094
16289
|
- external_payment_phases
|
16095
16290
|
operationId: get_external_subscription_external_payment_phase
|
16096
|
-
summary: Fetch an external
|
16291
|
+
summary: Fetch an external payment phase
|
16097
16292
|
responses:
|
16098
16293
|
'200':
|
16099
|
-
description: Details for an external
|
16294
|
+
description: Details for an external payment phase.
|
16100
16295
|
content:
|
16101
16296
|
application/json:
|
16102
16297
|
schema:
|
@@ -16545,6 +16740,14 @@ components:
|
|
16545
16740
|
required: true
|
16546
16741
|
schema:
|
16547
16742
|
type: string
|
16743
|
+
external_subscription_id_fetch:
|
16744
|
+
name: external_subscription_id
|
16745
|
+
in: path
|
16746
|
+
description: External subscription ID or external_id. For ID no prefix is used
|
16747
|
+
e.g. `e28zov4fw0v2`. For external_id use prefix `external-id-`, e.g. `external-id-123456`.
|
16748
|
+
required: true
|
16749
|
+
schema:
|
16750
|
+
type: string
|
16548
16751
|
external_subscription_id:
|
16549
16752
|
name: external_subscription_id
|
16550
16753
|
in: path
|
@@ -16559,6 +16762,25 @@ components:
|
|
16559
16762
|
required: true
|
16560
16763
|
schema:
|
16561
16764
|
type: string
|
16765
|
+
general_ledger_account_id:
|
16766
|
+
name: general_ledger_account_id
|
16767
|
+
in: path
|
16768
|
+
description: General Ledger Account ID
|
16769
|
+
required: true
|
16770
|
+
schema:
|
16771
|
+
type: string
|
16772
|
+
title: General Ledger Account ID
|
16773
|
+
description: |
|
16774
|
+
The ID of a general ledger account. General ledger accounts are
|
16775
|
+
only accessible as a part of the Recurly RevRec Standard and
|
16776
|
+
Recurly RevRec Advanced features.
|
16777
|
+
maxLength: 13
|
16778
|
+
general_ledger_account_type_enum:
|
16779
|
+
name: account_type
|
16780
|
+
in: query
|
16781
|
+
description: General Ledger Account type by which to filter the response.
|
16782
|
+
schema:
|
16783
|
+
"$ref": "#/components/schemas/GeneralLedgerAccountTypeEnum"
|
16562
16784
|
invoice_template_id:
|
16563
16785
|
name: invoice_template_id
|
16564
16786
|
in: path
|
@@ -16604,6 +16826,19 @@ components:
|
|
16604
16826
|
required: true
|
16605
16827
|
schema:
|
16606
16828
|
type: string
|
16829
|
+
performance_obligation_id:
|
16830
|
+
name: performance_obligation_id
|
16831
|
+
in: path
|
16832
|
+
description: Performance Obligation id.
|
16833
|
+
required: true
|
16834
|
+
schema:
|
16835
|
+
type: string
|
16836
|
+
title: Performance Obligation ID
|
16837
|
+
description: |
|
16838
|
+
The ID of a performance obligation. Performance obligations are
|
16839
|
+
only accessible as a part of the Recurly RevRec Standard and
|
16840
|
+
Recurly RevRec Advanced features.
|
16841
|
+
maxLength: 13
|
16607
16842
|
plan_id:
|
16608
16843
|
name: plan_id
|
16609
16844
|
in: path
|
@@ -17858,6 +18093,30 @@ components:
|
|
17858
18093
|
description: System-generated unique identifier for an measured unit associated
|
17859
18094
|
with the add-on.
|
17860
18095
|
maxLength: 13
|
18096
|
+
liability_gl_account_id:
|
18097
|
+
type: string
|
18098
|
+
title: General Ledger Account ID
|
18099
|
+
description: |
|
18100
|
+
The ID of a general ledger account. General ledger accounts are
|
18101
|
+
only accessible as a part of the Recurly RevRec Standard and
|
18102
|
+
Recurly RevRec Advanced features.
|
18103
|
+
maxLength: 13
|
18104
|
+
revenue_gl_account_id:
|
18105
|
+
type: string
|
18106
|
+
title: General Ledger Account ID
|
18107
|
+
description: |
|
18108
|
+
The ID of a general ledger account. General ledger accounts are
|
18109
|
+
only accessible as a part of the Recurly RevRec Standard and
|
18110
|
+
Recurly RevRec Advanced features.
|
18111
|
+
maxLength: 13
|
18112
|
+
performance_obligation_id:
|
18113
|
+
type: string
|
18114
|
+
title: Performance Obligation ID
|
18115
|
+
description: |
|
18116
|
+
The ID of a performance obligation. Performance obligations are
|
18117
|
+
only accessible as a part of the Recurly RevRec Standard and
|
18118
|
+
Recurly RevRec Advanced features.
|
18119
|
+
maxLength: 13
|
17861
18120
|
accounting_code:
|
17862
18121
|
type: string
|
17863
18122
|
title: Accounting code
|
@@ -17972,7 +18231,7 @@ components:
|
|
17972
18231
|
type: string
|
17973
18232
|
title: Item Code
|
17974
18233
|
description: Unique code to identify an item. Available when the `Credit
|
17975
|
-
Invoices` feature
|
18234
|
+
Invoices` feature is enabled. If `item_id` and `item_code` are both present,
|
17976
18235
|
`item_id` will be used.
|
17977
18236
|
pattern: "/^[a-z0-9_+-]+$/"
|
17978
18237
|
maxLength: 50
|
@@ -18031,6 +18290,30 @@ components:
|
|
18031
18290
|
title: Plan ID
|
18032
18291
|
maxLength: 13
|
18033
18292
|
readOnly: true
|
18293
|
+
liability_gl_account_id:
|
18294
|
+
type: string
|
18295
|
+
title: General Ledger Account ID
|
18296
|
+
description: |
|
18297
|
+
The ID of a general ledger account. General ledger accounts are
|
18298
|
+
only accessible as a part of the Recurly RevRec Standard and
|
18299
|
+
Recurly RevRec Advanced features.
|
18300
|
+
maxLength: 13
|
18301
|
+
revenue_gl_account_id:
|
18302
|
+
type: string
|
18303
|
+
title: General Ledger Account ID
|
18304
|
+
description: |
|
18305
|
+
The ID of a general ledger account. General ledger accounts are
|
18306
|
+
only accessible as a part of the Recurly RevRec Standard and
|
18307
|
+
Recurly RevRec Advanced features.
|
18308
|
+
maxLength: 13
|
18309
|
+
performance_obligation_id:
|
18310
|
+
type: string
|
18311
|
+
title: Performance Obligation ID
|
18312
|
+
description: |
|
18313
|
+
The ID of a performance obligation. Performance obligations are
|
18314
|
+
only accessible as a part of the Recurly RevRec Standard and
|
18315
|
+
Recurly RevRec Advanced features.
|
18316
|
+
maxLength: 13
|
18034
18317
|
accounting_code:
|
18035
18318
|
type: string
|
18036
18319
|
title: Accounting code
|
@@ -18100,7 +18383,7 @@ components:
|
|
18100
18383
|
minItems: 1
|
18101
18384
|
description: |
|
18102
18385
|
* If `item_code`/`item_id` is part of the request and the item
|
18103
|
-
has a default currency then `currencies` is optional. If the item does
|
18386
|
+
has a default currency, then `currencies` is optional. If the item does
|
18104
18387
|
not have a default currency, then `currencies` is required. If `item_code`/`item_id`
|
18105
18388
|
is not present `currencies` is required.
|
18106
18389
|
* If the add-on's `tier_type` is `tiered`, `volume`, or `stairstep`,
|
@@ -18189,6 +18472,30 @@ components:
|
|
18189
18472
|
to the `AddOn` then `accounting code` must be absent.
|
18190
18473
|
pattern: "/^[a-z0-9_+-]+$/"
|
18191
18474
|
maxLength: 20
|
18475
|
+
liability_gl_account_id:
|
18476
|
+
type: string
|
18477
|
+
title: General Ledger Account ID
|
18478
|
+
description: |
|
18479
|
+
The ID of a general ledger account. General ledger accounts are
|
18480
|
+
only accessible as a part of the Recurly RevRec Standard and
|
18481
|
+
Recurly RevRec Advanced features.
|
18482
|
+
maxLength: 13
|
18483
|
+
revenue_gl_account_id:
|
18484
|
+
type: string
|
18485
|
+
title: General Ledger Account ID
|
18486
|
+
description: |
|
18487
|
+
The ID of a general ledger account. General ledger accounts are
|
18488
|
+
only accessible as a part of the Recurly RevRec Standard and
|
18489
|
+
Recurly RevRec Advanced features.
|
18490
|
+
maxLength: 13
|
18491
|
+
performance_obligation_id:
|
18492
|
+
type: string
|
18493
|
+
title: Performance Obligation ID
|
18494
|
+
description: |
|
18495
|
+
The ID of a performance obligation. Performance obligations are
|
18496
|
+
only accessible as a part of the Recurly RevRec Standard and
|
18497
|
+
Recurly RevRec Advanced features.
|
18498
|
+
maxLength: 13
|
18192
18499
|
revenue_schedule_type:
|
18193
18500
|
title: Revenue schedule type
|
18194
18501
|
description: When this add-on is invoiced, the line item will use this revenue
|
@@ -18271,7 +18578,7 @@ components:
|
|
18271
18578
|
`percentage_tiers` is an array of objects, which must have the set of tiers
|
18272
18579
|
per currency and the currency code. The tier_type must be `volume` or `tiered`,
|
18273
18580
|
if not, it must be absent. There must be one tier without an `ending_amount` value
|
18274
|
-
which represents the final tier.
|
18581
|
+
which represents the final tier. This feature is currently in development and
|
18275
18582
|
requires approval and enablement, please contact support.
|
18276
18583
|
BillingInfo:
|
18277
18584
|
type: object
|
@@ -19210,6 +19517,171 @@ components:
|
|
19210
19517
|
are removed from the accouts or subscriptions, will be hard deleted an
|
19211
19518
|
no longer visible.
|
19212
19519
|
readOnly: true
|
19520
|
+
GeneralLedgerAccountId:
|
19521
|
+
type: string
|
19522
|
+
title: General Ledger Account ID
|
19523
|
+
description: |
|
19524
|
+
The ID of a general ledger account. General ledger accounts are
|
19525
|
+
only accessible as a part of the Recurly RevRec Standard and
|
19526
|
+
Recurly RevRec Advanced features.
|
19527
|
+
maxLength: 13
|
19528
|
+
GeneralLedgerAccountCode:
|
19529
|
+
type: string
|
19530
|
+
title: Accounting code for the ledger account.
|
19531
|
+
description: |
|
19532
|
+
Unique code to identify the ledger account. Each code must start
|
19533
|
+
with a letter or number. The following special characters are
|
19534
|
+
allowed: `-_.,:`
|
19535
|
+
pattern: "/^[A-Za-z0-9](( *)?[\\-A-Za-z0-9_.,:])*$/"
|
19536
|
+
maxLength: 255
|
19537
|
+
GeneralLedgerAccountDescription:
|
19538
|
+
type: string
|
19539
|
+
title: Description
|
19540
|
+
description: Optional description.
|
19541
|
+
maxLength: 255
|
19542
|
+
GeneralLedgerAccount:
|
19543
|
+
type: object
|
19544
|
+
description: Full general ledger account details.
|
19545
|
+
properties:
|
19546
|
+
id:
|
19547
|
+
type: string
|
19548
|
+
title: General Ledger Account ID
|
19549
|
+
description: |
|
19550
|
+
The ID of a general ledger account. General ledger accounts are
|
19551
|
+
only accessible as a part of the Recurly RevRec Standard and
|
19552
|
+
Recurly RevRec Advanced features.
|
19553
|
+
maxLength: 13
|
19554
|
+
object:
|
19555
|
+
type: string
|
19556
|
+
title: Object type
|
19557
|
+
default: general_ledger_account
|
19558
|
+
readOnly: true
|
19559
|
+
code:
|
19560
|
+
type: string
|
19561
|
+
title: Accounting code for the ledger account.
|
19562
|
+
description: |
|
19563
|
+
Unique code to identify the ledger account. Each code must start
|
19564
|
+
with a letter or number. The following special characters are
|
19565
|
+
allowed: `-_.,:`
|
19566
|
+
pattern: "/^[A-Za-z0-9](( *)?[\\-A-Za-z0-9_.,:])*$/"
|
19567
|
+
maxLength: 255
|
19568
|
+
description:
|
19569
|
+
type: string
|
19570
|
+
title: Description
|
19571
|
+
description: Optional description.
|
19572
|
+
maxLength: 255
|
19573
|
+
account_type:
|
19574
|
+
"$ref": "#/components/schemas/GeneralLedgerAccountTypeEnum"
|
19575
|
+
created_at:
|
19576
|
+
type: string
|
19577
|
+
format: date-time
|
19578
|
+
title: Created at
|
19579
|
+
readOnly: true
|
19580
|
+
updated_at:
|
19581
|
+
type: string
|
19582
|
+
format: date-time
|
19583
|
+
title: Last updated at
|
19584
|
+
readOnly: true
|
19585
|
+
GeneralLedgerAccountList:
|
19586
|
+
type: object
|
19587
|
+
properties:
|
19588
|
+
object:
|
19589
|
+
type: string
|
19590
|
+
title: Object type
|
19591
|
+
description: Will always be List.
|
19592
|
+
has_more:
|
19593
|
+
type: boolean
|
19594
|
+
description: Indicates there are more results on subsequent pages.
|
19595
|
+
next:
|
19596
|
+
type: string
|
19597
|
+
description: Path to subsequent page of results.
|
19598
|
+
data:
|
19599
|
+
type: array
|
19600
|
+
items:
|
19601
|
+
"$ref": "#/components/schemas/GeneralLedgerAccount"
|
19602
|
+
GeneralLedgerAccountCreate:
|
19603
|
+
type: object
|
19604
|
+
description: Create a new liability or revenue general ledger account.
|
19605
|
+
properties:
|
19606
|
+
code:
|
19607
|
+
type: string
|
19608
|
+
title: Accounting code for the ledger account.
|
19609
|
+
description: |
|
19610
|
+
Unique code to identify the ledger account. Each code must start
|
19611
|
+
with a letter or number. The following special characters are
|
19612
|
+
allowed: `-_.,:`
|
19613
|
+
pattern: "/^[A-Za-z0-9](( *)?[\\-A-Za-z0-9_.,:])*$/"
|
19614
|
+
maxLength: 255
|
19615
|
+
description:
|
19616
|
+
type: string
|
19617
|
+
title: Description
|
19618
|
+
description: Optional description.
|
19619
|
+
maxLength: 255
|
19620
|
+
account_type:
|
19621
|
+
"$ref": "#/components/schemas/GeneralLedgerAccountTypeEnum"
|
19622
|
+
GeneralLedgerAccountUpdate:
|
19623
|
+
type: object
|
19624
|
+
description: Update an existing general ledger account.
|
19625
|
+
properties:
|
19626
|
+
code:
|
19627
|
+
type: string
|
19628
|
+
title: Accounting code for the ledger account.
|
19629
|
+
description: |
|
19630
|
+
Unique code to identify the ledger account. Each code must start
|
19631
|
+
with a letter or number. The following special characters are
|
19632
|
+
allowed: `-_.,:`
|
19633
|
+
pattern: "/^[A-Za-z0-9](( *)?[\\-A-Za-z0-9_.,:])*$/"
|
19634
|
+
maxLength: 255
|
19635
|
+
description:
|
19636
|
+
type: string
|
19637
|
+
title: Description
|
19638
|
+
description: Optional description.
|
19639
|
+
maxLength: 255
|
19640
|
+
PerformanceObligationId:
|
19641
|
+
type: string
|
19642
|
+
title: Performance Obligation ID
|
19643
|
+
description: |
|
19644
|
+
The ID of a performance obligation. Performance obligations are
|
19645
|
+
only accessible as a part of the Recurly RevRec Standard and
|
19646
|
+
Recurly RevRec Advanced features.
|
19647
|
+
maxLength: 13
|
19648
|
+
PerformanceObligation:
|
19649
|
+
type: object
|
19650
|
+
description: Performance obligation details
|
19651
|
+
properties:
|
19652
|
+
id:
|
19653
|
+
type: string
|
19654
|
+
title: Performance Obligation ID
|
19655
|
+
description: |
|
19656
|
+
The ID of a performance obligation. Performance obligations are
|
19657
|
+
only accessible as a part of the Recurly RevRec Standard and
|
19658
|
+
Recurly RevRec Advanced features.
|
19659
|
+
maxLength: 13
|
19660
|
+
name:
|
19661
|
+
title: Performance Obligation Name
|
19662
|
+
type: string
|
19663
|
+
created_at:
|
19664
|
+
title: Created At
|
19665
|
+
type: string
|
19666
|
+
readOnly: true
|
19667
|
+
format: date-time
|
19668
|
+
updated_at:
|
19669
|
+
title: Last updated at
|
19670
|
+
type: string
|
19671
|
+
readOnly: true
|
19672
|
+
format: date-time
|
19673
|
+
PerformanceObligationList:
|
19674
|
+
type: object
|
19675
|
+
description: List of Performance Obligations
|
19676
|
+
properties:
|
19677
|
+
object:
|
19678
|
+
title: Object type
|
19679
|
+
type: string
|
19680
|
+
data:
|
19681
|
+
title: Performance Obligation
|
19682
|
+
type: array
|
19683
|
+
items:
|
19684
|
+
"$ref": "#/components/schemas/PerformanceObligation"
|
19213
19685
|
ItemMini:
|
19214
19686
|
type: object
|
19215
19687
|
title: Item mini details
|
@@ -19294,6 +19766,30 @@ components:
|
|
19294
19766
|
revenue_schedule_type:
|
19295
19767
|
title: Revenue schedule type
|
19296
19768
|
"$ref": "#/components/schemas/RevenueScheduleTypeEnum"
|
19769
|
+
performance_obligation_id:
|
19770
|
+
type: string
|
19771
|
+
title: Performance Obligation ID
|
19772
|
+
description: |
|
19773
|
+
The ID of a performance obligation. Performance obligations are
|
19774
|
+
only accessible as a part of the Recurly RevRec Standard and
|
19775
|
+
Recurly RevRec Advanced features.
|
19776
|
+
maxLength: 13
|
19777
|
+
liability_gl_account_id:
|
19778
|
+
type: string
|
19779
|
+
title: General Ledger Account ID
|
19780
|
+
description: |
|
19781
|
+
The ID of a general ledger account. General ledger accounts are
|
19782
|
+
only accessible as a part of the Recurly RevRec Standard and
|
19783
|
+
Recurly RevRec Advanced features.
|
19784
|
+
maxLength: 13
|
19785
|
+
revenue_gl_account_id:
|
19786
|
+
type: string
|
19787
|
+
title: General Ledger Account ID
|
19788
|
+
description: |
|
19789
|
+
The ID of a general ledger account. General ledger accounts are
|
19790
|
+
only accessible as a part of the Recurly RevRec Standard and
|
19791
|
+
Recurly RevRec Advanced features.
|
19792
|
+
maxLength: 13
|
19297
19793
|
avalara_transaction_type:
|
19298
19794
|
type: integer
|
19299
19795
|
title: Avalara Transaction Type
|
@@ -19378,6 +19874,30 @@ components:
|
|
19378
19874
|
revenue_schedule_type:
|
19379
19875
|
title: Revenue schedule type
|
19380
19876
|
"$ref": "#/components/schemas/RevenueScheduleTypeEnum"
|
19877
|
+
performance_obligation_id:
|
19878
|
+
type: string
|
19879
|
+
title: Performance Obligation ID
|
19880
|
+
description: |
|
19881
|
+
The ID of a performance obligation. Performance obligations are
|
19882
|
+
only accessible as a part of the Recurly RevRec Standard and
|
19883
|
+
Recurly RevRec Advanced features.
|
19884
|
+
maxLength: 13
|
19885
|
+
liability_gl_account_id:
|
19886
|
+
type: string
|
19887
|
+
title: General Ledger Account ID
|
19888
|
+
description: |
|
19889
|
+
The ID of a general ledger account. General ledger accounts are
|
19890
|
+
only accessible as a part of the Recurly RevRec Standard and
|
19891
|
+
Recurly RevRec Advanced features.
|
19892
|
+
maxLength: 13
|
19893
|
+
revenue_gl_account_id:
|
19894
|
+
type: string
|
19895
|
+
title: General Ledger Account ID
|
19896
|
+
description: |
|
19897
|
+
The ID of a general ledger account. General ledger accounts are
|
19898
|
+
only accessible as a part of the Recurly RevRec Standard and
|
19899
|
+
Recurly RevRec Advanced features.
|
19900
|
+
maxLength: 13
|
19381
19901
|
avalara_transaction_type:
|
19382
19902
|
type: integer
|
19383
19903
|
title: Avalara Transaction Type
|
@@ -19450,6 +19970,30 @@ components:
|
|
19450
19970
|
revenue_schedule_type:
|
19451
19971
|
title: Revenue schedule type
|
19452
19972
|
"$ref": "#/components/schemas/RevenueScheduleTypeEnum"
|
19973
|
+
performance_obligation_id:
|
19974
|
+
type: string
|
19975
|
+
title: Performance Obligation ID
|
19976
|
+
description: |
|
19977
|
+
The ID of a performance obligation. Performance obligations are
|
19978
|
+
only accessible as a part of the Recurly RevRec Standard and
|
19979
|
+
Recurly RevRec Advanced features.
|
19980
|
+
maxLength: 13
|
19981
|
+
liability_gl_account_id:
|
19982
|
+
type: string
|
19983
|
+
title: General Ledger Account ID
|
19984
|
+
description: |
|
19985
|
+
The ID of a general ledger account. General ledger accounts are
|
19986
|
+
only accessible as a part of the Recurly RevRec Standard and
|
19987
|
+
Recurly RevRec Advanced features.
|
19988
|
+
maxLength: 13
|
19989
|
+
revenue_gl_account_id:
|
19990
|
+
type: string
|
19991
|
+
title: General Ledger Account ID
|
19992
|
+
description: |
|
19993
|
+
The ID of a general ledger account. General ledger accounts are
|
19994
|
+
only accessible as a part of the Recurly RevRec Standard and
|
19995
|
+
Recurly RevRec Advanced features.
|
19996
|
+
maxLength: 13
|
19453
19997
|
avalara_transaction_type:
|
19454
19998
|
type: integer
|
19455
19999
|
title: Avalara Transaction Type
|
@@ -20269,6 +20813,32 @@ components:
|
|
20269
20813
|
format: float
|
20270
20814
|
title: Discount
|
20271
20815
|
description: The discount applied to the line item.
|
20816
|
+
liability_gl_account_code:
|
20817
|
+
type: string
|
20818
|
+
title: Accounting code for the ledger account.
|
20819
|
+
description: |
|
20820
|
+
Unique code to identify the ledger account. Each code must start
|
20821
|
+
with a letter or number. The following special characters are
|
20822
|
+
allowed: `-_.,:`
|
20823
|
+
pattern: "/^[A-Za-z0-9](( *)?[\\-A-Za-z0-9_.,:])*$/"
|
20824
|
+
maxLength: 255
|
20825
|
+
revenue_gl_account_code:
|
20826
|
+
type: string
|
20827
|
+
title: Accounting code for the ledger account.
|
20828
|
+
description: |
|
20829
|
+
Unique code to identify the ledger account. Each code must start
|
20830
|
+
with a letter or number. The following special characters are
|
20831
|
+
allowed: `-_.,:`
|
20832
|
+
pattern: "/^[A-Za-z0-9](( *)?[\\-A-Za-z0-9_.,:])*$/"
|
20833
|
+
maxLength: 255
|
20834
|
+
performance_obligation_id:
|
20835
|
+
type: string
|
20836
|
+
title: Performance Obligation ID
|
20837
|
+
description: |
|
20838
|
+
The ID of a performance obligation. Performance obligations are
|
20839
|
+
only accessible as a part of the Recurly RevRec Standard and
|
20840
|
+
Recurly RevRec Advanced features.
|
20841
|
+
maxLength: 13
|
20272
20842
|
tax:
|
20273
20843
|
type: number
|
20274
20844
|
format: float
|
@@ -20310,6 +20880,10 @@ components:
|
|
20310
20880
|
maxLength: 50
|
20311
20881
|
tax_info:
|
20312
20882
|
"$ref": "#/components/schemas/TaxInfo"
|
20883
|
+
origin_tax_address_source:
|
20884
|
+
"$ref": "#/components/schemas/OriginTaxAddressSourceEnum"
|
20885
|
+
destination_tax_address_source:
|
20886
|
+
"$ref": "#/components/schemas/DestinationTaxAddressSourceEnum"
|
20313
20887
|
proration_rate:
|
20314
20888
|
type: number
|
20315
20889
|
format: float
|
@@ -20470,6 +21044,30 @@ components:
|
|
20470
21044
|
is part of the request then `accounting_code` must be absent.
|
20471
21045
|
pattern: "/^[a-z0-9_+-]+$/"
|
20472
21046
|
maxLength: 20
|
21047
|
+
liability_gl_account_id:
|
21048
|
+
type: string
|
21049
|
+
title: General Ledger Account ID
|
21050
|
+
description: |
|
21051
|
+
The ID of a general ledger account. General ledger accounts are
|
21052
|
+
only accessible as a part of the Recurly RevRec Standard and
|
21053
|
+
Recurly RevRec Advanced features.
|
21054
|
+
maxLength: 13
|
21055
|
+
revenue_gl_account_id:
|
21056
|
+
type: string
|
21057
|
+
title: General Ledger Account ID
|
21058
|
+
description: |
|
21059
|
+
The ID of a general ledger account. General ledger accounts are
|
21060
|
+
only accessible as a part of the Recurly RevRec Standard and
|
21061
|
+
Recurly RevRec Advanced features.
|
21062
|
+
maxLength: 13
|
21063
|
+
performance_obligation_id:
|
21064
|
+
type: string
|
21065
|
+
title: Performance Obligation ID
|
21066
|
+
description: |
|
21067
|
+
The ID of a performance obligation. Performance obligations are
|
21068
|
+
only accessible as a part of the Recurly RevRec Standard and
|
21069
|
+
Recurly RevRec Advanced features.
|
21070
|
+
maxLength: 13
|
20473
21071
|
tax_exempt:
|
20474
21072
|
type: boolean
|
20475
21073
|
title: Tax exempt?
|
@@ -20537,6 +21135,10 @@ components:
|
|
20537
21135
|
format: date-time
|
20538
21136
|
title: End date
|
20539
21137
|
description: If this date is provided, it indicates the end of a time range.
|
21138
|
+
origin_tax_address_source:
|
21139
|
+
"$ref": "#/components/schemas/OriginTaxAddressSourceEnum"
|
21140
|
+
destination_tax_address_source:
|
21141
|
+
"$ref": "#/components/schemas/DestinationTaxAddressSourceEnum"
|
20540
21142
|
required:
|
20541
21143
|
- currency
|
20542
21144
|
- unit_amount
|
@@ -20834,6 +21436,54 @@ components:
|
|
20834
21436
|
revenue_schedule_type:
|
20835
21437
|
title: Revenue schedule type
|
20836
21438
|
"$ref": "#/components/schemas/RevenueScheduleTypeEnum"
|
21439
|
+
liability_gl_account_id:
|
21440
|
+
type: string
|
21441
|
+
title: General Ledger Account ID
|
21442
|
+
description: |
|
21443
|
+
The ID of a general ledger account. General ledger accounts are
|
21444
|
+
only accessible as a part of the Recurly RevRec Standard and
|
21445
|
+
Recurly RevRec Advanced features.
|
21446
|
+
maxLength: 13
|
21447
|
+
revenue_gl_account_id:
|
21448
|
+
type: string
|
21449
|
+
title: General Ledger Account ID
|
21450
|
+
description: |
|
21451
|
+
The ID of a general ledger account. General ledger accounts are
|
21452
|
+
only accessible as a part of the Recurly RevRec Standard and
|
21453
|
+
Recurly RevRec Advanced features.
|
21454
|
+
maxLength: 13
|
21455
|
+
performance_obligation_id:
|
21456
|
+
type: string
|
21457
|
+
title: Performance Obligation ID
|
21458
|
+
description: |
|
21459
|
+
The ID of a performance obligation. Performance obligations are
|
21460
|
+
only accessible as a part of the Recurly RevRec Standard and
|
21461
|
+
Recurly RevRec Advanced features.
|
21462
|
+
maxLength: 13
|
21463
|
+
setup_fee_liability_gl_account_id:
|
21464
|
+
type: string
|
21465
|
+
title: General Ledger Account ID
|
21466
|
+
description: |
|
21467
|
+
The ID of a general ledger account. General ledger accounts are
|
21468
|
+
only accessible as a part of the Recurly RevRec Standard and
|
21469
|
+
Recurly RevRec Advanced features.
|
21470
|
+
maxLength: 13
|
21471
|
+
setup_fee_revenue_gl_account_id:
|
21472
|
+
type: string
|
21473
|
+
title: General Ledger Account ID
|
21474
|
+
description: |
|
21475
|
+
The ID of a general ledger account. General ledger accounts are
|
21476
|
+
only accessible as a part of the Recurly RevRec Standard and
|
21477
|
+
Recurly RevRec Advanced features.
|
21478
|
+
maxLength: 13
|
21479
|
+
setup_fee_performance_obligation_id:
|
21480
|
+
type: string
|
21481
|
+
title: Performance Obligation ID
|
21482
|
+
description: |
|
21483
|
+
The ID of a performance obligation. Performance obligations are
|
21484
|
+
only accessible as a part of the Recurly RevRec Standard and
|
21485
|
+
Recurly RevRec Advanced features.
|
21486
|
+
maxLength: 13
|
20837
21487
|
setup_fee_revenue_schedule_type:
|
20838
21488
|
title: Setup fee revenue schedule type
|
20839
21489
|
"$ref": "#/components/schemas/RevenueScheduleTypeEnum"
|
@@ -21050,6 +21700,54 @@ components:
|
|
21050
21700
|
revenue_schedule_type:
|
21051
21701
|
title: Revenue schedule type
|
21052
21702
|
"$ref": "#/components/schemas/RevenueScheduleTypeEnum"
|
21703
|
+
liability_gl_account_id:
|
21704
|
+
type: string
|
21705
|
+
title: General Ledger Account ID
|
21706
|
+
description: |
|
21707
|
+
The ID of a general ledger account. General ledger accounts are
|
21708
|
+
only accessible as a part of the Recurly RevRec Standard and
|
21709
|
+
Recurly RevRec Advanced features.
|
21710
|
+
maxLength: 13
|
21711
|
+
revenue_gl_account_id:
|
21712
|
+
type: string
|
21713
|
+
title: General Ledger Account ID
|
21714
|
+
description: |
|
21715
|
+
The ID of a general ledger account. General ledger accounts are
|
21716
|
+
only accessible as a part of the Recurly RevRec Standard and
|
21717
|
+
Recurly RevRec Advanced features.
|
21718
|
+
maxLength: 13
|
21719
|
+
performance_obligation_id:
|
21720
|
+
type: string
|
21721
|
+
title: Performance Obligation ID
|
21722
|
+
description: |
|
21723
|
+
The ID of a performance obligation. Performance obligations are
|
21724
|
+
only accessible as a part of the Recurly RevRec Standard and
|
21725
|
+
Recurly RevRec Advanced features.
|
21726
|
+
maxLength: 13
|
21727
|
+
setup_fee_liability_gl_account_id:
|
21728
|
+
type: string
|
21729
|
+
title: General Ledger Account ID
|
21730
|
+
description: |
|
21731
|
+
The ID of a general ledger account. General ledger accounts are
|
21732
|
+
only accessible as a part of the Recurly RevRec Standard and
|
21733
|
+
Recurly RevRec Advanced features.
|
21734
|
+
maxLength: 13
|
21735
|
+
setup_fee_revenue_gl_account_id:
|
21736
|
+
type: string
|
21737
|
+
title: General Ledger Account ID
|
21738
|
+
description: |
|
21739
|
+
The ID of a general ledger account. General ledger accounts are
|
21740
|
+
only accessible as a part of the Recurly RevRec Standard and
|
21741
|
+
Recurly RevRec Advanced features.
|
21742
|
+
maxLength: 13
|
21743
|
+
setup_fee_performance_obligation_id:
|
21744
|
+
type: string
|
21745
|
+
title: Performance Obligation ID
|
21746
|
+
description: |
|
21747
|
+
The ID of a performance obligation. Performance obligations are
|
21748
|
+
only accessible as a part of the Recurly RevRec Standard and
|
21749
|
+
Recurly RevRec Advanced features.
|
21750
|
+
maxLength: 13
|
21053
21751
|
setup_fee_revenue_schedule_type:
|
21054
21752
|
title: Setup fee revenue schedule type
|
21055
21753
|
"$ref": "#/components/schemas/RevenueScheduleTypeEnum"
|
@@ -21508,6 +22206,30 @@ components:
|
|
21508
22206
|
- `FR010200` – Delivery by Company Vehicle After Passage of Title
|
21509
22207
|
- `NT` – Non-Taxable
|
21510
22208
|
maxLength: 50
|
22209
|
+
liability_gl_account_id:
|
22210
|
+
type: string
|
22211
|
+
title: General Ledger Account ID
|
22212
|
+
description: |
|
22213
|
+
The ID of a general ledger account. General ledger accounts are
|
22214
|
+
only accessible as a part of the Recurly RevRec Standard and
|
22215
|
+
Recurly RevRec Advanced features.
|
22216
|
+
maxLength: 13
|
22217
|
+
revenue_gl_account_id:
|
22218
|
+
type: string
|
22219
|
+
title: General Ledger Account ID
|
22220
|
+
description: |
|
22221
|
+
The ID of a general ledger account. General ledger accounts are
|
22222
|
+
only accessible as a part of the Recurly RevRec Standard and
|
22223
|
+
Recurly RevRec Advanced features.
|
22224
|
+
maxLength: 13
|
22225
|
+
performance_obligation_id:
|
22226
|
+
type: string
|
22227
|
+
title: Performance Obligation ID
|
22228
|
+
description: |
|
22229
|
+
The ID of a performance obligation. Performance obligations are
|
22230
|
+
only accessible as a part of the Recurly RevRec Standard and
|
22231
|
+
Recurly RevRec Advanced features.
|
22232
|
+
maxLength: 13
|
21511
22233
|
created_at:
|
21512
22234
|
type: string
|
21513
22235
|
format: date-time
|
@@ -21580,6 +22302,30 @@ components:
|
|
21580
22302
|
- `FR010200` – Delivery by Company Vehicle After Passage of Title
|
21581
22303
|
- `NT` – Non-Taxable
|
21582
22304
|
maxLength: 50
|
22305
|
+
liability_gl_account_id:
|
22306
|
+
type: string
|
22307
|
+
title: General Ledger Account ID
|
22308
|
+
description: |
|
22309
|
+
The ID of a general ledger account. General ledger accounts are
|
22310
|
+
only accessible as a part of the Recurly RevRec Standard and
|
22311
|
+
Recurly RevRec Advanced features.
|
22312
|
+
maxLength: 13
|
22313
|
+
revenue_gl_account_id:
|
22314
|
+
type: string
|
22315
|
+
title: General Ledger Account ID
|
22316
|
+
description: |
|
22317
|
+
The ID of a general ledger account. General ledger accounts are
|
22318
|
+
only accessible as a part of the Recurly RevRec Standard and
|
22319
|
+
Recurly RevRec Advanced features.
|
22320
|
+
maxLength: 13
|
22321
|
+
performance_obligation_id:
|
22322
|
+
type: string
|
22323
|
+
title: Performance Obligation ID
|
22324
|
+
description: |
|
22325
|
+
The ID of a performance obligation. Performance obligations are
|
22326
|
+
only accessible as a part of the Recurly RevRec Standard and
|
22327
|
+
Recurly RevRec Advanced features.
|
22328
|
+
maxLength: 13
|
21583
22329
|
required:
|
21584
22330
|
- code
|
21585
22331
|
- name
|
@@ -21618,6 +22364,30 @@ components:
|
|
21618
22364
|
- `FR010200` – Delivery by Company Vehicle After Passage of Title
|
21619
22365
|
- `NT` – Non-Taxable
|
21620
22366
|
maxLength: 50
|
22367
|
+
liability_gl_account_id:
|
22368
|
+
type: string
|
22369
|
+
title: General Ledger Account ID
|
22370
|
+
description: |
|
22371
|
+
The ID of a general ledger account. General ledger accounts are
|
22372
|
+
only accessible as a part of the Recurly RevRec Standard and
|
22373
|
+
Recurly RevRec Advanced features.
|
22374
|
+
maxLength: 13
|
22375
|
+
revenue_gl_account_id:
|
22376
|
+
type: string
|
22377
|
+
title: General Ledger Account ID
|
22378
|
+
description: |
|
22379
|
+
The ID of a general ledger account. General ledger accounts are
|
22380
|
+
only accessible as a part of the Recurly RevRec Standard and
|
22381
|
+
Recurly RevRec Advanced features.
|
22382
|
+
maxLength: 13
|
22383
|
+
performance_obligation_id:
|
22384
|
+
type: string
|
22385
|
+
title: Performance Obligation ID
|
22386
|
+
description: |
|
22387
|
+
The ID of a performance obligation. Performance obligations are
|
22388
|
+
only accessible as a part of the Recurly RevRec Standard and
|
22389
|
+
Recurly RevRec Advanced features.
|
22390
|
+
maxLength: 13
|
21621
22391
|
ShippingFeeCreate:
|
21622
22392
|
type: object
|
21623
22393
|
properties:
|
@@ -23980,8 +24750,6 @@ components:
|
|
23980
24750
|
object:
|
23981
24751
|
type: string
|
23982
24752
|
title: Object type
|
23983
|
-
external_subscription:
|
23984
|
-
"$ref": "#/components/schemas/ExternalSubscription"
|
23985
24753
|
started_at:
|
23986
24754
|
type: string
|
23987
24755
|
format: date-time
|
@@ -24279,6 +25047,12 @@ components:
|
|
24279
25047
|
"$ref": "#/components/schemas/AccountMini"
|
24280
25048
|
external_product_reference:
|
24281
25049
|
"$ref": "#/components/schemas/ExternalProductReferenceMini"
|
25050
|
+
external_payment_phases:
|
25051
|
+
type: array
|
25052
|
+
title: External payment phases
|
25053
|
+
description: The phases of the external subscription payment lifecycle.
|
25054
|
+
items:
|
25055
|
+
"$ref": "#/components/schemas/ExternalPaymentPhase"
|
24282
25056
|
external_id:
|
24283
25057
|
type: string
|
24284
25058
|
title: External Id
|
@@ -24352,6 +25126,12 @@ components:
|
|
24352
25126
|
description: An indication of whether or not the external subscription was
|
24353
25127
|
purchased in a sandbox environment.
|
24354
25128
|
default: false
|
25129
|
+
imported:
|
25130
|
+
type: boolean
|
25131
|
+
title: Imported
|
25132
|
+
description: An indication of whether or not the external subscription was
|
25133
|
+
created by a historical data import.
|
25134
|
+
default: false
|
24355
25135
|
created_at:
|
24356
25136
|
type: string
|
24357
25137
|
format: date-time
|
@@ -24682,6 +25462,10 @@ components:
|
|
24682
25462
|
description: Address information for the business entity that will be used
|
24683
25463
|
for calculating taxes.
|
24684
25464
|
"$ref": "#/components/schemas/Address"
|
25465
|
+
origin_tax_address_source:
|
25466
|
+
"$ref": "#/components/schemas/OriginTaxAddressSourceEnum"
|
25467
|
+
destination_tax_address_source:
|
25468
|
+
"$ref": "#/components/schemas/DestinationTaxAddressSourceEnum"
|
24685
25469
|
default_vat_number:
|
24686
25470
|
type: string
|
24687
25471
|
title: Default VAT number
|
@@ -24699,6 +25483,22 @@ components:
|
|
24699
25483
|
items:
|
24700
25484
|
type: string
|
24701
25485
|
title: Country code
|
25486
|
+
default_liability_gl_account_id:
|
25487
|
+
type: string
|
25488
|
+
title: General Ledger Account ID
|
25489
|
+
description: |
|
25490
|
+
The ID of a general ledger account. General ledger accounts are
|
25491
|
+
only accessible as a part of the Recurly RevRec Standard and
|
25492
|
+
Recurly RevRec Advanced features.
|
25493
|
+
maxLength: 13
|
25494
|
+
default_revenue_gl_account_id:
|
25495
|
+
type: string
|
25496
|
+
title: General Ledger Account ID
|
25497
|
+
description: |
|
25498
|
+
The ID of a general ledger account. General ledger accounts are
|
25499
|
+
only accessible as a part of the Recurly RevRec Standard and
|
25500
|
+
Recurly RevRec Advanced features.
|
25501
|
+
maxLength: 13
|
24702
25502
|
created_at:
|
24703
25503
|
type: string
|
24704
25504
|
format: date-time
|
@@ -24797,6 +25597,30 @@ components:
|
|
24797
25597
|
description: The delivery details for the gift card.
|
24798
25598
|
readOnly: true
|
24799
25599
|
"$ref": "#/components/schemas/GiftCardDelivery"
|
25600
|
+
performance_obligation_id:
|
25601
|
+
type: string
|
25602
|
+
title: Performance Obligation ID
|
25603
|
+
description: |
|
25604
|
+
The ID of a performance obligation. Performance obligations are
|
25605
|
+
only accessible as a part of the Recurly RevRec Standard and
|
25606
|
+
Recurly RevRec Advanced features.
|
25607
|
+
maxLength: 13
|
25608
|
+
liability_gl_account_id:
|
25609
|
+
type: string
|
25610
|
+
title: General Ledger Account ID
|
25611
|
+
description: |
|
25612
|
+
The ID of a general ledger account. General ledger accounts are
|
25613
|
+
only accessible as a part of the Recurly RevRec Standard and
|
25614
|
+
Recurly RevRec Advanced features.
|
25615
|
+
maxLength: 13
|
25616
|
+
revenue_gl_account_id:
|
25617
|
+
type: string
|
25618
|
+
title: General Ledger Account ID
|
25619
|
+
description: |
|
25620
|
+
The ID of a general ledger account. General ledger accounts are
|
25621
|
+
only accessible as a part of the Recurly RevRec Standard and
|
25622
|
+
Recurly RevRec Advanced features.
|
25623
|
+
maxLength: 13
|
24800
25624
|
created_at:
|
24801
25625
|
type: string
|
24802
25626
|
format: date-time
|
@@ -25978,3 +26802,30 @@ components:
|
|
25978
26802
|
type: string
|
25979
26803
|
enum:
|
25980
26804
|
- paid
|
26805
|
+
GeneralLedgerAccountTypeEnum:
|
26806
|
+
type: string
|
26807
|
+
enum:
|
26808
|
+
- liability
|
26809
|
+
- revenue
|
26810
|
+
OriginTaxAddressSourceEnum:
|
26811
|
+
type: string
|
26812
|
+
title: Origin tax address source
|
26813
|
+
description: The source of the address that will be used as the origin in determining
|
26814
|
+
taxes. Available only when the site is on an Elite plan. A value of "origin"
|
26815
|
+
refers to the "Business entity tax address". A value of "destination" refers
|
26816
|
+
to the "Customer tax address".
|
26817
|
+
default: origin
|
26818
|
+
enum:
|
26819
|
+
- origin
|
26820
|
+
- destination
|
26821
|
+
DestinationTaxAddressSourceEnum:
|
26822
|
+
type: string
|
26823
|
+
title: Destination tax address source
|
26824
|
+
description: The source of the address that will be used as the destinaion in
|
26825
|
+
determining taxes. Available only when the site is on an Elite plan. A value
|
26826
|
+
of "destination" refers to the "Customer tax address". A value of "origin"
|
26827
|
+
refers to the "Business entity tax address".
|
26828
|
+
default: destination
|
26829
|
+
enum:
|
26830
|
+
- destination
|
26831
|
+
- origin
|