From 586da6771a6872ed3e4c5b55fb096a349686bbd3 Mon Sep 17 00:00:00 2001 From: Recurly Integrations Date: Tue, 2 Jul 2024 18:36:00 +0000 Subject: [PATCH] Generated Latest Changes for v2021-02-25 --- lib/recurly/client.php | 117 ++- lib/recurly/resources/add_on.php | 81 ++ lib/recurly/resources/business_entity.php | 102 ++ .../resources/external_payment_phase.php | 24 - .../resources/external_subscription.php | 49 + .../resources/general_ledger_account.php | 193 ++++ lib/recurly/resources/gift_card.php | 81 ++ lib/recurly/resources/item.php | 81 ++ lib/recurly/resources/line_item.php | 129 +++ .../resources/performance_obligation.php | 118 +++ lib/recurly/resources/shipping_method.php | 81 ++ openapi/api.yaml | 871 +++++++++++++++++- 12 files changed, 1889 insertions(+), 38 deletions(-) create mode 100644 lib/recurly/resources/general_ledger_account.php create mode 100644 lib/recurly/resources/performance_obligation.php diff --git a/lib/recurly/client.php b/lib/recurly/client.php index 69c207db..b1d4c6df 100644 --- a/lib/recurly/client.php +++ b/lib/recurly/client.php @@ -1337,7 +1337,7 @@ public function listCustomFieldDefinitions(array $options = []): \Recurly\Pager * @param string $custom_field_definition_id Custom Field Definition ID * @param array $options Associative array of optional parameters * - * @return \Recurly\Resources\CustomFieldDefinition An custom field definition. + * @return \Recurly\Resources\CustomFieldDefinition A custom field definition. * @link https://developers.recurly.com/api/v2021-02-25#operation/get_custom_field_definition */ public function getCustomFieldDefinition(string $custom_field_definition_id, array $options = []): \Recurly\Resources\CustomFieldDefinition @@ -1346,6 +1346,115 @@ public function getCustomFieldDefinition(string $custom_field_definition_id, arr return $this->makeRequest('GET', $path, [], $options); } + /** + * Create a new general ledger account + * + * @param array $body The body of the request. + * @param array $options Associative array of optional parameters + * + * @return \Recurly\Resources\GeneralLedgerAccount A new general ledger account. + * @link https://developers.recurly.com/api/v2021-02-25#operation/create_general_ledger_account + */ + public function createGeneralLedgerAccount(array $body, array $options = []): \Recurly\Resources\GeneralLedgerAccount + { + $path = $this->interpolatePath("/general_ledger_accounts", []); + return $this->makeRequest('POST', $path, $body, $options); + } + + /** + * List a site's general ledger accounts + * + * @param array $options Associative array of optional parameters + * + * Supported optional query string parameters: + * + * - $options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using + * commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. + * + * **Important notes:** + * + * * The `ids` parameter cannot be used with any other ordering or filtering + * parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc) + * * Invalid or unknown IDs will be ignored, so you should check that the + * results correspond to your request. + * * Records are returned in an arbitrary order. Since results are all + * returned at once you can sort the records yourself. + * - $options['params']['limit'] (int): Limit number of records 1-200. + * - $options['params']['order'] (string): Sort order. + * - $options['params']['sort'] (string): Sort field. You *really* only want to sort by `updated_at` in ascending + * order. In descending order updated records will move behind the cursor and could + * prevent some records from being returned. + * - $options['params']['account_type'] (string): General Ledger Account type by which to filter the response. + * + * @return \Recurly\Pager A list of the site's general ledger accounts. + * @link https://developers.recurly.com/api/v2021-02-25#operation/list_general_ledger_accounts + */ + public function listGeneralLedgerAccounts(array $options = []): \Recurly\Pager + { + $path = $this->interpolatePath("/general_ledger_accounts", []); + return new \Recurly\Pager($this, $path, $options); + } + + /** + * Fetch a general ledger account + * + * @param string $general_ledger_account_id General Ledger Account ID + * @param array $options Associative array of optional parameters + * + * @return \Recurly\Resources\GeneralLedgerAccount A general ledger account. + * @link https://developers.recurly.com/api/v2021-02-25#operation/get_general_ledger_account + */ + public function getGeneralLedgerAccount(string $general_ledger_account_id, array $options = []): \Recurly\Resources\GeneralLedgerAccount + { + $path = $this->interpolatePath("/general_ledger_accounts/{general_ledger_account_id}", ['general_ledger_account_id' => $general_ledger_account_id]); + return $this->makeRequest('GET', $path, [], $options); + } + + /** + * Update a general ledger account + * + * @param string $general_ledger_account_id General Ledger Account ID + * @param array $body The body of the request. + * @param array $options Associative array of optional parameters + * + * @return \Recurly\Resources\GeneralLedgerAccount The updated general ledger account. + * @link https://developers.recurly.com/api/v2021-02-25#operation/update_general_ledger_account + */ + public function updateGeneralLedgerAccount(string $general_ledger_account_id, array $body, array $options = []): \Recurly\Resources\GeneralLedgerAccount + { + $path = $this->interpolatePath("/general_ledger_accounts/{general_ledger_account_id}", ['general_ledger_account_id' => $general_ledger_account_id]); + return $this->makeRequest('PUT', $path, $body, $options); + } + + /** + * Get a single Performance Obligation. + * + * @param string $performance_obligation_id Performance Obligation id. + * @param array $options Associative array of optional parameters + * + * @return \Recurly\Resources\PerformanceObligation A single Performance Obligation. + * @link https://developers.recurly.com/api/v2021-02-25#operation/get_performance_obligation + */ + public function getPerformanceObligation(string $performance_obligation_id, array $options = []): \Recurly\Resources\PerformanceObligation + { + $path = $this->interpolatePath("/performance_obligations/{performance_obligation_id}", ['performance_obligation_id' => $performance_obligation_id]); + return $this->makeRequest('GET', $path, [], $options); + } + + /** + * Get a site's Performance Obligations + * + * @param array $options Associative array of optional parameters + * + * @return \Recurly\Pager A list of Performance Obligations. + * @link https://developers.recurly.com/api/v2021-02-25#operation/get_performance_obligations + */ + public function getPerformanceObligations(array $options = []): \Recurly\Pager + { + $path = $this->interpolatePath("/performance_obligations", []); + return new \Recurly\Pager($this, $path, $options); + } + /** * List an invoice template's associated accounts * @@ -1774,7 +1883,7 @@ public function listExternalSubscriptions(array $options = []): \Recurly\Pager /** * Fetch an external subscription * - * @param string $external_subscription_id External subscription id + * @param string $external_subscription_id External subscription ID or external_id. For ID no prefix is used e.g. `e28zov4fw0v2`. For external_id use prefix `external-id-`, e.g. `external-id-123456`. * @param array $options Associative array of optional parameters * * @return \Recurly\Resources\ExternalSubscription Settings for an external subscription. @@ -3396,13 +3505,13 @@ public function listExternalSubscriptionExternalPaymentPhases(string $external_s } /** - * Fetch an external payment_phase + * Fetch an external payment phase * * @param string $external_subscription_id External subscription id * @param string $external_payment_phase_id External payment phase ID, e.g. `a34ypb2ef9w1`. * @param array $options Associative array of optional parameters * - * @return \Recurly\Resources\ExternalPaymentPhase Details for an external payment_phase. + * @return \Recurly\Resources\ExternalPaymentPhase Details for an external payment phase. * @link https://developers.recurly.com/api/v2021-02-25#operation/get_external_subscription_external_payment_phase */ public function getExternalSubscriptionExternalPaymentPhase(string $external_subscription_id, string $external_payment_phase_id, array $options = []): \Recurly\Resources\ExternalPaymentPhase diff --git a/lib/recurly/resources/add_on.php b/lib/recurly/resources/add_on.php index fc8e2f50..179a7c2f 100644 --- a/lib/recurly/resources/add_on.php +++ b/lib/recurly/resources/add_on.php @@ -25,12 +25,15 @@ class AddOn extends RecurlyResource private $_external_sku; private $_id; private $_item; + private $_liability_gl_account_id; private $_measured_unit_id; private $_name; private $_object; private $_optional; private $_percentage_tiers; + private $_performance_obligation_id; private $_plan_id; + private $_revenue_gl_account_id; private $_revenue_schedule_type; private $_state; private $_tax_code; @@ -348,6 +351,32 @@ public function setItem(\Recurly\Resources\ItemMini $item): void $this->_item = $item; } + /** + * Getter method for the liability_gl_account_id attribute. + * The ID of a general ledger account. General ledger accounts are +only accessible as a part of the Recurly RevRec Standard and +Recurly RevRec Advanced features. + + * + * @return ?string + */ + public function getLiabilityGlAccountId(): ?string + { + return $this->_liability_gl_account_id; + } + + /** + * Setter method for the liability_gl_account_id attribute. + * + * @param string $liability_gl_account_id + * + * @return void + */ + public function setLiabilityGlAccountId(string $liability_gl_account_id): void + { + $this->_liability_gl_account_id = $liability_gl_account_id; + } + /** * Getter method for the measured_unit_id attribute. * System-generated unique identifier for an measured unit associated with the add-on. @@ -463,6 +492,32 @@ public function setPercentageTiers(array $percentage_tiers): void $this->_percentage_tiers = $percentage_tiers; } + /** + * Getter method for the performance_obligation_id attribute. + * The ID of a performance obligation. Performance obligations are +only accessible as a part of the Recurly RevRec Standard and +Recurly RevRec Advanced features. + + * + * @return ?string + */ + public function getPerformanceObligationId(): ?string + { + return $this->_performance_obligation_id; + } + + /** + * Setter method for the performance_obligation_id attribute. + * + * @param string $performance_obligation_id + * + * @return void + */ + public function setPerformanceObligationId(string $performance_obligation_id): void + { + $this->_performance_obligation_id = $performance_obligation_id; + } + /** * Getter method for the plan_id attribute. * Plan ID @@ -486,6 +541,32 @@ public function setPlanId(string $plan_id): void $this->_plan_id = $plan_id; } + /** + * Getter method for the revenue_gl_account_id attribute. + * The ID of a general ledger account. General ledger accounts are +only accessible as a part of the Recurly RevRec Standard and +Recurly RevRec Advanced features. + + * + * @return ?string + */ + public function getRevenueGlAccountId(): ?string + { + return $this->_revenue_gl_account_id; + } + + /** + * Setter method for the revenue_gl_account_id attribute. + * + * @param string $revenue_gl_account_id + * + * @return void + */ + public function setRevenueGlAccountId(string $revenue_gl_account_id): void + { + $this->_revenue_gl_account_id = $revenue_gl_account_id; + } + /** * Getter method for the revenue_schedule_type attribute. * When this add-on is invoiced, the line item will use this revenue schedule. If `item_code`/`item_id` is part of the request then `revenue_schedule_type` must be absent in the request as the value will be set from the item. diff --git a/lib/recurly/resources/business_entity.php b/lib/recurly/resources/business_entity.php index 91cb299b..be2155ba 100644 --- a/lib/recurly/resources/business_entity.php +++ b/lib/recurly/resources/business_entity.php @@ -14,12 +14,16 @@ class BusinessEntity extends RecurlyResource { private $_code; private $_created_at; + private $_default_liability_gl_account_id; private $_default_registration_number; + private $_default_revenue_gl_account_id; private $_default_vat_number; + private $_destination_tax_address_source; private $_id; private $_invoice_display_address; private $_name; private $_object; + private $_origin_tax_address_source; private $_subscriber_location_countries; private $_tax_address; private $_updated_at; @@ -75,6 +79,32 @@ public function setCreatedAt(string $created_at): void $this->_created_at = $created_at; } + /** + * Getter method for the default_liability_gl_account_id attribute. + * The ID of a general ledger account. General ledger accounts are +only accessible as a part of the Recurly RevRec Standard and +Recurly RevRec Advanced features. + + * + * @return ?string + */ + public function getDefaultLiabilityGlAccountId(): ?string + { + return $this->_default_liability_gl_account_id; + } + + /** + * Setter method for the default_liability_gl_account_id attribute. + * + * @param string $default_liability_gl_account_id + * + * @return void + */ + public function setDefaultLiabilityGlAccountId(string $default_liability_gl_account_id): void + { + $this->_default_liability_gl_account_id = $default_liability_gl_account_id; + } + /** * Getter method for the default_registration_number attribute. * Registration number for the customer used on the invoice. @@ -98,6 +128,32 @@ public function setDefaultRegistrationNumber(string $default_registration_number $this->_default_registration_number = $default_registration_number; } + /** + * Getter method for the default_revenue_gl_account_id attribute. + * The ID of a general ledger account. General ledger accounts are +only accessible as a part of the Recurly RevRec Standard and +Recurly RevRec Advanced features. + + * + * @return ?string + */ + public function getDefaultRevenueGlAccountId(): ?string + { + return $this->_default_revenue_gl_account_id; + } + + /** + * Setter method for the default_revenue_gl_account_id attribute. + * + * @param string $default_revenue_gl_account_id + * + * @return void + */ + public function setDefaultRevenueGlAccountId(string $default_revenue_gl_account_id): void + { + $this->_default_revenue_gl_account_id = $default_revenue_gl_account_id; + } + /** * Getter method for the default_vat_number attribute. * VAT number for the customer used on the invoice. @@ -121,6 +177,29 @@ public function setDefaultVatNumber(string $default_vat_number): void $this->_default_vat_number = $default_vat_number; } + /** + * Getter method for the destination_tax_address_source attribute. + * The source of the address that will be used as the destinaion in determining taxes. Available only when the site is on an Elite plan. A value of "destination" refers to the "Customer tax address". A value of "origin" refers to the "Business entity tax address". + * + * @return ?string + */ + public function getDestinationTaxAddressSource(): ?string + { + return $this->_destination_tax_address_source; + } + + /** + * Setter method for the destination_tax_address_source attribute. + * + * @param string $destination_tax_address_source + * + * @return void + */ + public function setDestinationTaxAddressSource(string $destination_tax_address_source): void + { + $this->_destination_tax_address_source = $destination_tax_address_source; + } + /** * Getter method for the id attribute. * Business entity ID @@ -213,6 +292,29 @@ public function setObject(string $object): void $this->_object = $object; } + /** + * Getter method for the origin_tax_address_source attribute. + * The source of the address that will be used as the origin in determining taxes. Available only when the site is on an Elite plan. A value of "origin" refers to the "Business entity tax address". A value of "destination" refers to the "Customer tax address". + * + * @return ?string + */ + public function getOriginTaxAddressSource(): ?string + { + return $this->_origin_tax_address_source; + } + + /** + * Setter method for the origin_tax_address_source attribute. + * + * @param string $origin_tax_address_source + * + * @return void + */ + public function setOriginTaxAddressSource(string $origin_tax_address_source): void + { + $this->_origin_tax_address_source = $origin_tax_address_source; + } + /** * Getter method for the subscriber_location_countries attribute. * List of countries for which the business entity will be used. diff --git a/lib/recurly/resources/external_payment_phase.php b/lib/recurly/resources/external_payment_phase.php index 94100450..44cd2bfc 100644 --- a/lib/recurly/resources/external_payment_phase.php +++ b/lib/recurly/resources/external_payment_phase.php @@ -17,7 +17,6 @@ class ExternalPaymentPhase extends RecurlyResource private $_currency; private $_ending_billing_period_index; private $_ends_at; - private $_external_subscription; private $_id; private $_object; private $_offer_name; @@ -147,29 +146,6 @@ public function setEndsAt(string $ends_at): void $this->_ends_at = $ends_at; } - /** - * Getter method for the external_subscription attribute. - * Subscription from an external resource such as Apple App Store or Google Play Store. - * - * @return ?\Recurly\Resources\ExternalSubscription - */ - public function getExternalSubscription(): ?\Recurly\Resources\ExternalSubscription - { - return $this->_external_subscription; - } - - /** - * Setter method for the external_subscription attribute. - * - * @param \Recurly\Resources\ExternalSubscription $external_subscription - * - * @return void - */ - public function setExternalSubscription(\Recurly\Resources\ExternalSubscription $external_subscription): void - { - $this->_external_subscription = $external_subscription; - } - /** * Getter method for the id attribute. * System-generated unique identifier for an external payment phase ID, e.g. `e28zov4fw0v2`. diff --git a/lib/recurly/resources/external_subscription.php b/lib/recurly/resources/external_subscription.php index 62274dc6..42923d43 100644 --- a/lib/recurly/resources/external_subscription.php +++ b/lib/recurly/resources/external_subscription.php @@ -20,8 +20,10 @@ class ExternalSubscription extends RecurlyResource private $_created_at; private $_expires_at; private $_external_id; + private $_external_payment_phases; private $_external_product_reference; private $_id; + private $_imported; private $_in_grace_period; private $_last_purchased; private $_object; @@ -33,6 +35,7 @@ class ExternalSubscription extends RecurlyResource private $_updated_at; protected static $array_hints = [ + 'setExternalPaymentPhases' => '\Recurly\Resources\ExternalPaymentPhase', ]; @@ -220,6 +223,29 @@ public function setExternalId(string $external_id): void $this->_external_id = $external_id; } + /** + * Getter method for the external_payment_phases attribute. + * The phases of the external subscription payment lifecycle. + * + * @return array + */ + public function getExternalPaymentPhases(): array + { + return $this->_external_payment_phases ?? [] ; + } + + /** + * Setter method for the external_payment_phases attribute. + * + * @param array $external_payment_phases + * + * @return void + */ + public function setExternalPaymentPhases(array $external_payment_phases): void + { + $this->_external_payment_phases = $external_payment_phases; + } + /** * Getter method for the external_product_reference attribute. * External Product Reference details @@ -266,6 +292,29 @@ public function setId(string $id): void $this->_id = $id; } + /** + * Getter method for the imported attribute. + * An indication of whether or not the external subscription was created by a historical data import. + * + * @return ?bool + */ + public function getImported(): ?bool + { + return $this->_imported; + } + + /** + * Setter method for the imported attribute. + * + * @param bool $imported + * + * @return void + */ + public function setImported(bool $imported): void + { + $this->_imported = $imported; + } + /** * Getter method for the in_grace_period attribute. * An indication of whether or not the external subscription is in a grace period. diff --git a/lib/recurly/resources/general_ledger_account.php b/lib/recurly/resources/general_ledger_account.php new file mode 100644 index 00000000..8622ca98 --- /dev/null +++ b/lib/recurly/resources/general_ledger_account.php @@ -0,0 +1,193 @@ +_account_type; + } + + /** + * Setter method for the account_type attribute. + * + * @param string $account_type + * + * @return void + */ + public function setAccountType(string $account_type): void + { + $this->_account_type = $account_type; + } + + /** + * Getter method for the code attribute. + * Unique code to identify the ledger account. Each code must start +with a letter or number. The following special characters are +allowed: `-_.,:` + + * + * @return ?string + */ + public function getCode(): ?string + { + return $this->_code; + } + + /** + * Setter method for the code attribute. + * + * @param string $code + * + * @return void + */ + public function setCode(string $code): void + { + $this->_code = $code; + } + + /** + * Getter method for the created_at attribute. + * Created at + * + * @return ?string + */ + public function getCreatedAt(): ?string + { + return $this->_created_at; + } + + /** + * Setter method for the created_at attribute. + * + * @param string $created_at + * + * @return void + */ + public function setCreatedAt(string $created_at): void + { + $this->_created_at = $created_at; + } + + /** + * Getter method for the description attribute. + * Optional description. + * + * @return ?string + */ + public function getDescription(): ?string + { + return $this->_description; + } + + /** + * Setter method for the description attribute. + * + * @param string $description + * + * @return void + */ + public function setDescription(string $description): void + { + $this->_description = $description; + } + + /** + * Getter method for the id attribute. + * The ID of a general ledger account. General ledger accounts are +only accessible as a part of the Recurly RevRec Standard and +Recurly RevRec Advanced features. + + * + * @return ?string + */ + public function getId(): ?string + { + return $this->_id; + } + + /** + * Setter method for the id attribute. + * + * @param string $id + * + * @return void + */ + public function setId(string $id): void + { + $this->_id = $id; + } + + /** + * Getter method for the object attribute. + * Object type + * + * @return ?string + */ + public function getObject(): ?string + { + return $this->_object; + } + + /** + * Setter method for the object attribute. + * + * @param string $object + * + * @return void + */ + public function setObject(string $object): void + { + $this->_object = $object; + } + + /** + * Getter method for the updated_at attribute. + * Last updated at + * + * @return ?string + */ + public function getUpdatedAt(): ?string + { + return $this->_updated_at; + } + + /** + * Setter method for the updated_at attribute. + * + * @param string $updated_at + * + * @return void + */ + public function setUpdatedAt(string $updated_at): void + { + $this->_updated_at = $updated_at; + } +} \ No newline at end of file diff --git a/lib/recurly/resources/gift_card.php b/lib/recurly/resources/gift_card.php index 21c27855..30ca8813 100644 --- a/lib/recurly/resources/gift_card.php +++ b/lib/recurly/resources/gift_card.php @@ -20,13 +20,16 @@ class GiftCard extends RecurlyResource private $_delivery; private $_gifter_account_id; private $_id; + private $_liability_gl_account_id; private $_object; + private $_performance_obligation_id; private $_product_code; private $_purchase_invoice_id; private $_recipient_account_id; private $_redeemed_at; private $_redemption_code; private $_redemption_invoice_id; + private $_revenue_gl_account_id; private $_unit_amount; private $_updated_at; @@ -218,6 +221,32 @@ public function setId(string $id): void $this->_id = $id; } + /** + * Getter method for the liability_gl_account_id attribute. + * The ID of a general ledger account. General ledger accounts are +only accessible as a part of the Recurly RevRec Standard and +Recurly RevRec Advanced features. + + * + * @return ?string + */ + public function getLiabilityGlAccountId(): ?string + { + return $this->_liability_gl_account_id; + } + + /** + * Setter method for the liability_gl_account_id attribute. + * + * @param string $liability_gl_account_id + * + * @return void + */ + public function setLiabilityGlAccountId(string $liability_gl_account_id): void + { + $this->_liability_gl_account_id = $liability_gl_account_id; + } + /** * Getter method for the object attribute. * Object type @@ -241,6 +270,32 @@ public function setObject(string $object): void $this->_object = $object; } + /** + * Getter method for the performance_obligation_id attribute. + * The ID of a performance obligation. Performance obligations are +only accessible as a part of the Recurly RevRec Standard and +Recurly RevRec Advanced features. + + * + * @return ?string + */ + public function getPerformanceObligationId(): ?string + { + return $this->_performance_obligation_id; + } + + /** + * Setter method for the performance_obligation_id attribute. + * + * @param string $performance_obligation_id + * + * @return void + */ + public function setPerformanceObligationId(string $performance_obligation_id): void + { + $this->_performance_obligation_id = $performance_obligation_id; + } + /** * Getter method for the product_code attribute. * The product code or SKU of the gift card product. @@ -379,6 +434,32 @@ public function setRedemptionInvoiceId(string $redemption_invoice_id): void $this->_redemption_invoice_id = $redemption_invoice_id; } + /** + * Getter method for the revenue_gl_account_id attribute. + * The ID of a general ledger account. General ledger accounts are +only accessible as a part of the Recurly RevRec Standard and +Recurly RevRec Advanced features. + + * + * @return ?string + */ + public function getRevenueGlAccountId(): ?string + { + return $this->_revenue_gl_account_id; + } + + /** + * Setter method for the revenue_gl_account_id attribute. + * + * @param string $revenue_gl_account_id + * + * @return void + */ + public function setRevenueGlAccountId(string $revenue_gl_account_id): void + { + $this->_revenue_gl_account_id = $revenue_gl_account_id; + } + /** * Getter method for the unit_amount attribute. * The amount of the gift card, which is the amount of the charge to the gifter account and the amount of credit that is applied to the recipient account upon successful redemption. diff --git a/lib/recurly/resources/item.php b/lib/recurly/resources/item.php index 07c8abf4..c539eda4 100644 --- a/lib/recurly/resources/item.php +++ b/lib/recurly/resources/item.php @@ -23,8 +23,11 @@ class Item extends RecurlyResource private $_description; private $_external_sku; private $_id; + private $_liability_gl_account_id; private $_name; private $_object; + private $_performance_obligation_id; + private $_revenue_gl_account_id; private $_revenue_schedule_type; private $_state; private $_tax_code; @@ -290,6 +293,32 @@ public function setId(string $id): void $this->_id = $id; } + /** + * Getter method for the liability_gl_account_id attribute. + * The ID of a general ledger account. General ledger accounts are +only accessible as a part of the Recurly RevRec Standard and +Recurly RevRec Advanced features. + + * + * @return ?string + */ + public function getLiabilityGlAccountId(): ?string + { + return $this->_liability_gl_account_id; + } + + /** + * Setter method for the liability_gl_account_id attribute. + * + * @param string $liability_gl_account_id + * + * @return void + */ + public function setLiabilityGlAccountId(string $liability_gl_account_id): void + { + $this->_liability_gl_account_id = $liability_gl_account_id; + } + /** * Getter method for the name attribute. * This name describes your item and will appear on the invoice when it's purchased on a one time basis. @@ -336,6 +365,58 @@ public function setObject(string $object): void $this->_object = $object; } + /** + * Getter method for the performance_obligation_id attribute. + * The ID of a performance obligation. Performance obligations are +only accessible as a part of the Recurly RevRec Standard and +Recurly RevRec Advanced features. + + * + * @return ?string + */ + public function getPerformanceObligationId(): ?string + { + return $this->_performance_obligation_id; + } + + /** + * Setter method for the performance_obligation_id attribute. + * + * @param string $performance_obligation_id + * + * @return void + */ + public function setPerformanceObligationId(string $performance_obligation_id): void + { + $this->_performance_obligation_id = $performance_obligation_id; + } + + /** + * Getter method for the revenue_gl_account_id attribute. + * The ID of a general ledger account. General ledger accounts are +only accessible as a part of the Recurly RevRec Standard and +Recurly RevRec Advanced features. + + * + * @return ?string + */ + public function getRevenueGlAccountId(): ?string + { + return $this->_revenue_gl_account_id; + } + + /** + * Setter method for the revenue_gl_account_id attribute. + * + * @param string $revenue_gl_account_id + * + * @return void + */ + public function setRevenueGlAccountId(string $revenue_gl_account_id): void + { + $this->_revenue_gl_account_id = $revenue_gl_account_id; + } + /** * Getter method for the revenue_schedule_type attribute. * Revenue schedule type diff --git a/lib/recurly/resources/line_item.php b/lib/recurly/resources/line_item.php index 1e86f217..6d3ba73d 100644 --- a/lib/recurly/resources/line_item.php +++ b/lib/recurly/resources/line_item.php @@ -26,6 +26,7 @@ class LineItem extends RecurlyResource private $_currency; private $_custom_fields; private $_description; + private $_destination_tax_address_source; private $_discount; private $_end_date; private $_external_sku; @@ -35,9 +36,12 @@ class LineItem extends RecurlyResource private $_item_code; private $_item_id; private $_legacy_category; + private $_liability_gl_account_code; private $_object; private $_origin; + private $_origin_tax_address_source; private $_original_line_item_invoice_id; + private $_performance_obligation_id; private $_plan_code; private $_plan_id; private $_previous_line_item_id; @@ -48,6 +52,7 @@ class LineItem extends RecurlyResource private $_refund; private $_refunded_quantity; private $_refunded_quantity_decimal; + private $_revenue_gl_account_code; private $_revenue_schedule_type; private $_shipping_address; private $_start_date; @@ -393,6 +398,29 @@ public function setDescription(string $description): void $this->_description = $description; } + /** + * Getter method for the destination_tax_address_source attribute. + * The source of the address that will be used as the destinaion in determining taxes. Available only when the site is on an Elite plan. A value of "destination" refers to the "Customer tax address". A value of "origin" refers to the "Business entity tax address". + * + * @return ?string + */ + public function getDestinationTaxAddressSource(): ?string + { + return $this->_destination_tax_address_source; + } + + /** + * Setter method for the destination_tax_address_source attribute. + * + * @param string $destination_tax_address_source + * + * @return void + */ + public function setDestinationTaxAddressSource(string $destination_tax_address_source): void + { + $this->_destination_tax_address_source = $destination_tax_address_source; + } + /** * Getter method for the discount attribute. * The discount applied to the line item. @@ -605,6 +633,32 @@ public function setLegacyCategory(string $legacy_category): void $this->_legacy_category = $legacy_category; } + /** + * Getter method for the liability_gl_account_code attribute. + * Unique code to identify the ledger account. Each code must start +with a letter or number. The following special characters are +allowed: `-_.,:` + + * + * @return ?string + */ + public function getLiabilityGlAccountCode(): ?string + { + return $this->_liability_gl_account_code; + } + + /** + * Setter method for the liability_gl_account_code attribute. + * + * @param string $liability_gl_account_code + * + * @return void + */ + public function setLiabilityGlAccountCode(string $liability_gl_account_code): void + { + $this->_liability_gl_account_code = $liability_gl_account_code; + } + /** * Getter method for the object attribute. * Object type @@ -651,6 +705,29 @@ public function setOrigin(string $origin): void $this->_origin = $origin; } + /** + * Getter method for the origin_tax_address_source attribute. + * The source of the address that will be used as the origin in determining taxes. Available only when the site is on an Elite plan. A value of "origin" refers to the "Business entity tax address". A value of "destination" refers to the "Customer tax address". + * + * @return ?string + */ + public function getOriginTaxAddressSource(): ?string + { + return $this->_origin_tax_address_source; + } + + /** + * Setter method for the origin_tax_address_source attribute. + * + * @param string $origin_tax_address_source + * + * @return void + */ + public function setOriginTaxAddressSource(string $origin_tax_address_source): void + { + $this->_origin_tax_address_source = $origin_tax_address_source; + } + /** * Getter method for the original_line_item_invoice_id attribute. * The invoice where the credit originated. Will only have a value if the line item is a credit created from a previous credit, or if the credit was created from a charge refund. @@ -674,6 +751,32 @@ public function setOriginalLineItemInvoiceId(string $original_line_item_invoice_ $this->_original_line_item_invoice_id = $original_line_item_invoice_id; } + /** + * Getter method for the performance_obligation_id attribute. + * The ID of a performance obligation. Performance obligations are +only accessible as a part of the Recurly RevRec Standard and +Recurly RevRec Advanced features. + + * + * @return ?string + */ + public function getPerformanceObligationId(): ?string + { + return $this->_performance_obligation_id; + } + + /** + * Setter method for the performance_obligation_id attribute. + * + * @param string $performance_obligation_id + * + * @return void + */ + public function setPerformanceObligationId(string $performance_obligation_id): void + { + $this->_performance_obligation_id = $performance_obligation_id; + } + /** * Getter method for the plan_code attribute. * If the line item is a charge or credit for a plan or add-on, this is the plan's code. @@ -904,6 +1007,32 @@ public function setRefundedQuantityDecimal(string $refunded_quantity_decimal): v $this->_refunded_quantity_decimal = $refunded_quantity_decimal; } + /** + * Getter method for the revenue_gl_account_code attribute. + * Unique code to identify the ledger account. Each code must start +with a letter or number. The following special characters are +allowed: `-_.,:` + + * + * @return ?string + */ + public function getRevenueGlAccountCode(): ?string + { + return $this->_revenue_gl_account_code; + } + + /** + * Setter method for the revenue_gl_account_code attribute. + * + * @param string $revenue_gl_account_code + * + * @return void + */ + public function setRevenueGlAccountCode(string $revenue_gl_account_code): void + { + $this->_revenue_gl_account_code = $revenue_gl_account_code; + } + /** * Getter method for the revenue_schedule_type attribute. * Revenue schedule type diff --git a/lib/recurly/resources/performance_obligation.php b/lib/recurly/resources/performance_obligation.php new file mode 100644 index 00000000..16add657 --- /dev/null +++ b/lib/recurly/resources/performance_obligation.php @@ -0,0 +1,118 @@ +_created_at; + } + + /** + * Setter method for the created_at attribute. + * + * @param string $created_at + * + * @return void + */ + public function setCreatedAt(string $created_at): void + { + $this->_created_at = $created_at; + } + + /** + * Getter method for the id attribute. + * The ID of a performance obligation. Performance obligations are +only accessible as a part of the Recurly RevRec Standard and +Recurly RevRec Advanced features. + + * + * @return ?string + */ + public function getId(): ?string + { + return $this->_id; + } + + /** + * Setter method for the id attribute. + * + * @param string $id + * + * @return void + */ + public function setId(string $id): void + { + $this->_id = $id; + } + + /** + * Getter method for the name attribute. + * Performance Obligation Name + * + * @return ?string + */ + public function getName(): ?string + { + return $this->_name; + } + + /** + * Setter method for the name attribute. + * + * @param string $name + * + * @return void + */ + public function setName(string $name): void + { + $this->_name = $name; + } + + /** + * Getter method for the updated_at attribute. + * Last updated at + * + * @return ?string + */ + public function getUpdatedAt(): ?string + { + return $this->_updated_at; + } + + /** + * Setter method for the updated_at attribute. + * + * @param string $updated_at + * + * @return void + */ + public function setUpdatedAt(string $updated_at): void + { + $this->_updated_at = $updated_at; + } +} \ No newline at end of file diff --git a/lib/recurly/resources/shipping_method.php b/lib/recurly/resources/shipping_method.php index 897b17cd..a7929ab8 100644 --- a/lib/recurly/resources/shipping_method.php +++ b/lib/recurly/resources/shipping_method.php @@ -17,8 +17,11 @@ class ShippingMethod extends RecurlyResource private $_created_at; private $_deleted_at; private $_id; + private $_liability_gl_account_id; private $_name; private $_object; + private $_performance_obligation_id; + private $_revenue_gl_account_id; private $_tax_code; private $_updated_at; @@ -141,6 +144,32 @@ public function setId(string $id): void $this->_id = $id; } + /** + * Getter method for the liability_gl_account_id attribute. + * The ID of a general ledger account. General ledger accounts are +only accessible as a part of the Recurly RevRec Standard and +Recurly RevRec Advanced features. + + * + * @return ?string + */ + public function getLiabilityGlAccountId(): ?string + { + return $this->_liability_gl_account_id; + } + + /** + * Setter method for the liability_gl_account_id attribute. + * + * @param string $liability_gl_account_id + * + * @return void + */ + public function setLiabilityGlAccountId(string $liability_gl_account_id): void + { + $this->_liability_gl_account_id = $liability_gl_account_id; + } + /** * Getter method for the name attribute. * The name of the shipping method displayed to customers. @@ -187,6 +216,58 @@ public function setObject(string $object): void $this->_object = $object; } + /** + * Getter method for the performance_obligation_id attribute. + * The ID of a performance obligation. Performance obligations are +only accessible as a part of the Recurly RevRec Standard and +Recurly RevRec Advanced features. + + * + * @return ?string + */ + public function getPerformanceObligationId(): ?string + { + return $this->_performance_obligation_id; + } + + /** + * Setter method for the performance_obligation_id attribute. + * + * @param string $performance_obligation_id + * + * @return void + */ + public function setPerformanceObligationId(string $performance_obligation_id): void + { + $this->_performance_obligation_id = $performance_obligation_id; + } + + /** + * Getter method for the revenue_gl_account_id attribute. + * The ID of a general ledger account. General ledger accounts are +only accessible as a part of the Recurly RevRec Standard and +Recurly RevRec Advanced features. + + * + * @return ?string + */ + public function getRevenueGlAccountId(): ?string + { + return $this->_revenue_gl_account_id; + } + + /** + * Setter method for the revenue_gl_account_id attribute. + * + * @param string $revenue_gl_account_id + * + * @return void + */ + public function setRevenueGlAccountId(string $revenue_gl_account_id): void + { + $this->_revenue_gl_account_id = $revenue_gl_account_id; + } + /** * Getter method for the tax_code attribute. * Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax diff --git a/openapi/api.yaml b/openapi/api.yaml index 29d475d6..5992ef44 100644 --- a/openapi/api.yaml +++ b/openapi/api.yaml @@ -230,6 +230,8 @@ x-tagGroups: - shipping_method - dunning_campaigns - business_entities + - general_ledger_account + - performance_obligations tags: - name: site x-displayName: Site @@ -242,7 +244,7 @@ tags: description: |- 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". - Recurly's item catalog requires the Credit Invoices features to be enabled. + Recurly's item catalog requires the Credit Invoices feature to be enabled. - name: plan x-displayName: Plan description: A plan tells Recurly how often and how much to charge your customers. @@ -385,6 +387,55 @@ tags: x-displayName: Business Entities description: Describes the business address that will be used for invoices and taxes depending on settings and subscriber location. +- name: general_ledger_account + x-displayName: General Ledger Account + description: | + A general ledger account is an account of record used to sort, store + and summarize a company's transactions. Recurly supports the balance + sheet (Liability) account and income (Revenue) account to be attached + to business entities, plans, or at the item level. + + When invoices are created, system can default to the accounts based + on the GL Accounts attached at the plan/item level. The accounts can + be defaulted from the business entity level as well. + + These accounts will be used in the Revenue Recognition module to create + the revenue journals that can be posted into Merchant GL system. + + Revenue and Liability accounts can defined in the system using this + API or via the General Ledger Accounting page in the Admin UI and then + used at the plan/item level. + + Recurly allows merchants to default the accounts at the following levels: + - Business Entities (default) + - Plans + - Base Price + - Setup Fee + - Add-ons + - Items + - Charges + - Gift Cards + - Shipping Methods + - Credits + + If you are interested in Recurly Revenue Recognition features, please + contact a Recurly customer service representative. +- name: performance_obligations + x-displayName: Performance Obligations + description: | + A performance obligation is a promise to provide a distinct good or + service or a series of distinct goods or services as defined by the revenue standard. + Performance obligations are completed and revenue is recognized either at a point in + time or over a period of time, depending on the type of obligation. + - Point in time a company has to go through the criteria and determine if a performance + obligation is satisfied over time. If it does not meet those criteria, then the performance + obligation is satisfied and revenue recognized at the point in time when control of the good + or service is transferred to the customer. + - Over a period of time a performance obligation is satisfied and revenue is recognized over + time if at least one of the following are met: + - The customer receives and consumes the benefits of the goods or services as they are provided + by the entity (routine, recurring services like a cleaning service are an example of a series of + services that are substantially the same and have the same pattern of transfer) paths: "/sites": get: @@ -6566,7 +6617,7 @@ paths: - "$ref": "#/components/parameters/custom_field_definition_id" responses: '200': - description: An custom field definition. + description: A custom field definition. content: application/json: schema: @@ -6672,6 +6723,150 @@ paths: {\n\t\tfmt.Printf(\"Resource not found: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected Recurly error: %v\", e)\n\treturn nil, err\n}\nfmt.Printf(\"Fetched Custom Field Definition: %s\", definition.Id)" + "/general_ledger_accounts": + post: + tags: + - general_ledger_account + operationId: create_general_ledger_account + summary: Create a new general ledger account + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/GeneralLedgerAccountCreate" + required: true + responses: + '201': + description: A new general ledger account. + content: + application/json: + schema: + "$ref": "#/components/schemas/GeneralLedgerAccount" + default: + description: Unexpected error. + content: + application/json: + schema: + "$ref": "#/components/schemas/Error" + x-code-samples: [] + get: + tags: + - general_ledger_account + operationId: list_general_ledger_accounts + summary: List a site's general ledger accounts + description: See the [Pagination Guide](/developers/guides/pagination.html) + to learn how to use pagination in the API and Client Libraries. + parameters: + - "$ref": "#/components/parameters/ids" + - "$ref": "#/components/parameters/limit" + - "$ref": "#/components/parameters/order" + - "$ref": "#/components/parameters/sort_dates" + - "$ref": "#/components/parameters/general_ledger_account_type_enum" + responses: + '200': + description: A list of the site's general ledger accounts. + content: + application/json: + schema: + "$ref": "#/components/schemas/GeneralLedgerAccountList" + '404': + description: Incorrect site ID. + content: + application/json: + schema: + "$ref": "#/components/schemas/Error" + x-code-samples: [] + "/general_ledger_accounts/{general_ledger_account_id}": + get: + tags: + - general_ledger_account + operationId: get_general_ledger_account + summary: Fetch a general ledger account + parameters: + - "$ref": "#/components/parameters/general_ledger_account_id" + responses: + '200': + description: A general ledger account. + content: + application/json: + schema: + "$ref": "#/components/schemas/GeneralLedgerAccount" + '404': + description: Incorrect site or general ledger account ID. + content: + application/json: + schema: + "$ref": "#/components/schemas/Error" + x-code-samples: [] + put: + tags: + - general_ledger_account + operationId: update_general_ledger_account + summary: Update a general ledger account + parameters: + - "$ref": "#/components/parameters/general_ledger_account_id" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/GeneralLedgerAccountUpdate" + required: true + responses: + '200': + description: The updated general ledger account. + content: + application/json: + schema: + "$ref": "#/components/schemas/GeneralLedgerAccount" + '404': + description: Incorrect site or general ledger account ID. + content: + application/json: + schema: + "$ref": "#/components/schemas/Error" + x-code-samples: [] + "/performance_obligations/{performance_obligation_id}": + get: + tags: + - performance_obligations + operationId: get_performance_obligation + summary: Get a single Performance Obligation. + parameters: + - "$ref": "#/components/parameters/performance_obligation_id" + responses: + '200': + description: A single Performance Obligation. + content: + application/json: + schema: + "$ref": "#/components/schemas/PerformanceObligation" + default: + description: Unexpected error. + content: + application/json: + schema: + "$ref": "#/components/schemas/Error" + x-code-samples: [] + "/performance_obligations": + get: + tags: + - performance_obligations + operationId: get_performance_obligations + summary: Get a site's Performance Obligations + responses: + '200': + description: A list of Performance Obligations. + content: + application/json: + schema: + "$ref": "#/components/schemas/PerformanceObligationList" + default: + description: Unexpected error. + content: + application/json: + schema: + "$ref": "#/components/schemas/Error" + x-code-samples: [] "/invoice_templates/{invoice_template_id}/accounts": get: tags: @@ -8034,7 +8229,7 @@ paths: x-code-samples: [] "/external_subscriptions/{external_subscription_id}": parameters: - - "$ref": "#/components/parameters/external_subscription_id" + - "$ref": "#/components/parameters/external_subscription_id_fetch" get: tags: - external_subscriptions @@ -16093,10 +16288,10 @@ paths: tags: - external_payment_phases operationId: get_external_subscription_external_payment_phase - summary: Fetch an external payment_phase + summary: Fetch an external payment phase responses: '200': - description: Details for an external payment_phase. + description: Details for an external payment phase. content: application/json: schema: @@ -16545,6 +16740,14 @@ components: required: true schema: type: string + external_subscription_id_fetch: + name: external_subscription_id + in: path + description: External subscription ID or external_id. For ID no prefix is used + e.g. `e28zov4fw0v2`. For external_id use prefix `external-id-`, e.g. `external-id-123456`. + required: true + schema: + type: string external_subscription_id: name: external_subscription_id in: path @@ -16559,6 +16762,25 @@ components: required: true schema: type: string + general_ledger_account_id: + name: general_ledger_account_id + in: path + description: General Ledger Account ID + required: true + schema: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + general_ledger_account_type_enum: + name: account_type + in: query + description: General Ledger Account type by which to filter the response. + schema: + "$ref": "#/components/schemas/GeneralLedgerAccountTypeEnum" invoice_template_id: name: invoice_template_id in: path @@ -16604,6 +16826,19 @@ components: required: true schema: type: string + performance_obligation_id: + name: performance_obligation_id + in: path + description: Performance Obligation id. + required: true + schema: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 plan_id: name: plan_id in: path @@ -17858,6 +18093,30 @@ components: description: System-generated unique identifier for an measured unit associated with the add-on. maxLength: 13 + liability_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + revenue_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + performance_obligation_id: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 accounting_code: type: string title: Accounting code @@ -17972,7 +18231,7 @@ components: type: string title: Item Code description: Unique code to identify an item. Available when the `Credit - Invoices` feature are enabled. If `item_id` and `item_code` are both present, + Invoices` feature is enabled. If `item_id` and `item_code` are both present, `item_id` will be used. pattern: "/^[a-z0-9_+-]+$/" maxLength: 50 @@ -18031,6 +18290,30 @@ components: title: Plan ID maxLength: 13 readOnly: true + liability_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + revenue_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + performance_obligation_id: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 accounting_code: type: string title: Accounting code @@ -18100,7 +18383,7 @@ components: minItems: 1 description: | * If `item_code`/`item_id` is part of the request and the item - has a default currency then `currencies` is optional. If the item does + has a default currency, then `currencies` is optional. If the item does not have a default currency, then `currencies` is required. If `item_code`/`item_id` is not present `currencies` is required. * If the add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, @@ -18189,6 +18472,30 @@ components: to the `AddOn` then `accounting code` must be absent. pattern: "/^[a-z0-9_+-]+$/" maxLength: 20 + liability_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + revenue_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + performance_obligation_id: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 revenue_schedule_type: title: Revenue schedule type description: When this add-on is invoiced, the line item will use this revenue @@ -18271,7 +18578,7 @@ components: `percentage_tiers` is an array of objects, which must have the set of tiers per currency and the currency code. The tier_type must be `volume` or `tiered`, if not, it must be absent. There must be one tier without an `ending_amount` value - which represents the final tier. This feature is currently in development and + which represents the final tier. This feature is currently in development and requires approval and enablement, please contact support. BillingInfo: type: object @@ -19210,6 +19517,171 @@ components: are removed from the accouts or subscriptions, will be hard deleted an no longer visible. readOnly: true + GeneralLedgerAccountId: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + GeneralLedgerAccountCode: + type: string + title: Accounting code for the ledger account. + description: | + Unique code to identify the ledger account. Each code must start + with a letter or number. The following special characters are + allowed: `-_.,:` + pattern: "/^[A-Za-z0-9](( *)?[\\-A-Za-z0-9_.,:])*$/" + maxLength: 255 + GeneralLedgerAccountDescription: + type: string + title: Description + description: Optional description. + maxLength: 255 + GeneralLedgerAccount: + type: object + description: Full general ledger account details. + properties: + id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + object: + type: string + title: Object type + default: general_ledger_account + readOnly: true + code: + type: string + title: Accounting code for the ledger account. + description: | + Unique code to identify the ledger account. Each code must start + with a letter or number. The following special characters are + allowed: `-_.,:` + pattern: "/^[A-Za-z0-9](( *)?[\\-A-Za-z0-9_.,:])*$/" + maxLength: 255 + description: + type: string + title: Description + description: Optional description. + maxLength: 255 + account_type: + "$ref": "#/components/schemas/GeneralLedgerAccountTypeEnum" + created_at: + type: string + format: date-time + title: Created at + readOnly: true + updated_at: + type: string + format: date-time + title: Last updated at + readOnly: true + GeneralLedgerAccountList: + type: object + properties: + object: + type: string + title: Object type + description: Will always be List. + has_more: + type: boolean + description: Indicates there are more results on subsequent pages. + next: + type: string + description: Path to subsequent page of results. + data: + type: array + items: + "$ref": "#/components/schemas/GeneralLedgerAccount" + GeneralLedgerAccountCreate: + type: object + description: Create a new liability or revenue general ledger account. + properties: + code: + type: string + title: Accounting code for the ledger account. + description: | + Unique code to identify the ledger account. Each code must start + with a letter or number. The following special characters are + allowed: `-_.,:` + pattern: "/^[A-Za-z0-9](( *)?[\\-A-Za-z0-9_.,:])*$/" + maxLength: 255 + description: + type: string + title: Description + description: Optional description. + maxLength: 255 + account_type: + "$ref": "#/components/schemas/GeneralLedgerAccountTypeEnum" + GeneralLedgerAccountUpdate: + type: object + description: Update an existing general ledger account. + properties: + code: + type: string + title: Accounting code for the ledger account. + description: | + Unique code to identify the ledger account. Each code must start + with a letter or number. The following special characters are + allowed: `-_.,:` + pattern: "/^[A-Za-z0-9](( *)?[\\-A-Za-z0-9_.,:])*$/" + maxLength: 255 + description: + type: string + title: Description + description: Optional description. + maxLength: 255 + PerformanceObligationId: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + PerformanceObligation: + type: object + description: Performance obligation details + properties: + id: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + name: + title: Performance Obligation Name + type: string + created_at: + title: Created At + type: string + readOnly: true + format: date-time + updated_at: + title: Last updated at + type: string + readOnly: true + format: date-time + PerformanceObligationList: + type: object + description: List of Performance Obligations + properties: + object: + title: Object type + type: string + data: + title: Performance Obligation + type: array + items: + "$ref": "#/components/schemas/PerformanceObligation" ItemMini: type: object title: Item mini details @@ -19294,6 +19766,30 @@ components: revenue_schedule_type: title: Revenue schedule type "$ref": "#/components/schemas/RevenueScheduleTypeEnum" + performance_obligation_id: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + liability_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + revenue_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 avalara_transaction_type: type: integer title: Avalara Transaction Type @@ -19378,6 +19874,30 @@ components: revenue_schedule_type: title: Revenue schedule type "$ref": "#/components/schemas/RevenueScheduleTypeEnum" + performance_obligation_id: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + liability_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + revenue_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 avalara_transaction_type: type: integer title: Avalara Transaction Type @@ -19450,6 +19970,30 @@ components: revenue_schedule_type: title: Revenue schedule type "$ref": "#/components/schemas/RevenueScheduleTypeEnum" + performance_obligation_id: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + liability_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + revenue_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 avalara_transaction_type: type: integer title: Avalara Transaction Type @@ -20269,6 +20813,32 @@ components: format: float title: Discount description: The discount applied to the line item. + liability_gl_account_code: + type: string + title: Accounting code for the ledger account. + description: | + Unique code to identify the ledger account. Each code must start + with a letter or number. The following special characters are + allowed: `-_.,:` + pattern: "/^[A-Za-z0-9](( *)?[\\-A-Za-z0-9_.,:])*$/" + maxLength: 255 + revenue_gl_account_code: + type: string + title: Accounting code for the ledger account. + description: | + Unique code to identify the ledger account. Each code must start + with a letter or number. The following special characters are + allowed: `-_.,:` + pattern: "/^[A-Za-z0-9](( *)?[\\-A-Za-z0-9_.,:])*$/" + maxLength: 255 + performance_obligation_id: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 tax: type: number format: float @@ -20310,6 +20880,10 @@ components: maxLength: 50 tax_info: "$ref": "#/components/schemas/TaxInfo" + origin_tax_address_source: + "$ref": "#/components/schemas/OriginTaxAddressSourceEnum" + destination_tax_address_source: + "$ref": "#/components/schemas/DestinationTaxAddressSourceEnum" proration_rate: type: number format: float @@ -20470,6 +21044,30 @@ components: is part of the request then `accounting_code` must be absent. pattern: "/^[a-z0-9_+-]+$/" maxLength: 20 + liability_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + revenue_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + performance_obligation_id: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 tax_exempt: type: boolean title: Tax exempt? @@ -20537,6 +21135,10 @@ components: format: date-time title: End date description: If this date is provided, it indicates the end of a time range. + origin_tax_address_source: + "$ref": "#/components/schemas/OriginTaxAddressSourceEnum" + destination_tax_address_source: + "$ref": "#/components/schemas/DestinationTaxAddressSourceEnum" required: - currency - unit_amount @@ -20834,6 +21436,54 @@ components: revenue_schedule_type: title: Revenue schedule type "$ref": "#/components/schemas/RevenueScheduleTypeEnum" + liability_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + revenue_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + performance_obligation_id: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + setup_fee_liability_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + setup_fee_revenue_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + setup_fee_performance_obligation_id: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 setup_fee_revenue_schedule_type: title: Setup fee revenue schedule type "$ref": "#/components/schemas/RevenueScheduleTypeEnum" @@ -21050,6 +21700,54 @@ components: revenue_schedule_type: title: Revenue schedule type "$ref": "#/components/schemas/RevenueScheduleTypeEnum" + liability_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + revenue_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + performance_obligation_id: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + setup_fee_liability_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + setup_fee_revenue_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + setup_fee_performance_obligation_id: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 setup_fee_revenue_schedule_type: title: Setup fee revenue schedule type "$ref": "#/components/schemas/RevenueScheduleTypeEnum" @@ -21508,6 +22206,30 @@ components: - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable maxLength: 50 + liability_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + revenue_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + performance_obligation_id: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 created_at: type: string format: date-time @@ -21580,6 +22302,30 @@ components: - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable maxLength: 50 + liability_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + revenue_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + performance_obligation_id: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 required: - code - name @@ -21618,6 +22364,30 @@ components: - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable maxLength: 50 + liability_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + revenue_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + performance_obligation_id: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 ShippingFeeCreate: type: object properties: @@ -23980,8 +24750,6 @@ components: object: type: string title: Object type - external_subscription: - "$ref": "#/components/schemas/ExternalSubscription" started_at: type: string format: date-time @@ -24279,6 +25047,12 @@ components: "$ref": "#/components/schemas/AccountMini" external_product_reference: "$ref": "#/components/schemas/ExternalProductReferenceMini" + external_payment_phases: + type: array + title: External payment phases + description: The phases of the external subscription payment lifecycle. + items: + "$ref": "#/components/schemas/ExternalPaymentPhase" external_id: type: string title: External Id @@ -24352,6 +25126,12 @@ components: description: An indication of whether or not the external subscription was purchased in a sandbox environment. default: false + imported: + type: boolean + title: Imported + description: An indication of whether or not the external subscription was + created by a historical data import. + default: false created_at: type: string format: date-time @@ -24682,6 +25462,10 @@ components: description: Address information for the business entity that will be used for calculating taxes. "$ref": "#/components/schemas/Address" + origin_tax_address_source: + "$ref": "#/components/schemas/OriginTaxAddressSourceEnum" + destination_tax_address_source: + "$ref": "#/components/schemas/DestinationTaxAddressSourceEnum" default_vat_number: type: string title: Default VAT number @@ -24699,6 +25483,22 @@ components: items: type: string title: Country code + default_liability_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + default_revenue_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 created_at: type: string format: date-time @@ -24797,6 +25597,30 @@ components: description: The delivery details for the gift card. readOnly: true "$ref": "#/components/schemas/GiftCardDelivery" + performance_obligation_id: + type: string + title: Performance Obligation ID + description: | + The ID of a performance obligation. Performance obligations are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + liability_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 + revenue_gl_account_id: + type: string + title: General Ledger Account ID + description: | + The ID of a general ledger account. General ledger accounts are + only accessible as a part of the Recurly RevRec Standard and + Recurly RevRec Advanced features. + maxLength: 13 created_at: type: string format: date-time @@ -25978,3 +26802,30 @@ components: type: string enum: - paid + GeneralLedgerAccountTypeEnum: + type: string + enum: + - liability + - revenue + OriginTaxAddressSourceEnum: + type: string + title: Origin tax address source + description: The source of the address that will be used as the origin in determining + taxes. Available only when the site is on an Elite plan. A value of "origin" + refers to the "Business entity tax address". A value of "destination" refers + to the "Customer tax address". + default: origin + enum: + - origin + - destination + DestinationTaxAddressSourceEnum: + type: string + title: Destination tax address source + description: The source of the address that will be used as the destinaion in + determining taxes. Available only when the site is on an Elite plan. A value + of "destination" refers to the "Customer tax address". A value of "origin" + refers to the "Business entity tax address". + default: destination + enum: + - destination + - origin