bf_ruby2 1.2016.229
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/LICENSE +201 -0
- data/README.md +824 -0
- data/bf_ruby2-1.0.0.gem +0 -0
- data/bf_ruby2.gemspec +55 -0
- data/docs/APIConfigurationPagedMetadata.md +14 -0
- data/docs/APIQuote.md +36 -0
- data/docs/APIQuotePagedMetadata.md +14 -0
- data/docs/APIQuoteResponseQuantity.md +25 -0
- data/docs/Account.md +21 -0
- data/docs/AccountLTVResultPagedMetadata.md +14 -0
- data/docs/AccountPagedMetadata.md +14 -0
- data/docs/AccountPaymentsResultPagedMetadata.md +14 -0
- data/docs/AccountsApi.md +1021 -0
- data/docs/AddChargeRequest.md +23 -0
- data/docs/AddCouponCodeRequest.md +11 -0
- data/docs/AddPaymentMethodRequest.md +8 -0
- data/docs/AddTaxationStrategyRequest.md +11 -0
- data/docs/Address.md +23 -0
- data/docs/AddressPagedMetadata.md +14 -0
- data/docs/AddressesApi.md +104 -0
- data/docs/AggregatingComponent.md +17 -0
- data/docs/Amendment.md +19 -0
- data/docs/AmendmentDiscardAmendment.md +20 -0
- data/docs/AmendmentPagedMetadata.md +14 -0
- data/docs/AmendmentPriceNTimePagedMetadata.md +14 -0
- data/docs/AmendmentsApi.md +639 -0
- data/docs/AnalyticsApi.md +641 -0
- data/docs/AuditEntry.md +17 -0
- data/docs/AuditEntryPagedMetadata.md +14 -0
- data/docs/AuditlogsApi.md +308 -0
- data/docs/AuthCaptureRequest.md +17 -0
- data/docs/AuthorizeNetTokenPagedMetadata.md +14 -0
- data/docs/BFError.md +11 -0
- data/docs/BFPermission.md +17 -0
- data/docs/BFPermissionPagedMetadata.md +14 -0
- data/docs/BankAccountVerificationPagedMetadata.md +14 -0
- data/docs/BillforwardManagedPaymentsResultPagedMetadata.md +14 -0
- data/docs/BillingEntityBase.md +8 -0
- data/docs/BraintreeAuthCaptureRequest.md +19 -0
- data/docs/BraintreeCaptureRequest.md +20 -0
- data/docs/BraintreeTokenPagedMetadata.md +14 -0
- data/docs/CancelSubscriptionRequest.md +14 -0
- data/docs/CancellationAmendment.md +24 -0
- data/docs/CassChurnResultPagedMetadata.md +14 -0
- data/docs/CassPaymentResultPagedMetadata.md +14 -0
- data/docs/CassUpgradeResultPagedMetadata.md +14 -0
- data/docs/ChargesApi.md +408 -0
- data/docs/Client.md +21 -0
- data/docs/ClientPagedMetadata.md +14 -0
- data/docs/ClientsApi.md +215 -0
- data/docs/ComponentChange.md +20 -0
- data/docs/ComponentCost.md +9 -0
- data/docs/CompoundUsage.md +11 -0
- data/docs/CompoundUsageSession.md +11 -0
- data/docs/ConfigurationsApi.md +221 -0
- data/docs/Coupon.md +32 -0
- data/docs/CouponBook.md +21 -0
- data/docs/CouponBookDefinition.md +24 -0
- data/docs/CouponBookDefinitionPagedMetadata.md +14 -0
- data/docs/CouponBookPagedMetadata.md +14 -0
- data/docs/CouponDefinition.md +26 -0
- data/docs/CouponDefinitionPagedMetadata.md +14 -0
- data/docs/CouponDiscount.md +18 -0
- data/docs/CouponDiscountEstimate.md +13 -0
- data/docs/CouponInstance.md +26 -0
- data/docs/CouponInstanceExistingValue.md +15 -0
- data/docs/CouponInstancePagedMetadata.md +14 -0
- data/docs/CouponModifierBase.md +22 -0
- data/docs/CouponModifierBasePagedMetadata.md +14 -0
- data/docs/CouponPagedMetadata.md +14 -0
- data/docs/CouponRule.md +24 -0
- data/docs/CouponRulePagedMetadata.md +14 -0
- data/docs/CouponUniqueCodesRequest.md +11 -0
- data/docs/CouponUniqueCodesResponse.md +10 -0
- data/docs/CouponUniqueCodesResponsePagedMetadata.md +14 -0
- data/docs/CouponWrapperResponse.md +13 -0
- data/docs/CouponbookApi.md +496 -0
- data/docs/CouponbookdefinitionApi.md +329 -0
- data/docs/CoupondefinitionApi.md +267 -0
- data/docs/CouponinstanceApi.md +578 -0
- data/docs/CouponmodifierApi.md +369 -0
- data/docs/CouponruleApi.md +269 -0
- data/docs/CouponsApi.md +456 -0
- data/docs/CreateAccountProfileRequest.md +20 -0
- data/docs/CreateAccountRequest.md +13 -0
- data/docs/CreateAddressRequest.md +17 -0
- data/docs/CreateAggregatingComponentRequest.md +10 -0
- data/docs/CreateAggregatingSubscriptionRequest.md +21 -0
- data/docs/CreateProfileAddressRequest.md +16 -0
- data/docs/CreateSubscriptionBatchRequest.md +10 -0
- data/docs/CreateSubscriptionChargeAmendment.md +29 -0
- data/docs/CreateSubscriptionRequest.md +26 -0
- data/docs/CreditAccountRequest.md +13 -0
- data/docs/CreditNote.md +21 -0
- data/docs/CreditNotePagedMetadata.md +14 -0
- data/docs/CreditSubscriptionRequest.md +12 -0
- data/docs/CreditnotesApi.md +339 -0
- data/docs/CybersourceTokenPagedMetadata.md +14 -0
- data/docs/CybersourcetokensApi.md +259 -0
- data/docs/DataSynchronisationAppConfigurationPagedMetadata.md +14 -0
- data/docs/DataSynchronisationConfiguration.md +20 -0
- data/docs/DataSynchronisationConfigurationPagedMetadata.md +14 -0
- data/docs/DataSynchronizationJobPagedMetadata.md +14 -0
- data/docs/DebtsResultPagedMetadata.md +14 -0
- data/docs/DunningLine.md +18 -0
- data/docs/DunningLinePagedMetadata.md +14 -0
- data/docs/DunninglinesApi.md +328 -0
- data/docs/DynamicMetadata.md +7 -0
- data/docs/Email.md +35 -0
- data/docs/EmailPagedMetadata.md +14 -0
- data/docs/EmailProvider.md +18 -0
- data/docs/EmailProviderPagedMetadata.md +14 -0
- data/docs/EmailSubscription.md +20 -0
- data/docs/EmailSubscriptionPagedMetadata.md +14 -0
- data/docs/EmailprovidersApi.md +221 -0
- data/docs/EmailsApi.md +164 -0
- data/docs/EmailsubscriptionsApi.md +273 -0
- data/docs/EndTrialAmendment.md +19 -0
- data/docs/Event.md +15 -0
- data/docs/EventData.md +9 -0
- data/docs/FileSham.md +7 -0
- data/docs/FixedTerm.md +24 -0
- data/docs/FixedTermDefinitionPagedMetadata.md +14 -0
- data/docs/FixedTermExpiryAmendment.md +20 -0
- data/docs/FixedTermPagedMetadata.md +14 -0
- data/docs/FixedtermdefinitionsApi.md +104 -0
- data/docs/FixedtermsApi.md +56 -0
- data/docs/FlatPricingComponent.md +32 -0
- data/docs/ImportInvoiceLine.md +16 -0
- data/docs/InsertableBillingEntity.md +21 -0
- data/docs/Invoice.md +54 -0
- data/docs/InvoiceChargeRequest.md +11 -0
- data/docs/InvoiceLine.md +38 -0
- data/docs/InvoiceLinePayment.md +36 -0
- data/docs/InvoiceLinePaymentPagedMetadata.md +14 -0
- data/docs/InvoiceNextExecutionAttemptAmendment.md +21 -0
- data/docs/InvoiceOutstandingChargesAmendment.md +20 -0
- data/docs/InvoicePagedMetadata.md +14 -0
- data/docs/InvoicePayment.md +22 -0
- data/docs/InvoiceRecalculationAmendment.md +23 -0
- data/docs/InvoiceRecalculationRequest.md +12 -0
- data/docs/InvoicesApi.md +2474 -0
- data/docs/IssueInvoiceAmendment.md +20 -0
- data/docs/MetadataApi.md +210 -0
- data/docs/MetadataKeyValuesPagedMetadata.md +14 -0
- data/docs/MigrationRequest.md +16 -0
- data/docs/ModelAlias.md +14 -0
- data/docs/MutableBillingEntity.md +27 -0
- data/docs/Notification.md +27 -0
- data/docs/NotificationPagedMetadata.md +14 -0
- data/docs/NotificationsApi.md +370 -0
- data/docs/Organization.md +21 -0
- data/docs/OrganizationPagedMetadata.md +14 -0
- data/docs/OrganizationsApi.md +378 -0
- data/docs/Password.md +14 -0
- data/docs/PasswordPagedMetadata.md +14 -0
- data/docs/PasswordResetRequest.md +8 -0
- data/docs/PasswordsApi.md +56 -0
- data/docs/PauseRequest.md +9 -0
- data/docs/Payment.md +24 -0
- data/docs/PaymentMethod.md +32 -0
- data/docs/PaymentMethodPagedMetadata.md +14 -0
- data/docs/PaymentMethodSubscriptionLink.md +17 -0
- data/docs/PaymentMethodSubscriptionLinkPagedMetadata.md +14 -0
- data/docs/PaymentPagedMetadata.md +14 -0
- data/docs/PaymentRetryRequest.md +9 -0
- data/docs/PaymentmethodsApi.md +445 -0
- data/docs/PaymentmethodsubscriptionlinksApi.md +107 -0
- data/docs/PaymentsApi.md +464 -0
- data/docs/PendingComponentValueChange.md +11 -0
- data/docs/Period.md +16 -0
- data/docs/PeriodPagedMetadata.md +14 -0
- data/docs/PeriodsApi.md +125 -0
- data/docs/PermissionActionEntityPagedMetadata.md +14 -0
- data/docs/PermissionResourceEntityPagedMetadata.md +14 -0
- data/docs/PermissionsApi.md +322 -0
- data/docs/PriceCalculationPagedMetadata.md +14 -0
- data/docs/PricingComponent.md +32 -0
- data/docs/PricingComponentCouponModifier.md +22 -0
- data/docs/PricingComponentMigrationValue.md +12 -0
- data/docs/PricingComponentPagedMetadata.md +14 -0
- data/docs/PricingComponentQuantityRequest.md +10 -0
- data/docs/PricingComponentTier.md +19 -0
- data/docs/PricingComponentTierPagedMetadata.md +14 -0
- data/docs/PricingComponentValue.md +20 -0
- data/docs/PricingComponentValueChangeAmendment.md +22 -0
- data/docs/PricingComponentValueChangePagedMetadata.md +14 -0
- data/docs/PricingComponentValueMigrationAmendmentMapping.md +16 -0
- data/docs/PricingComponentValuePagedMetadata.md +14 -0
- data/docs/PricingComponentValueRequest.md +12 -0
- data/docs/PricingComponentValueResponsePagedMetadata.md +14 -0
- data/docs/PricingcalculatorApi.md +152 -0
- data/docs/PricingcomponentsApi.md +339 -0
- data/docs/PricingcomponenttiersApi.md +281 -0
- data/docs/PricingcomponentvaluechangesApi.md +345 -0
- data/docs/PricingcomponentvaluesApi.md +287 -0
- data/docs/Product.md +25 -0
- data/docs/ProductCouponModifier.md +22 -0
- data/docs/ProductPagedMetadata.md +14 -0
- data/docs/ProductPaymentsResultPagedMetadata.md +14 -0
- data/docs/ProductRatePlan.md +39 -0
- data/docs/ProductRatePlanMigrationAmendment.md +27 -0
- data/docs/ProductRatePlanPagedMetadata.md +14 -0
- data/docs/ProductRatePlanPaymentsResultPagedMetadata.md +14 -0
- data/docs/ProductrateplansApi.md +786 -0
- data/docs/ProductsApi.md +493 -0
- data/docs/Profile.md +25 -0
- data/docs/ProfilePagedMetadata.md +14 -0
- data/docs/ProfilesApi.md +287 -0
- data/docs/QuoteRequest.md +24 -0
- data/docs/QuoteRequestValue.md +11 -0
- data/docs/QuotesApi.md +56 -0
- data/docs/RecalculateChargeRequest.md +15 -0
- data/docs/Receipt.md +36 -0
- data/docs/ReceiptPagedMetadata.md +14 -0
- data/docs/ReceiptsApi.md +421 -0
- data/docs/Refund.md +35 -0
- data/docs/RefundPagedMetadata.md +14 -0
- data/docs/RefundsApi.md +432 -0
- data/docs/ResumeRequest.md +10 -0
- data/docs/ResumeSubscriptionAmendment.md +19 -0
- data/docs/RevenueAttribution.md +31 -0
- data/docs/RevenueAttributionPagedMetadata.md +14 -0
- data/docs/ReviveSubscriptionRequest.md +8 -0
- data/docs/Role.md +19 -0
- data/docs/RolePagedMetadata.md +14 -0
- data/docs/RolesApi.md +327 -0
- data/docs/RuleSatisfaction.md +11 -0
- data/docs/SearchApi.md +70 -0
- data/docs/SearchResultPagedMetadata.md +14 -0
- data/docs/ServiceEndAmendment.md +19 -0
- data/docs/StripeACHTokenPagedMetadata.md +14 -0
- data/docs/StripeAuthCaptureRequest.md +20 -0
- data/docs/StripeObject.md +7 -0
- data/docs/StripeTokenPagedMetadata.md +14 -0
- data/docs/Subscription.md +47 -0
- data/docs/SubscriptionCancellationPagedMetadata.md +14 -0
- data/docs/SubscriptionCharge.md +32 -0
- data/docs/SubscriptionChargePagedMetadata.md +14 -0
- data/docs/SubscriptionLTVResultPagedMetadata.md +14 -0
- data/docs/SubscriptionPagedMetadata.md +14 -0
- data/docs/SubscriptionsApi.md +2841 -0
- data/docs/SwaggerTypeList.md +9 -0
- data/docs/SwaggerTypeListInv.md +8 -0
- data/docs/SwaggerTypeListSubs.md +9 -0
- data/docs/SynchAppConfigsApi.md +208 -0
- data/docs/SynchConfigsApi.md +317 -0
- data/docs/SynchJobsApi.md +421 -0
- data/docs/TaxationLinkPagedMetadata.md +14 -0
- data/docs/TaxationStrategyPagedMetadata.md +14 -0
- data/docs/TaxationlinksApi.md +339 -0
- data/docs/TaxationstrategiesApi.md +514 -0
- data/docs/TieredPricingComponent.md +32 -0
- data/docs/TieredVolumePricingComponent.md +32 -0
- data/docs/TimeApi.md +56 -0
- data/docs/TimeRequest.md +16 -0
- data/docs/TimeResponse.md +18 -0
- data/docs/TimeResponsePagedMetadata.md +14 -0
- data/docs/TimeZone.md +11 -0
- data/docs/TimerAmendment.md +26 -0
- data/docs/TokenizationApi.md +340 -0
- data/docs/TokenizationPreAuthPagedMetadata.md +14 -0
- data/docs/TrustCommerceTokenPagedMetadata.md +14 -0
- data/docs/UnitDiscount.md +11 -0
- data/docs/UnitOfMeasure.md +16 -0
- data/docs/UnitOfMeasureCouponModifier.md +22 -0
- data/docs/UnitOfMeasurePagedMetadata.md +14 -0
- data/docs/UnitofmeasureApi.md +215 -0
- data/docs/UpdateAddressRequest.md +18 -0
- data/docs/UpdateComponentValueAmendment.md +23 -0
- data/docs/UpdateProfileRequest.md +22 -0
- data/docs/UpdateRoleRequest.md +13 -0
- data/docs/UpdateSubscriptionRequest.md +16 -0
- data/docs/Usage.md +26 -0
- data/docs/UsageApi.md +296 -0
- data/docs/UsagePagedMetadata.md +14 -0
- data/docs/UsagePeriodPagedMetadata.md +14 -0
- data/docs/UsageRoundingStrategyPagedMetadata.md +14 -0
- data/docs/UsageSession.md +21 -0
- data/docs/UsageSessionPagedMetadata.md +14 -0
- data/docs/UsageperiodsApi.md +194 -0
- data/docs/UsageroundingstrategiesApi.md +228 -0
- data/docs/UsagesessionsApi.md +224 -0
- data/docs/User.md +21 -0
- data/docs/UserCreationRequest.md +17 -0
- data/docs/UserCreationResponsePagedMetadata.md +14 -0
- data/docs/UserPagedMetadata.md +14 -0
- data/docs/Username.md +13 -0
- data/docs/UsernamePagedMetadata.md +14 -0
- data/docs/UsernamesApi.md +56 -0
- data/docs/UsersApi.md +564 -0
- data/docs/VaultedgatewaysApi.md +648 -0
- data/docs/WebhookPagedMetadata.md +14 -0
- data/docs/WebhooksApi.md +366 -0
- data/git_push.sh +67 -0
- data/lib/bf_ruby2/api/accounts_api.rb +1257 -0
- data/lib/bf_ruby2/api/addresses_api.rb +148 -0
- data/lib/bf_ruby2/api/amendments_api.rb +819 -0
- data/lib/bf_ruby2/api/analytics_api.rb +815 -0
- data/lib/bf_ruby2/api/auditlogs_api.rb +410 -0
- data/lib/bf_ruby2/api/charges_api.rb +527 -0
- data/lib/bf_ruby2/api/clients_api.rb +282 -0
- data/lib/bf_ruby2/api/configurations_api.rb +298 -0
- data/lib/bf_ruby2/api/couponbook_api.rb +619 -0
- data/lib/bf_ruby2/api/couponbookdefinition_api.rb +420 -0
- data/lib/bf_ruby2/api/coupondefinition_api.rb +342 -0
- data/lib/bf_ruby2/api/couponinstance_api.rb +737 -0
- data/lib/bf_ruby2/api/couponmodifier_api.rb +456 -0
- data/lib/bf_ruby2/api/couponrule_api.rb +342 -0
- data/lib/bf_ruby2/api/coupons_api.rb +580 -0
- data/lib/bf_ruby2/api/creditnotes_api.rb +438 -0
- data/lib/bf_ruby2/api/cybersourcetokens_api.rb +330 -0
- data/lib/bf_ruby2/api/dunninglines_api.rb +422 -0
- data/lib/bf_ruby2/api/emailproviders_api.rb +288 -0
- data/lib/bf_ruby2/api/emails_api.rb +214 -0
- data/lib/bf_ruby2/api/emailsubscriptions_api.rb +364 -0
- data/lib/bf_ruby2/api/fixedtermdefinitions_api.rb +148 -0
- data/lib/bf_ruby2/api/fixedterms_api.rb +91 -0
- data/lib/bf_ruby2/api/invoices_api.rb +3066 -0
- data/lib/bf_ruby2/api/metadata_api.rb +266 -0
- data/lib/bf_ruby2/api/notifications_api.rb +480 -0
- data/lib/bf_ruby2/api/organizations_api.rb +476 -0
- data/lib/bf_ruby2/api/passwords_api.rb +91 -0
- data/lib/bf_ruby2/api/paymentmethods_api.rb +565 -0
- data/lib/bf_ruby2/api/paymentmethodsubscriptionlinks_api.rb +153 -0
- data/lib/bf_ruby2/api/payments_api.rb +601 -0
- data/lib/bf_ruby2/api/periods_api.rb +180 -0
- data/lib/bf_ruby2/api/permissions_api.rb +408 -0
- data/lib/bf_ruby2/api/pricingcalculator_api.rb +205 -0
- data/lib/bf_ruby2/api/pricingcomponents_api.rb +438 -0
- data/lib/bf_ruby2/api/pricingcomponenttiers_api.rb +369 -0
- data/lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb +447 -0
- data/lib/bf_ruby2/api/pricingcomponentvalues_api.rb +378 -0
- data/lib/bf_ruby2/api/productrateplans_api.rb +971 -0
- data/lib/bf_ruby2/api/products_api.rb +611 -0
- data/lib/bf_ruby2/api/profiles_api.rb +375 -0
- data/lib/bf_ruby2/api/quotes_api.rb +91 -0
- data/lib/bf_ruby2/api/receipts_api.rb +559 -0
- data/lib/bf_ruby2/api/refunds_api.rb +540 -0
- data/lib/bf_ruby2/api/roles_api.rb +421 -0
- data/lib/bf_ruby2/api/search_api.rb +109 -0
- data/lib/bf_ruby2/api/subscriptions_api.rb +3490 -0
- data/lib/bf_ruby2/api/synch_app_configs_api.rb +272 -0
- data/lib/bf_ruby2/api/synch_configs_api.rb +403 -0
- data/lib/bf_ruby2/api/synch_jobs_api.rb +535 -0
- data/lib/bf_ruby2/api/taxationlinks_api.rb +438 -0
- data/lib/bf_ruby2/api/taxationstrategies_api.rb +660 -0
- data/lib/bf_ruby2/api/time_api.rb +91 -0
- data/lib/bf_ruby2/api/tokenization_api.rb +431 -0
- data/lib/bf_ruby2/api/unitofmeasure_api.rb +282 -0
- data/lib/bf_ruby2/api/usage_api.rb +389 -0
- data/lib/bf_ruby2/api/usageperiods_api.rb +267 -0
- data/lib/bf_ruby2/api/usageroundingstrategies_api.rb +304 -0
- data/lib/bf_ruby2/api/usagesessions_api.rb +298 -0
- data/lib/bf_ruby2/api/usernames_api.rb +91 -0
- data/lib/bf_ruby2/api/users_api.rb +692 -0
- data/lib/bf_ruby2/api/vaultedgateways_api.rb +787 -0
- data/lib/bf_ruby2/api/webhooks_api.rb +461 -0
- data/lib/bf_ruby2/api_client.rb +378 -0
- data/lib/bf_ruby2/api_error.rb +47 -0
- data/lib/bf_ruby2/configuration.rb +207 -0
- data/lib/bf_ruby2/models/account.rb +335 -0
- data/lib/bf_ruby2/models/account_ltv_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/account_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/account_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/add_charge_request.rb +414 -0
- data/lib/bf_ruby2/models/add_coupon_code_request.rb +231 -0
- data/lib/bf_ruby2/models/add_payment_method_request.rb +200 -0
- data/lib/bf_ruby2/models/add_taxation_strategy_request.rb +230 -0
- data/lib/bf_ruby2/models/address.rb +359 -0
- data/lib/bf_ruby2/models/address_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/aggregating_component.rb +294 -0
- data/lib/bf_ruby2/models/amendment.rb +374 -0
- data/lib/bf_ruby2/models/amendment_discard_amendment.rb +385 -0
- data/lib/bf_ruby2/models/amendment_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/amendment_price_n_time_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/api_configuration_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/api_quote.rb +525 -0
- data/lib/bf_ruby2/models/api_quote_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/api_quote_response_quantity.rb +405 -0
- data/lib/bf_ruby2/models/audit_entry.rb +359 -0
- data/lib/bf_ruby2/models/audit_entry_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/auth_capture_request.rb +337 -0
- data/lib/bf_ruby2/models/authorize_net_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/bank_account_verification_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/bf_error.rb +265 -0
- data/lib/bf_ruby2/models/bf_permission.rb +337 -0
- data/lib/bf_ruby2/models/bf_permission_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/billforward_managed_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/billing_entity_base.rb +200 -0
- data/lib/bf_ruby2/models/braintree_auth_capture_request.rb +358 -0
- data/lib/bf_ruby2/models/braintree_capture_request.rb +327 -0
- data/lib/bf_ruby2/models/braintree_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/cancel_subscription_request.rb +301 -0
- data/lib/bf_ruby2/models/cancellation_amendment.rb +451 -0
- data/lib/bf_ruby2/models/cass_churn_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/cass_payment_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/cass_upgrade_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/client.rb +342 -0
- data/lib/bf_ruby2/models/client_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/component_change.rb +373 -0
- data/lib/bf_ruby2/models/component_cost.rb +208 -0
- data/lib/bf_ruby2/models/compound_usage.rb +234 -0
- data/lib/bf_ruby2/models/compound_usage_session.rb +233 -0
- data/lib/bf_ruby2/models/coupon.rb +484 -0
- data/lib/bf_ruby2/models/coupon_book.rb +342 -0
- data/lib/bf_ruby2/models/coupon_book_definition.rb +417 -0
- data/lib/bf_ruby2/models/coupon_book_definition_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_book_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_definition.rb +454 -0
- data/lib/bf_ruby2/models/coupon_definition_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_discount.rb +298 -0
- data/lib/bf_ruby2/models/coupon_discount_estimate.rb +258 -0
- data/lib/bf_ruby2/models/coupon_instance.rb +426 -0
- data/lib/bf_ruby2/models/coupon_instance_existing_value.rb +272 -0
- data/lib/bf_ruby2/models/coupon_instance_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_modifier_base.rb +410 -0
- data/lib/bf_ruby2/models/coupon_modifier_base_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_rule.rb +470 -0
- data/lib/bf_ruby2/models/coupon_rule_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_unique_codes_request.rb +232 -0
- data/lib/bf_ruby2/models/coupon_unique_codes_response.rb +219 -0
- data/lib/bf_ruby2/models/coupon_unique_codes_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_wrapper_response.rb +250 -0
- data/lib/bf_ruby2/models/create_account_profile_request.rb +323 -0
- data/lib/bf_ruby2/models/create_account_request.rb +248 -0
- data/lib/bf_ruby2/models/create_address_request.rb +298 -0
- data/lib/bf_ruby2/models/create_aggregating_component_request.rb +221 -0
- data/lib/bf_ruby2/models/create_aggregating_subscription_request.rb +393 -0
- data/lib/bf_ruby2/models/create_profile_address_request.rb +287 -0
- data/lib/bf_ruby2/models/create_subscription_batch_request.rb +222 -0
- data/lib/bf_ruby2/models/create_subscription_charge_amendment.rb +514 -0
- data/lib/bf_ruby2/models/create_subscription_request.rb +444 -0
- data/lib/bf_ruby2/models/credit_account_request.rb +252 -0
- data/lib/bf_ruby2/models/credit_note.rb +368 -0
- data/lib/bf_ruby2/models/credit_note_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/credit_subscription_request.rb +241 -0
- data/lib/bf_ruby2/models/cybersource_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/data_synchronisation_app_configuration_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/data_synchronisation_configuration.rb +362 -0
- data/lib/bf_ruby2/models/data_synchronisation_configuration_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/data_synchronization_job_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/debts_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/dunning_line.rb +354 -0
- data/lib/bf_ruby2/models/dunning_line_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/dynamic_metadata.rb +190 -0
- data/lib/bf_ruby2/models/email.rb +518 -0
- data/lib/bf_ruby2/models/email_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/email_provider.rb +302 -0
- data/lib/bf_ruby2/models/email_provider_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/email_subscription.rb +364 -0
- data/lib/bf_ruby2/models/email_subscription_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/end_trial_amendment.rb +374 -0
- data/lib/bf_ruby2/models/event.rb +272 -0
- data/lib/bf_ruby2/models/event_data.rb +212 -0
- data/lib/bf_ruby2/models/file_sham.rb +190 -0
- data/lib/bf_ruby2/models/fixed_term.rb +419 -0
- data/lib/bf_ruby2/models/fixed_term_definition_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/fixed_term_expiry_amendment.rb +385 -0
- data/lib/bf_ruby2/models/fixed_term_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/flat_pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/import_invoice_line.rb +271 -0
- data/lib/bf_ruby2/models/insertable_billing_entity.rb +384 -0
- data/lib/bf_ruby2/models/invoice.rb +746 -0
- data/lib/bf_ruby2/models/invoice_charge_request.rb +267 -0
- data/lib/bf_ruby2/models/invoice_line.rb +575 -0
- data/lib/bf_ruby2/models/invoice_line_payment.rb +539 -0
- data/lib/bf_ruby2/models/invoice_line_payment_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/invoice_next_execution_attempt_amendment.rb +398 -0
- data/lib/bf_ruby2/models/invoice_outstanding_charges_amendment.rb +385 -0
- data/lib/bf_ruby2/models/invoice_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/invoice_payment.rb +384 -0
- data/lib/bf_ruby2/models/invoice_recalculation_amendment.rb +444 -0
- data/lib/bf_ruby2/models/invoice_recalculation_request.rb +293 -0
- data/lib/bf_ruby2/models/issue_invoice_amendment.rb +385 -0
- data/lib/bf_ruby2/models/metadata_key_values_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/migration_request.rb +332 -0
- data/lib/bf_ruby2/models/model_alias.rb +266 -0
- data/lib/bf_ruby2/models/mutable_billing_entity.rb +472 -0
- data/lib/bf_ruby2/models/notification.rb +472 -0
- data/lib/bf_ruby2/models/notification_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/organization.rb +349 -0
- data/lib/bf_ruby2/models/organization_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/password.rb +266 -0
- data/lib/bf_ruby2/models/password_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/password_reset_request.rb +201 -0
- data/lib/bf_ruby2/models/pause_request.rb +210 -0
- data/lib/bf_ruby2/models/payment.rb +417 -0
- data/lib/bf_ruby2/models/payment_method.rb +487 -0
- data/lib/bf_ruby2/models/payment_method_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/payment_method_subscription_link.rb +291 -0
- data/lib/bf_ruby2/models/payment_method_subscription_link_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/payment_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/payment_retry_request.rb +210 -0
- data/lib/bf_ruby2/models/pending_component_value_change.rb +226 -0
- data/lib/bf_ruby2/models/period.rb +330 -0
- data/lib/bf_ruby2/models/period_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/permission_action_entity_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/permission_resource_entity_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/price_calculation_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/pricing_component_coupon_modifier.rb +410 -0
- data/lib/bf_ruby2/models/pricing_component_migration_value.rb +242 -0
- data/lib/bf_ruby2/models/pricing_component_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_quantity_request.rb +220 -0
- data/lib/bf_ruby2/models/pricing_component_tier.rb +346 -0
- data/lib/bf_ruby2/models/pricing_component_tier_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_value.rb +323 -0
- data/lib/bf_ruby2/models/pricing_component_value_change_amendment.rb +419 -0
- data/lib/bf_ruby2/models/pricing_component_value_change_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_value_migration_amendment_mapping.rb +283 -0
- data/lib/bf_ruby2/models/pricing_component_value_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_value_request.rb +288 -0
- data/lib/bf_ruby2/models/pricing_component_value_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product.rb +435 -0
- data/lib/bf_ruby2/models/product_coupon_modifier.rb +410 -0
- data/lib/bf_ruby2/models/product_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product_rate_plan.rb +658 -0
- data/lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb +483 -0
- data/lib/bf_ruby2/models/product_rate_plan_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product_rate_plan_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/profile.rb +378 -0
- data/lib/bf_ruby2/models/profile_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/quote_request.rb +431 -0
- data/lib/bf_ruby2/models/quote_request_value.rb +232 -0
- data/lib/bf_ruby2/models/recalculate_charge_request.rb +318 -0
- data/lib/bf_ruby2/models/receipt.rb +535 -0
- data/lib/bf_ruby2/models/receipt_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/refund.rb +535 -0
- data/lib/bf_ruby2/models/refund_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/resume_request.rb +222 -0
- data/lib/bf_ruby2/models/resume_subscription_amendment.rb +374 -0
- data/lib/bf_ruby2/models/revenue_attribution.rb +451 -0
- data/lib/bf_ruby2/models/revenue_attribution_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/revive_subscription_request.rb +200 -0
- data/lib/bf_ruby2/models/role.rb +318 -0
- data/lib/bf_ruby2/models/role_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/rule_satisfaction.rb +234 -0
- data/lib/bf_ruby2/models/search_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/service_end_amendment.rb +374 -0
- data/lib/bf_ruby2/models/stripe_ach_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/stripe_auth_capture_request.rb +367 -0
- data/lib/bf_ruby2/models/stripe_object.rb +190 -0
- data/lib/bf_ruby2/models/stripe_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription.rb +681 -0
- data/lib/bf_ruby2/models/subscription_cancellation_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription_charge.rb +529 -0
- data/lib/bf_ruby2/models/subscription_charge_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription_ltv_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/swagger_type_list.rb +210 -0
- data/lib/bf_ruby2/models/swagger_type_list_inv.rb +201 -0
- data/lib/bf_ruby2/models/swagger_type_list_subs.rb +212 -0
- data/lib/bf_ruby2/models/taxation_link_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/taxation_strategy_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/tiered_pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/tiered_volume_pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/time_request.rb +323 -0
- data/lib/bf_ruby2/models/time_response.rb +345 -0
- data/lib/bf_ruby2/models/time_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/time_zone.rb +226 -0
- data/lib/bf_ruby2/models/timer_amendment.rb +485 -0
- data/lib/bf_ruby2/models/tokenization_pre_auth_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/trust_commerce_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/unit_discount.rb +226 -0
- data/lib/bf_ruby2/models/unit_of_measure.rb +286 -0
- data/lib/bf_ruby2/models/unit_of_measure_coupon_modifier.rb +410 -0
- data/lib/bf_ruby2/models/unit_of_measure_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/update_address_request.rb +303 -0
- data/lib/bf_ruby2/models/update_component_value_amendment.rb +418 -0
- data/lib/bf_ruby2/models/update_profile_request.rb +342 -0
- data/lib/bf_ruby2/models/update_role_request.rb +253 -0
- data/lib/bf_ruby2/models/update_subscription_request.rb +328 -0
- data/lib/bf_ruby2/models/usage.rb +423 -0
- data/lib/bf_ruby2/models/usage_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/usage_period_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/usage_rounding_strategy_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/usage_session.rb +368 -0
- data/lib/bf_ruby2/models/usage_session_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/user.rb +352 -0
- data/lib/bf_ruby2/models/user_creation_request.rb +302 -0
- data/lib/bf_ruby2/models/user_creation_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/user_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/username.rb +253 -0
- data/lib/bf_ruby2/models/username_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/webhook_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/version.rb +26 -0
- data/lib/bf_ruby2.rb +340 -0
- data/setup.scratch.rb +33 -0
- data/spec/api/accounts_api_spec.rb +318 -0
- data/spec/api/addresses_api_spec.rb +70 -0
- data/spec/api/amendments_api_spec.rb +220 -0
- data/spec/api/analytics_api_spec.rb +220 -0
- data/spec/api/auditlogs_api_spec.rb +131 -0
- data/spec/api/charges_api_spec.rb +156 -0
- data/spec/api/clients_api_spec.rb +100 -0
- data/spec/api/configurations_api_spec.rb +103 -0
- data/spec/api/couponbook_api_spec.rb +175 -0
- data/spec/api/couponbookdefinition_api_spec.rb +131 -0
- data/spec/api/coupondefinition_api_spec.rb +113 -0
- data/spec/api/couponinstance_api_spec.rb +203 -0
- data/spec/api/couponmodifier_api_spec.rb +138 -0
- data/spec/api/couponrule_api_spec.rb +113 -0
- data/spec/api/coupons_api_spec.rb +168 -0
- data/spec/api/creditnotes_api_spec.rb +135 -0
- data/spec/api/cybersourcetokens_api_spec.rb +109 -0
- data/spec/api/dunninglines_api_spec.rb +131 -0
- data/spec/api/emailproviders_api_spec.rb +102 -0
- data/spec/api/emails_api_spec.rb +85 -0
- data/spec/api/emailsubscriptions_api_spec.rb +115 -0
- data/spec/api/fixedtermdefinitions_api_spec.rb +70 -0
- data/spec/api/fixedterms_api_spec.rb +58 -0
- data/spec/api/invoices_api_spec.rb +727 -0
- data/spec/api/metadata_api_spec.rb +96 -0
- data/spec/api/notifications_api_spec.rb +148 -0
- data/spec/api/organizations_api_spec.rb +143 -0
- data/spec/api/passwords_api_spec.rb +58 -0
- data/spec/api/paymentmethods_api_spec.rb +163 -0
- data/spec/api/paymentmethodsubscriptionlinks_api_spec.rb +71 -0
- data/spec/api/payments_api_spec.rb +172 -0
- data/spec/api/periods_api_spec.rb +79 -0
- data/spec/api/permissions_api_spec.rb +127 -0
- data/spec/api/pricingcalculator_api_spec.rb +82 -0
- data/spec/api/pricingcomponents_api_spec.rb +136 -0
- data/spec/api/pricingcomponenttiers_api_spec.rb +120 -0
- data/spec/api/pricingcomponentvaluechanges_api_spec.rb +138 -0
- data/spec/api/pricingcomponentvalues_api_spec.rb +123 -0
- data/spec/api/productrateplans_api_spec.rb +254 -0
- data/spec/api/products_api_spec.rb +173 -0
- data/spec/api/profiles_api_spec.rb +122 -0
- data/spec/api/quotes_api_spec.rb +58 -0
- data/spec/api/receipts_api_spec.rb +164 -0
- data/spec/api/refunds_api_spec.rb +156 -0
- data/spec/api/roles_api_spec.rb +129 -0
- data/spec/api/search_api_spec.rb +64 -0
- data/spec/api/subscriptions_api_spec.rb +809 -0
- data/spec/api/synch_app_configs_api_spec.rb +96 -0
- data/spec/api/synch_configs_api_spec.rb +125 -0
- data/spec/api/synch_jobs_api_spec.rb +151 -0
- data/spec/api/taxationlinks_api_spec.rb +136 -0
- data/spec/api/taxationstrategies_api_spec.rb +185 -0
- data/spec/api/time_api_spec.rb +58 -0
- data/spec/api/tokenization_api_spec.rb +138 -0
- data/spec/api/unitofmeasure_api_spec.rb +100 -0
- data/spec/api/usage_api_spec.rb +125 -0
- data/spec/api/usageperiods_api_spec.rb +99 -0
- data/spec/api/usageroundingstrategies_api_spec.rb +106 -0
- data/spec/api/usagesessions_api_spec.rb +104 -0
- data/spec/api/usernames_api_spec.rb +58 -0
- data/spec/api/users_api_spec.rb +187 -0
- data/spec/api/vaultedgateways_api_spec.rb +206 -0
- data/spec/api/webhooks_api_spec.rb +138 -0
- data/spec/api_client_spec.rb +237 -0
- data/spec/configuration_spec.rb +53 -0
- data/spec/models/account_ltv_result_paged_metadata_spec.rb +89 -0
- data/spec/models/account_paged_metadata_spec.rb +89 -0
- data/spec/models/account_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/account_spec.rb +131 -0
- data/spec/models/add_charge_request_spec.rb +155 -0
- data/spec/models/add_coupon_code_request_spec.rb +71 -0
- data/spec/models/add_payment_method_request_spec.rb +53 -0
- data/spec/models/add_taxation_strategy_request_spec.rb +71 -0
- data/spec/models/address_paged_metadata_spec.rb +89 -0
- data/spec/models/address_spec.rb +143 -0
- data/spec/models/aggregating_component_spec.rb +107 -0
- data/spec/models/amendment_discard_amendment_spec.rb +137 -0
- data/spec/models/amendment_paged_metadata_spec.rb +89 -0
- data/spec/models/amendment_price_n_time_paged_metadata_spec.rb +89 -0
- data/spec/models/amendment_spec.rb +131 -0
- data/spec/models/api_configuration_paged_metadata_spec.rb +89 -0
- data/spec/models/api_quote_paged_metadata_spec.rb +89 -0
- data/spec/models/api_quote_response_quantity_spec.rb +159 -0
- data/spec/models/api_quote_spec.rb +225 -0
- data/spec/models/audit_entry_paged_metadata_spec.rb +89 -0
- data/spec/models/audit_entry_spec.rb +119 -0
- data/spec/models/auth_capture_request_spec.rb +115 -0
- data/spec/models/authorize_net_token_paged_metadata_spec.rb +89 -0
- data/spec/models/bank_account_verification_paged_metadata_spec.rb +89 -0
- data/spec/models/bf_error_spec.rb +75 -0
- data/spec/models/bf_permission_paged_metadata_spec.rb +89 -0
- data/spec/models/bf_permission_spec.rb +115 -0
- data/spec/models/billforward_managed_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/billing_entity_base_spec.rb +53 -0
- data/spec/models/braintree_auth_capture_request_spec.rb +127 -0
- data/spec/models/braintree_capture_request_spec.rb +125 -0
- data/spec/models/braintree_token_paged_metadata_spec.rb +89 -0
- data/spec/models/cancel_subscription_request_spec.rb +97 -0
- data/spec/models/cancellation_amendment_spec.rb +169 -0
- data/spec/models/cass_churn_result_paged_metadata_spec.rb +89 -0
- data/spec/models/cass_payment_result_paged_metadata_spec.rb +89 -0
- data/spec/models/cass_upgrade_result_paged_metadata_spec.rb +89 -0
- data/spec/models/client_paged_metadata_spec.rb +89 -0
- data/spec/models/client_spec.rb +131 -0
- data/spec/models/component_change_spec.rb +133 -0
- data/spec/models/component_cost_spec.rb +59 -0
- data/spec/models/compound_usage_session_spec.rb +71 -0
- data/spec/models/compound_usage_spec.rb +71 -0
- data/spec/models/coupon_book_definition_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_book_definition_spec.rb +157 -0
- data/spec/models/coupon_book_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_book_spec.rb +131 -0
- data/spec/models/coupon_definition_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_definition_spec.rb +173 -0
- data/spec/models/coupon_discount_estimate_spec.rb +83 -0
- data/spec/models/coupon_discount_spec.rb +113 -0
- data/spec/models/coupon_instance_existing_value_spec.rb +95 -0
- data/spec/models/coupon_instance_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_instance_spec.rb +165 -0
- data/spec/models/coupon_modifier_base_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_modifier_base_spec.rb +149 -0
- data/spec/models/coupon_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_rule_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_rule_spec.rb +173 -0
- data/spec/models/coupon_spec.rb +201 -0
- data/spec/models/coupon_unique_codes_request_spec.rb +71 -0
- data/spec/models/coupon_unique_codes_response_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_unique_codes_response_spec.rb +65 -0
- data/spec/models/coupon_wrapper_response_spec.rb +83 -0
- data/spec/models/create_account_profile_request_spec.rb +125 -0
- data/spec/models/create_account_request_spec.rb +83 -0
- data/spec/models/create_address_request_spec.rb +107 -0
- data/spec/models/create_aggregating_component_request_spec.rb +65 -0
- data/spec/models/create_aggregating_subscription_request_spec.rb +143 -0
- data/spec/models/create_profile_address_request_spec.rb +101 -0
- data/spec/models/create_subscription_batch_request_spec.rb +65 -0
- data/spec/models/create_subscription_charge_amendment_spec.rb +203 -0
- data/spec/models/create_subscription_request_spec.rb +173 -0
- data/spec/models/credit_account_request_spec.rb +83 -0
- data/spec/models/credit_note_paged_metadata_spec.rb +89 -0
- data/spec/models/credit_note_spec.rb +135 -0
- data/spec/models/credit_subscription_request_spec.rb +77 -0
- data/spec/models/cybersource_token_paged_metadata_spec.rb +89 -0
- data/spec/models/data_synchronisation_app_configuration_paged_metadata_spec.rb +89 -0
- data/spec/models/data_synchronisation_configuration_paged_metadata_spec.rb +89 -0
- data/spec/models/data_synchronisation_configuration_spec.rb +129 -0
- data/spec/models/data_synchronization_job_paged_metadata_spec.rb +89 -0
- data/spec/models/debts_result_paged_metadata_spec.rb +89 -0
- data/spec/models/dunning_line_paged_metadata_spec.rb +89 -0
- data/spec/models/dunning_line_spec.rb +121 -0
- data/spec/models/dynamic_metadata_spec.rb +47 -0
- data/spec/models/email_paged_metadata_spec.rb +89 -0
- data/spec/models/email_provider_paged_metadata_spec.rb +89 -0
- data/spec/models/email_provider_spec.rb +113 -0
- data/spec/models/email_spec.rb +223 -0
- data/spec/models/email_subscription_paged_metadata_spec.rb +89 -0
- data/spec/models/email_subscription_spec.rb +133 -0
- data/spec/models/end_trial_amendment_spec.rb +131 -0
- data/spec/models/event_data_spec.rb +59 -0
- data/spec/models/event_spec.rb +95 -0
- data/spec/models/file_sham_spec.rb +47 -0
- data/spec/models/fixed_term_definition_paged_metadata_spec.rb +89 -0
- data/spec/models/fixed_term_expiry_amendment_spec.rb +137 -0
- data/spec/models/fixed_term_paged_metadata_spec.rb +89 -0
- data/spec/models/fixed_term_spec.rb +157 -0
- data/spec/models/flat_pricing_component_spec.rb +221 -0
- data/spec/models/import_invoice_line_spec.rb +101 -0
- data/spec/models/insertable_billing_entity_spec.rb +139 -0
- data/spec/models/invoice_charge_request_spec.rb +75 -0
- data/spec/models/invoice_line_payment_paged_metadata_spec.rb +89 -0
- data/spec/models/invoice_line_payment_spec.rb +225 -0
- data/spec/models/invoice_line_spec.rb +245 -0
- data/spec/models/invoice_next_execution_attempt_amendment_spec.rb +143 -0
- data/spec/models/invoice_outstanding_charges_amendment_spec.rb +137 -0
- data/spec/models/invoice_paged_metadata_spec.rb +89 -0
- data/spec/models/invoice_payment_spec.rb +141 -0
- data/spec/models/invoice_recalculation_amendment_spec.rb +163 -0
- data/spec/models/invoice_recalculation_request_spec.rb +85 -0
- data/spec/models/invoice_spec.rb +341 -0
- data/spec/models/issue_invoice_amendment_spec.rb +137 -0
- data/spec/models/metadata_key_values_paged_metadata_spec.rb +89 -0
- data/spec/models/migration_request_spec.rb +109 -0
- data/spec/models/model_alias_spec.rb +89 -0
- data/spec/models/mutable_billing_entity_spec.rb +183 -0
- data/spec/models/notification_paged_metadata_spec.rb +89 -0
- data/spec/models/notification_spec.rb +183 -0
- data/spec/models/organization_paged_metadata_spec.rb +89 -0
- data/spec/models/organization_spec.rb +131 -0
- data/spec/models/password_paged_metadata_spec.rb +89 -0
- data/spec/models/password_reset_request_spec.rb +53 -0
- data/spec/models/password_spec.rb +89 -0
- data/spec/models/pause_request_spec.rb +59 -0
- data/spec/models/payment_method_paged_metadata_spec.rb +89 -0
- data/spec/models/payment_method_spec.rb +205 -0
- data/spec/models/payment_method_subscription_link_paged_metadata_spec.rb +89 -0
- data/spec/models/payment_method_subscription_link_spec.rb +107 -0
- data/spec/models/payment_paged_metadata_spec.rb +89 -0
- data/spec/models/payment_retry_request_spec.rb +59 -0
- data/spec/models/payment_spec.rb +157 -0
- data/spec/models/pending_component_value_change_spec.rb +71 -0
- data/spec/models/period_paged_metadata_spec.rb +89 -0
- data/spec/models/period_spec.rb +109 -0
- data/spec/models/permission_action_entity_paged_metadata_spec.rb +89 -0
- data/spec/models/permission_resource_entity_paged_metadata_spec.rb +89 -0
- data/spec/models/price_calculation_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_coupon_modifier_spec.rb +149 -0
- data/spec/models/pricing_component_migration_value_spec.rb +77 -0
- data/spec/models/pricing_component_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_quantity_request_spec.rb +65 -0
- data/spec/models/pricing_component_spec.rb +221 -0
- data/spec/models/pricing_component_tier_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_tier_spec.rb +123 -0
- data/spec/models/pricing_component_value_change_amendment_spec.rb +153 -0
- data/spec/models/pricing_component_value_change_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_value_migration_amendment_mapping_spec.rb +101 -0
- data/spec/models/pricing_component_value_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_value_request_spec.rb +85 -0
- data/spec/models/pricing_component_value_response_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_value_spec.rb +125 -0
- data/spec/models/product_coupon_modifier_spec.rb +149 -0
- data/spec/models/product_paged_metadata_spec.rb +89 -0
- data/spec/models/product_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/product_rate_plan_migration_amendment_spec.rb +187 -0
- data/spec/models/product_rate_plan_paged_metadata_spec.rb +89 -0
- data/spec/models/product_rate_plan_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/product_rate_plan_spec.rb +275 -0
- data/spec/models/product_spec.rb +167 -0
- data/spec/models/profile_paged_metadata_spec.rb +89 -0
- data/spec/models/profile_spec.rb +155 -0
- data/spec/models/quote_request_spec.rb +161 -0
- data/spec/models/quote_request_value_spec.rb +71 -0
- data/spec/models/recalculate_charge_request_spec.rb +103 -0
- data/spec/models/receipt_paged_metadata_spec.rb +89 -0
- data/spec/models/receipt_spec.rb +237 -0
- data/spec/models/refund_paged_metadata_spec.rb +89 -0
- data/spec/models/refund_spec.rb +227 -0
- data/spec/models/resume_request_spec.rb +65 -0
- data/spec/models/resume_subscription_amendment_spec.rb +131 -0
- data/spec/models/revenue_attribution_paged_metadata_spec.rb +89 -0
- data/spec/models/revenue_attribution_spec.rb +191 -0
- data/spec/models/revive_subscription_request_spec.rb +53 -0
- data/spec/models/role_paged_metadata_spec.rb +89 -0
- data/spec/models/role_spec.rb +119 -0
- data/spec/models/rule_satisfaction_spec.rb +71 -0
- data/spec/models/search_result_paged_metadata_spec.rb +89 -0
- data/spec/models/service_end_amendment_spec.rb +131 -0
- data/spec/models/stripe_ach_token_paged_metadata_spec.rb +89 -0
- data/spec/models/stripe_auth_capture_request_spec.rb +133 -0
- data/spec/models/stripe_object_spec.rb +47 -0
- data/spec/models/stripe_token_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_cancellation_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_charge_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_charge_spec.rb +217 -0
- data/spec/models/subscription_ltv_result_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_spec.rb +303 -0
- data/spec/models/swagger_type_list_inv_spec.rb +53 -0
- data/spec/models/swagger_type_list_spec.rb +59 -0
- data/spec/models/swagger_type_list_subs_spec.rb +59 -0
- data/spec/models/taxation_link_paged_metadata_spec.rb +89 -0
- data/spec/models/taxation_strategy_paged_metadata_spec.rb +89 -0
- data/spec/models/tiered_pricing_component_spec.rb +221 -0
- data/spec/models/tiered_volume_pricing_component_spec.rb +221 -0
- data/spec/models/time_request_spec.rb +105 -0
- data/spec/models/time_response_paged_metadata_spec.rb +89 -0
- data/spec/models/time_response_spec.rb +117 -0
- data/spec/models/time_zone_spec.rb +71 -0
- data/spec/models/timer_amendment_spec.rb +189 -0
- data/spec/models/tokenization_pre_auth_paged_metadata_spec.rb +89 -0
- data/spec/models/trust_commerce_token_paged_metadata_spec.rb +89 -0
- data/spec/models/unit_discount_spec.rb +71 -0
- data/spec/models/unit_of_measure_coupon_modifier_spec.rb +149 -0
- data/spec/models/unit_of_measure_paged_metadata_spec.rb +89 -0
- data/spec/models/unit_of_measure_spec.rb +101 -0
- data/spec/models/update_address_request_spec.rb +113 -0
- data/spec/models/update_component_value_amendment_spec.rb +155 -0
- data/spec/models/update_profile_request_spec.rb +137 -0
- data/spec/models/update_role_request_spec.rb +83 -0
- data/spec/models/update_subscription_request_spec.rb +109 -0
- data/spec/models/usage_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_period_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_rounding_strategy_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_session_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_session_spec.rb +135 -0
- data/spec/models/usage_spec.rb +165 -0
- data/spec/models/user_creation_request_spec.rb +107 -0
- data/spec/models/user_creation_response_paged_metadata_spec.rb +89 -0
- data/spec/models/user_paged_metadata_spec.rb +89 -0
- data/spec/models/user_spec.rb +131 -0
- data/spec/models/username_paged_metadata_spec.rb +89 -0
- data/spec/models/username_spec.rb +83 -0
- data/spec/models/webhook_paged_metadata_spec.rb +89 -0
- data/spec/spec_helper.rb +122 -0
- metadata +1401 -0
data/docs/InvoicesApi.md
ADDED
|
@@ -0,0 +1,2474 @@
|
|
|
1
|
+
# BillForward::InvoicesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://localhost:8080/RestAPI*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**add_charge_to_invoice**](InvoicesApi.md#add_charge_to_invoice) | **POST** /invoices/{invoice-ID}/charges | Creates a charge on the specified invoice.
|
|
8
|
+
[**aggregate_invoices**](InvoicesApi.md#aggregate_invoices) | **POST** /invoices/aggregate | Aggregate Invoices into to one parent Invoice
|
|
9
|
+
[**execute_invoice**](InvoicesApi.md#execute_invoice) | **POST** /invoices/{invoice-ID}/execute | Attempt payment for the outstanding value of an invoice
|
|
10
|
+
[**generate_line_payments_for_all_invoices**](InvoicesApi.md#generate_line_payments_for_all_invoices) | **POST** /invoices/generate-line-payments | Generates InvoiceLinePayments for all existing InvoicePayments.
|
|
11
|
+
[**get_all_invoices**](InvoicesApi.md#get_all_invoices) | **GET** /invoices | Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order.
|
|
12
|
+
[**get_all_invoices_as_csv**](InvoicesApi.md#get_all_invoices_as_csv) | **GET** /invoices/all.csv | Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order.
|
|
13
|
+
[**get_bucketed_revenue_attributions_as_csv**](InvoicesApi.md#get_bucketed_revenue_attributions_as_csv) | **GET** /invoices/bucketed-revenue-attributions.csv | Retrieves (as CSV) all attributions of Invoice costs to Invoice lines, bucketed.
|
|
14
|
+
[**get_charges_on_invoice**](InvoicesApi.md#get_charges_on_invoice) | **GET** /invoices/{invoice-ID}/charges | Returns all charges for the specified invoice. By default 10 values are returned. Records are returned in natural order.
|
|
15
|
+
[**get_credit_invoice_line_payments_from_invoices_as_csv**](InvoicesApi.md#get_credit_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/credit.csv | Retrieves credit note-paid from InvoicePayments upon line items, in CSV format.
|
|
16
|
+
[**get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received**](InvoicesApi.md#get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received) | **GET** /invoices/payment-received/credit.csv | Retrieves credit note-paid from InvoicePayments upon line items, in CSV format.
|
|
17
|
+
[**get_debit_invoice_line_payments_from_invoices_as_csv**](InvoicesApi.md#get_debit_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/revenue.csv | Retrieves received revenue from InvoicePayments upon line items, in CSV format.
|
|
18
|
+
[**get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received**](InvoicesApi.md#get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received) | **GET** /invoices/payment-received/revenue.csv | Retrieves received revenue from InvoicePayments upon line items, in CSV format.
|
|
19
|
+
[**get_invoice_as_html**](InvoicesApi.md#get_invoice_as_html) | **GET** /invoices/{ID}.html | Retrieves a single invoice specified by the ID parameter.
|
|
20
|
+
[**get_invoice_as_pdf**](InvoicesApi.md#get_invoice_as_pdf) | **GET** /invoices/{ID}.pdf | Retrieves a single invoice specified by the ID parameter.
|
|
21
|
+
[**get_invoice_by_id**](InvoicesApi.md#get_invoice_by_id) | **GET** /invoices/{invoice-ID} | Retrieves a single invoice specified by the invoice-ID parameter.
|
|
22
|
+
[**get_invoice_by_id_as_csv**](InvoicesApi.md#get_invoice_by_id_as_csv) | **GET** /invoices/{ID}.csv | Retrieves a single invoice specified by the ID parameter.
|
|
23
|
+
[**get_invoice_by_subscription_id**](InvoicesApi.md#get_invoice_by_subscription_id) | **GET** /invoices/subscription/{subscription-ID} | Retrieves a collection of invoices specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
24
|
+
[**get_invoice_by_subscription_version_id**](InvoicesApi.md#get_invoice_by_subscription_version_id) | **GET** /invoices/subscription/version/{subscription-version-ID} | Retrieves a collection of invoices specified by the subscription-version-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
25
|
+
[**get_invoice_by_version_id**](InvoicesApi.md#get_invoice_by_version_id) | **GET** /invoices/version/{version-ID} | Retrieves a single invoice, specified by the version-ID parameter.
|
|
26
|
+
[**get_invoices_by_account_id**](InvoicesApi.md#get_invoices_by_account_id) | **GET** /invoices/account/{account-ID} | Retrieves a collection of invoices specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
27
|
+
[**get_invoices_by_period_end**](InvoicesApi.md#get_invoices_by_period_end) | **GET** /invoices/period-end/{lower-threshold}/{upper-threshold} | Retrieves a collection of invoice objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
28
|
+
[**get_invoices_by_period_start**](InvoicesApi.md#get_invoices_by_period_start) | **GET** /invoices/period-start/{lower-threshold}/{upper-threshold} | Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
29
|
+
[**get_invoices_by_period_start_as_csv**](InvoicesApi.md#get_invoices_by_period_start_as_csv) | **GET** /invoices/period-start/{lower-threshold}/{upper-threshold}.csv | Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
30
|
+
[**get_invoices_by_state**](InvoicesApi.md#get_invoices_by_state) | **GET** /invoices/state/{state} | Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
|
|
31
|
+
[**get_invoices_by_state_and_period_start**](InvoicesApi.md#get_invoices_by_state_and_period_start) | **GET** /invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold} | Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
32
|
+
[**get_invoices_by_state_and_period_start_as_csv**](InvoicesApi.md#get_invoices_by_state_and_period_start_as_csv) | **GET** /invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold}.csv | Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
33
|
+
[**get_invoices_by_state_as_csv**](InvoicesApi.md#get_invoices_by_state_as_csv) | **GET** /invoices/state/{state}.csv | Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
|
|
34
|
+
[**get_line_payments**](InvoicesApi.md#get_line_payments) | **GET** /invoices/line-payments | Retrieves all InvoiceLine payment attributions.
|
|
35
|
+
[**get_line_payments_as_csv**](InvoicesApi.md#get_line_payments_as_csv) | **GET** /invoices/line-payments.csv | Retrieves (as CSV) all InvoiceLine payment attributions.
|
|
36
|
+
[**get_metadata_for_invoice**](InvoicesApi.md#get_metadata_for_invoice) | **GET** /invoices/{invoice-ID}/metadata | Retrieve any associated metadata.
|
|
37
|
+
[**get_refund_invoice_line_payments_from_invoices_as_csv**](InvoicesApi.md#get_refund_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/refund.csv | Retrieves awarded refunds from InvoicePayments upon line items, in CSV format.
|
|
38
|
+
[**get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received**](InvoicesApi.md#get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received) | **GET** /invoices/payment-received/refund.csv | Retrieves awarded refunds from InvoicePayments upon line items, in CSV format.
|
|
39
|
+
[**get_revenue_attributions**](InvoicesApi.md#get_revenue_attributions) | **GET** /invoices/revenue-attributions | Retrieves all attributions of Invoice costs to Invoice lines.
|
|
40
|
+
[**get_revenue_attributions_as_csv**](InvoicesApi.md#get_revenue_attributions_as_csv) | **GET** /invoices/revenue-attributions.csv | Retrieves (as CSV) all attributions of Invoice costs to Invoice lines.
|
|
41
|
+
[**get_swagger_for_invoice**](InvoicesApi.md#get_swagger_for_invoice) | **GET** /invoices/swagger-end-point/{query-string} |
|
|
42
|
+
[**import_invoice**](InvoicesApi.md#import_invoice) | **POST** /invoices/import | Import an invoice.
|
|
43
|
+
[**recalculate_invoice**](InvoicesApi.md#recalculate_invoice) | **POST** /invoices/{invoice-ID}/recalculate | Re-calculate an Invoice.
|
|
44
|
+
[**remove_charge_from_invoice**](InvoicesApi.md#remove_charge_from_invoice) | **DELETE** /invoices/{invoice-ID}/charges/{charge-ID} | Removes the specified charge from the specified Invoice.
|
|
45
|
+
[**remove_metadata_from_invoice**](InvoicesApi.md#remove_metadata_from_invoice) | **DELETE** /invoices/{invoice-ID}/metadata | Remove any associated metadata.
|
|
46
|
+
[**set_metadata_for_invoice**](InvoicesApi.md#set_metadata_for_invoice) | **POST** /invoices/{invoice-ID}/metadata | Remove any existing metadata keys and create the provided data.
|
|
47
|
+
[**update_invoice**](InvoicesApi.md#update_invoice) | **PUT** /invoices | Update an Invoice.
|
|
48
|
+
[**upsert_metadata_for_invoice**](InvoicesApi.md#upsert_metadata_for_invoice) | **PUT** /invoices/{invoice-ID}/metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed.
|
|
49
|
+
[**void_invoice**](InvoicesApi.md#void_invoice) | **DELETE** /invoices/{invoice-ID} | Voids the invoice specified by the invoice identifier parameter.
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
# **add_charge_to_invoice**
|
|
53
|
+
> SubscriptionChargePagedMetadata add_charge_to_invoice(invoice_id, charge)
|
|
54
|
+
|
|
55
|
+
Creates a charge on the specified invoice.
|
|
56
|
+
|
|
57
|
+
{\"nickname\":\"Add to invoice\",\"response\":\"addChargeToInvoice.html\",\"request\":\"addChargeToInvoiceRequest.html\"}
|
|
58
|
+
|
|
59
|
+
### Example
|
|
60
|
+
```ruby
|
|
61
|
+
# load the gem
|
|
62
|
+
require 'bf_ruby2'
|
|
63
|
+
|
|
64
|
+
api_instance = BillForward::InvoicesApi.new
|
|
65
|
+
|
|
66
|
+
invoice_id = "invoice_id_example" # String | ID of the invoice.
|
|
67
|
+
|
|
68
|
+
charge = BillForward::AddChargeRequest.new # AddChargeRequest | The charge request
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
begin
|
|
72
|
+
#Creates a charge on the specified invoice.
|
|
73
|
+
result = api_instance.add_charge_to_invoice(invoice_id, charge)
|
|
74
|
+
p result
|
|
75
|
+
rescue BillForward::ApiError => e
|
|
76
|
+
puts "Exception when calling InvoicesApi->add_charge_to_invoice: #{e}"
|
|
77
|
+
end
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Parameters
|
|
81
|
+
|
|
82
|
+
Name | Type | Description | Notes
|
|
83
|
+
------------- | ------------- | ------------- | -------------
|
|
84
|
+
**invoice_id** | **String**| ID of the invoice. |
|
|
85
|
+
**charge** | [**AddChargeRequest**](AddChargeRequest.md)| The charge request |
|
|
86
|
+
|
|
87
|
+
### Return type
|
|
88
|
+
|
|
89
|
+
[**SubscriptionChargePagedMetadata**](SubscriptionChargePagedMetadata.md)
|
|
90
|
+
|
|
91
|
+
### Authorization
|
|
92
|
+
|
|
93
|
+
No authorization required
|
|
94
|
+
|
|
95
|
+
### HTTP request headers
|
|
96
|
+
|
|
97
|
+
- **Content-Type**: application/json
|
|
98
|
+
- **Accept**: application/json
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
# **aggregate_invoices**
|
|
103
|
+
> InvoicePagedMetadata aggregate_invoices(request)
|
|
104
|
+
|
|
105
|
+
Aggregate Invoices into to one parent Invoice
|
|
106
|
+
|
|
107
|
+
{\"nickname\":\"Aggregate invoices\",\"response\":\"AggregateResponse.html\",\"request\":\"AggregateRequest.html\"}
|
|
108
|
+
|
|
109
|
+
### Example
|
|
110
|
+
```ruby
|
|
111
|
+
# load the gem
|
|
112
|
+
require 'bf_ruby2'
|
|
113
|
+
|
|
114
|
+
api_instance = BillForward::InvoicesApi.new
|
|
115
|
+
|
|
116
|
+
request = BillForward::BillingEntityBase.new # BillingEntityBase |
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
begin
|
|
120
|
+
#Aggregate Invoices into to one parent Invoice
|
|
121
|
+
result = api_instance.aggregate_invoices(request)
|
|
122
|
+
p result
|
|
123
|
+
rescue BillForward::ApiError => e
|
|
124
|
+
puts "Exception when calling InvoicesApi->aggregate_invoices: #{e}"
|
|
125
|
+
end
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Parameters
|
|
129
|
+
|
|
130
|
+
Name | Type | Description | Notes
|
|
131
|
+
------------- | ------------- | ------------- | -------------
|
|
132
|
+
**request** | [**BillingEntityBase**](BillingEntityBase.md)| |
|
|
133
|
+
|
|
134
|
+
### Return type
|
|
135
|
+
|
|
136
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
137
|
+
|
|
138
|
+
### Authorization
|
|
139
|
+
|
|
140
|
+
No authorization required
|
|
141
|
+
|
|
142
|
+
### HTTP request headers
|
|
143
|
+
|
|
144
|
+
- **Content-Type**: application/json
|
|
145
|
+
- **Accept**: application/json
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
# **execute_invoice**
|
|
150
|
+
> InvoicePagedMetadata execute_invoice(invoice_id, request)
|
|
151
|
+
|
|
152
|
+
Attempt payment for the outstanding value of an invoice
|
|
153
|
+
|
|
154
|
+
{\"nickname\":\"Execute invoice\",\"response\":\"executeInvoiceResponse.html\",\"request\":\"ExecuteInvoiceRequest.html\"}
|
|
155
|
+
|
|
156
|
+
### Example
|
|
157
|
+
```ruby
|
|
158
|
+
# load the gem
|
|
159
|
+
require 'bf_ruby2'
|
|
160
|
+
|
|
161
|
+
api_instance = BillForward::InvoicesApi.new
|
|
162
|
+
|
|
163
|
+
invoice_id = "invoice_id_example" # String |
|
|
164
|
+
|
|
165
|
+
request = BillForward::BillingEntityBase.new # BillingEntityBase |
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
begin
|
|
169
|
+
#Attempt payment for the outstanding value of an invoice
|
|
170
|
+
result = api_instance.execute_invoice(invoice_id, request)
|
|
171
|
+
p result
|
|
172
|
+
rescue BillForward::ApiError => e
|
|
173
|
+
puts "Exception when calling InvoicesApi->execute_invoice: #{e}"
|
|
174
|
+
end
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### Parameters
|
|
178
|
+
|
|
179
|
+
Name | Type | Description | Notes
|
|
180
|
+
------------- | ------------- | ------------- | -------------
|
|
181
|
+
**invoice_id** | **String**| |
|
|
182
|
+
**request** | [**BillingEntityBase**](BillingEntityBase.md)| |
|
|
183
|
+
|
|
184
|
+
### Return type
|
|
185
|
+
|
|
186
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
187
|
+
|
|
188
|
+
### Authorization
|
|
189
|
+
|
|
190
|
+
No authorization required
|
|
191
|
+
|
|
192
|
+
### HTTP request headers
|
|
193
|
+
|
|
194
|
+
- **Content-Type**: application/json
|
|
195
|
+
- **Accept**: application/json
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
# **generate_line_payments_for_all_invoices**
|
|
200
|
+
> InvoiceLinePaymentPagedMetadata generate_line_payments_for_all_invoices(opts)
|
|
201
|
+
|
|
202
|
+
Generates InvoiceLinePayments for all existing InvoicePayments.
|
|
203
|
+
|
|
204
|
+
{ \"nickname\" : \"Generate InvoiceLinePayments\",\"response\" : \"Generate InvoiceLinePayments.html\"}
|
|
205
|
+
|
|
206
|
+
### Example
|
|
207
|
+
```ruby
|
|
208
|
+
# load the gem
|
|
209
|
+
require 'bf_ruby2'
|
|
210
|
+
|
|
211
|
+
api_instance = BillForward::InvoicesApi.new
|
|
212
|
+
|
|
213
|
+
opts = {
|
|
214
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
215
|
+
}
|
|
216
|
+
|
|
217
|
+
begin
|
|
218
|
+
#Generates InvoiceLinePayments for all existing InvoicePayments.
|
|
219
|
+
result = api_instance.generate_line_payments_for_all_invoices(opts)
|
|
220
|
+
p result
|
|
221
|
+
rescue BillForward::ApiError => e
|
|
222
|
+
puts "Exception when calling InvoicesApi->generate_line_payments_for_all_invoices: #{e}"
|
|
223
|
+
end
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
### Parameters
|
|
227
|
+
|
|
228
|
+
Name | Type | Description | Notes
|
|
229
|
+
------------- | ------------- | ------------- | -------------
|
|
230
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
231
|
+
|
|
232
|
+
### Return type
|
|
233
|
+
|
|
234
|
+
[**InvoiceLinePaymentPagedMetadata**](InvoiceLinePaymentPagedMetadata.md)
|
|
235
|
+
|
|
236
|
+
### Authorization
|
|
237
|
+
|
|
238
|
+
No authorization required
|
|
239
|
+
|
|
240
|
+
### HTTP request headers
|
|
241
|
+
|
|
242
|
+
- **Content-Type**: application/json
|
|
243
|
+
- **Accept**: application/json
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
# **get_all_invoices**
|
|
248
|
+
> InvoicePagedMetadata get_all_invoices(opts)
|
|
249
|
+
|
|
250
|
+
Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order.
|
|
251
|
+
|
|
252
|
+
{ \"nickname\" : \"Retrieve all invoices\",\"response\" : \"getInvoiceAll.html\"}
|
|
253
|
+
|
|
254
|
+
### Example
|
|
255
|
+
```ruby
|
|
256
|
+
# load the gem
|
|
257
|
+
require 'bf_ruby2'
|
|
258
|
+
|
|
259
|
+
api_instance = BillForward::InvoicesApi.new
|
|
260
|
+
|
|
261
|
+
opts = {
|
|
262
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
263
|
+
offset: 0, # Integer | The offset from the first invoice to return.
|
|
264
|
+
records: 10, # Integer | The maximum number of invoices to return.
|
|
265
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
266
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
267
|
+
include_retired: false, # BOOLEAN | Whether retired products should be returned.
|
|
268
|
+
exclude_children: true, # BOOLEAN | Should child invoices be excluded.
|
|
269
|
+
metadata: "metadata_example" # String |
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
begin
|
|
273
|
+
#Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order.
|
|
274
|
+
result = api_instance.get_all_invoices(opts)
|
|
275
|
+
p result
|
|
276
|
+
rescue BillForward::ApiError => e
|
|
277
|
+
puts "Exception when calling InvoicesApi->get_all_invoices: #{e}"
|
|
278
|
+
end
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
### Parameters
|
|
282
|
+
|
|
283
|
+
Name | Type | Description | Notes
|
|
284
|
+
------------- | ------------- | ------------- | -------------
|
|
285
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
286
|
+
**offset** | **Integer**| The offset from the first invoice to return. | [optional] [default to 0]
|
|
287
|
+
**records** | **Integer**| The maximum number of invoices to return. | [optional] [default to 10]
|
|
288
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
289
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
290
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to false]
|
|
291
|
+
**exclude_children** | **BOOLEAN**| Should child invoices be excluded. | [optional] [default to true]
|
|
292
|
+
**metadata** | **String**| | [optional]
|
|
293
|
+
|
|
294
|
+
### Return type
|
|
295
|
+
|
|
296
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
297
|
+
|
|
298
|
+
### Authorization
|
|
299
|
+
|
|
300
|
+
No authorization required
|
|
301
|
+
|
|
302
|
+
### HTTP request headers
|
|
303
|
+
|
|
304
|
+
- **Content-Type**: text/plain, application/json
|
|
305
|
+
- **Accept**: application/json
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
# **get_all_invoices_as_csv**
|
|
310
|
+
> InvoicePagedMetadata get_all_invoices_as_csv(opts)
|
|
311
|
+
|
|
312
|
+
Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order.
|
|
313
|
+
|
|
314
|
+
{ \"nickname\" : \"Retrieve all invoices\",\"response\" : \"getInvoiceAll.csv\"}
|
|
315
|
+
|
|
316
|
+
### Example
|
|
317
|
+
```ruby
|
|
318
|
+
# load the gem
|
|
319
|
+
require 'bf_ruby2'
|
|
320
|
+
|
|
321
|
+
api_instance = BillForward::InvoicesApi.new
|
|
322
|
+
|
|
323
|
+
opts = {
|
|
324
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
325
|
+
offset: 0, # Integer | The offset from the first invoice to return.
|
|
326
|
+
records: 10, # Integer | The maximum number of invoices to return.
|
|
327
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
328
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
329
|
+
include_retired: false # BOOLEAN | Whether retired products should be returned.
|
|
330
|
+
}
|
|
331
|
+
|
|
332
|
+
begin
|
|
333
|
+
#Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order.
|
|
334
|
+
result = api_instance.get_all_invoices_as_csv(opts)
|
|
335
|
+
p result
|
|
336
|
+
rescue BillForward::ApiError => e
|
|
337
|
+
puts "Exception when calling InvoicesApi->get_all_invoices_as_csv: #{e}"
|
|
338
|
+
end
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
### Parameters
|
|
342
|
+
|
|
343
|
+
Name | Type | Description | Notes
|
|
344
|
+
------------- | ------------- | ------------- | -------------
|
|
345
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
346
|
+
**offset** | **Integer**| The offset from the first invoice to return. | [optional] [default to 0]
|
|
347
|
+
**records** | **Integer**| The maximum number of invoices to return. | [optional] [default to 10]
|
|
348
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
349
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
350
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to false]
|
|
351
|
+
|
|
352
|
+
### Return type
|
|
353
|
+
|
|
354
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
355
|
+
|
|
356
|
+
### Authorization
|
|
357
|
+
|
|
358
|
+
No authorization required
|
|
359
|
+
|
|
360
|
+
### HTTP request headers
|
|
361
|
+
|
|
362
|
+
- **Content-Type**: text/plain, application/json
|
|
363
|
+
- **Accept**: text/csv
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
# **get_bucketed_revenue_attributions_as_csv**
|
|
368
|
+
> String get_bucketed_revenue_attributions_as_csv(opts)
|
|
369
|
+
|
|
370
|
+
Retrieves (as CSV) all attributions of Invoice costs to Invoice lines, bucketed.
|
|
371
|
+
|
|
372
|
+
{ \"nickname\" : \"(CSV) Retrieve bucketed revenue attributions\",\"response\" : \"getBucketedRevenueAttributions.csv\"}
|
|
373
|
+
|
|
374
|
+
### Example
|
|
375
|
+
```ruby
|
|
376
|
+
# load the gem
|
|
377
|
+
require 'bf_ruby2'
|
|
378
|
+
|
|
379
|
+
api_instance = BillForward::InvoicesApi.new
|
|
380
|
+
|
|
381
|
+
opts = {
|
|
382
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
383
|
+
recognition_start: "recognition_start_example", # String | The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24).
|
|
384
|
+
recognition_end: "recognition_end_example" # String | The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24).
|
|
385
|
+
}
|
|
386
|
+
|
|
387
|
+
begin
|
|
388
|
+
#Retrieves (as CSV) all attributions of Invoice costs to Invoice lines, bucketed.
|
|
389
|
+
result = api_instance.get_bucketed_revenue_attributions_as_csv(opts)
|
|
390
|
+
p result
|
|
391
|
+
rescue BillForward::ApiError => e
|
|
392
|
+
puts "Exception when calling InvoicesApi->get_bucketed_revenue_attributions_as_csv: #{e}"
|
|
393
|
+
end
|
|
394
|
+
```
|
|
395
|
+
|
|
396
|
+
### Parameters
|
|
397
|
+
|
|
398
|
+
Name | Type | Description | Notes
|
|
399
|
+
------------- | ------------- | ------------- | -------------
|
|
400
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
401
|
+
**recognition_start** | **String**| The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24). | [optional]
|
|
402
|
+
**recognition_end** | **String**| The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24). | [optional]
|
|
403
|
+
|
|
404
|
+
### Return type
|
|
405
|
+
|
|
406
|
+
**String**
|
|
407
|
+
|
|
408
|
+
### Authorization
|
|
409
|
+
|
|
410
|
+
No authorization required
|
|
411
|
+
|
|
412
|
+
### HTTP request headers
|
|
413
|
+
|
|
414
|
+
- **Content-Type**: Not defined
|
|
415
|
+
- **Accept**: Not defined
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
# **get_charges_on_invoice**
|
|
420
|
+
> SubscriptionChargePagedMetadata get_charges_on_invoice(invoice_id, opts)
|
|
421
|
+
|
|
422
|
+
Returns all charges for the specified invoice. By default 10 values are returned. Records are returned in natural order.
|
|
423
|
+
|
|
424
|
+
{\"nickname\":\"List on invoice\",\"response\":\"getChargesInvoice.html\"}
|
|
425
|
+
|
|
426
|
+
### Example
|
|
427
|
+
```ruby
|
|
428
|
+
# load the gem
|
|
429
|
+
require 'bf_ruby2'
|
|
430
|
+
|
|
431
|
+
api_instance = BillForward::InvoicesApi.new
|
|
432
|
+
|
|
433
|
+
invoice_id = "invoice_id_example" # String |
|
|
434
|
+
|
|
435
|
+
opts = {
|
|
436
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
437
|
+
offset: 0, # Integer | The offset from the first subscription to return.
|
|
438
|
+
records: 10, # Integer | The maximum number of subscriptions to return.
|
|
439
|
+
order_by: "id", # String | Specify a field used to order the result set.
|
|
440
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
441
|
+
state: "state_example", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
442
|
+
type: "type_example", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
443
|
+
include_retired: false # BOOLEAN | Whether retired subscriptions should be returned.
|
|
444
|
+
}
|
|
445
|
+
|
|
446
|
+
begin
|
|
447
|
+
#Returns all charges for the specified invoice. By default 10 values are returned. Records are returned in natural order.
|
|
448
|
+
result = api_instance.get_charges_on_invoice(invoice_id, opts)
|
|
449
|
+
p result
|
|
450
|
+
rescue BillForward::ApiError => e
|
|
451
|
+
puts "Exception when calling InvoicesApi->get_charges_on_invoice: #{e}"
|
|
452
|
+
end
|
|
453
|
+
```
|
|
454
|
+
|
|
455
|
+
### Parameters
|
|
456
|
+
|
|
457
|
+
Name | Type | Description | Notes
|
|
458
|
+
------------- | ------------- | ------------- | -------------
|
|
459
|
+
**invoice_id** | **String**| |
|
|
460
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
461
|
+
**offset** | **Integer**| The offset from the first subscription to return. | [optional] [default to 0]
|
|
462
|
+
**records** | **Integer**| The maximum number of subscriptions to return. | [optional] [default to 10]
|
|
463
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to id]
|
|
464
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
465
|
+
**state** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional]
|
|
466
|
+
**type** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional]
|
|
467
|
+
**include_retired** | **BOOLEAN**| Whether retired subscriptions should be returned. | [optional] [default to false]
|
|
468
|
+
|
|
469
|
+
### Return type
|
|
470
|
+
|
|
471
|
+
[**SubscriptionChargePagedMetadata**](SubscriptionChargePagedMetadata.md)
|
|
472
|
+
|
|
473
|
+
### Authorization
|
|
474
|
+
|
|
475
|
+
No authorization required
|
|
476
|
+
|
|
477
|
+
### HTTP request headers
|
|
478
|
+
|
|
479
|
+
- **Content-Type**: text/plain, application/json
|
|
480
|
+
- **Accept**: application/json
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
# **get_credit_invoice_line_payments_from_invoices_as_csv**
|
|
485
|
+
> InvoiceLinePaymentPagedMetadata get_credit_invoice_line_payments_from_invoices_as_csv(opts)
|
|
486
|
+
|
|
487
|
+
Retrieves credit note-paid from InvoicePayments upon line items, in CSV format.
|
|
488
|
+
|
|
489
|
+
{ \"nickname\" : \"Credit InvoiceLinePayments CSV\",\"response\" : \"Credit InvoiceLinePayments.csv\"}
|
|
490
|
+
|
|
491
|
+
### Example
|
|
492
|
+
```ruby
|
|
493
|
+
# load the gem
|
|
494
|
+
require 'bf_ruby2'
|
|
495
|
+
|
|
496
|
+
api_instance = BillForward::InvoicesApi.new
|
|
497
|
+
|
|
498
|
+
opts = {
|
|
499
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
500
|
+
recognition_start: "recognition_start_example", # String | The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24).
|
|
501
|
+
recognition_end: "recognition_end_example" # String | The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24).
|
|
502
|
+
}
|
|
503
|
+
|
|
504
|
+
begin
|
|
505
|
+
#Retrieves credit note-paid from InvoicePayments upon line items, in CSV format.
|
|
506
|
+
result = api_instance.get_credit_invoice_line_payments_from_invoices_as_csv(opts)
|
|
507
|
+
p result
|
|
508
|
+
rescue BillForward::ApiError => e
|
|
509
|
+
puts "Exception when calling InvoicesApi->get_credit_invoice_line_payments_from_invoices_as_csv: #{e}"
|
|
510
|
+
end
|
|
511
|
+
```
|
|
512
|
+
|
|
513
|
+
### Parameters
|
|
514
|
+
|
|
515
|
+
Name | Type | Description | Notes
|
|
516
|
+
------------- | ------------- | ------------- | -------------
|
|
517
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
518
|
+
**recognition_start** | **String**| The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24). | [optional]
|
|
519
|
+
**recognition_end** | **String**| The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24). | [optional]
|
|
520
|
+
|
|
521
|
+
### Return type
|
|
522
|
+
|
|
523
|
+
[**InvoiceLinePaymentPagedMetadata**](InvoiceLinePaymentPagedMetadata.md)
|
|
524
|
+
|
|
525
|
+
### Authorization
|
|
526
|
+
|
|
527
|
+
No authorization required
|
|
528
|
+
|
|
529
|
+
### HTTP request headers
|
|
530
|
+
|
|
531
|
+
- **Content-Type**: text/plain, application/json
|
|
532
|
+
- **Accept**: text/csv
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
# **get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received**
|
|
537
|
+
> InvoiceLinePaymentPagedMetadata get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received(opts)
|
|
538
|
+
|
|
539
|
+
Retrieves credit note-paid from InvoicePayments upon line items, in CSV format.
|
|
540
|
+
|
|
541
|
+
{ \"nickname\" : \"Credit InvoiceLinePayments CSV\",\"response\" : \"Credit InvoiceLinePayments.csv\"}
|
|
542
|
+
|
|
543
|
+
### Example
|
|
544
|
+
```ruby
|
|
545
|
+
# load the gem
|
|
546
|
+
require 'bf_ruby2'
|
|
547
|
+
|
|
548
|
+
api_instance = BillForward::InvoicesApi.new
|
|
549
|
+
|
|
550
|
+
opts = {
|
|
551
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
552
|
+
recognition_start: "recognition_start_example", # String | The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24).
|
|
553
|
+
recognition_end: "recognition_end_example" # String | The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24).
|
|
554
|
+
}
|
|
555
|
+
|
|
556
|
+
begin
|
|
557
|
+
#Retrieves credit note-paid from InvoicePayments upon line items, in CSV format.
|
|
558
|
+
result = api_instance.get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received(opts)
|
|
559
|
+
p result
|
|
560
|
+
rescue BillForward::ApiError => e
|
|
561
|
+
puts "Exception when calling InvoicesApi->get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received: #{e}"
|
|
562
|
+
end
|
|
563
|
+
```
|
|
564
|
+
|
|
565
|
+
### Parameters
|
|
566
|
+
|
|
567
|
+
Name | Type | Description | Notes
|
|
568
|
+
------------- | ------------- | ------------- | -------------
|
|
569
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
570
|
+
**recognition_start** | **String**| The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24). | [optional]
|
|
571
|
+
**recognition_end** | **String**| The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24). | [optional]
|
|
572
|
+
|
|
573
|
+
### Return type
|
|
574
|
+
|
|
575
|
+
[**InvoiceLinePaymentPagedMetadata**](InvoiceLinePaymentPagedMetadata.md)
|
|
576
|
+
|
|
577
|
+
### Authorization
|
|
578
|
+
|
|
579
|
+
No authorization required
|
|
580
|
+
|
|
581
|
+
### HTTP request headers
|
|
582
|
+
|
|
583
|
+
- **Content-Type**: text/plain, application/json
|
|
584
|
+
- **Accept**: text/csv
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
# **get_debit_invoice_line_payments_from_invoices_as_csv**
|
|
589
|
+
> InvoiceLinePaymentPagedMetadata get_debit_invoice_line_payments_from_invoices_as_csv(opts)
|
|
590
|
+
|
|
591
|
+
Retrieves received revenue from InvoicePayments upon line items, in CSV format.
|
|
592
|
+
|
|
593
|
+
{ \"nickname\" : \"Debit InvoiceLinePayments CSV\",\"response\" : \"Debit InvoiceLinePayments.csv\"}
|
|
594
|
+
|
|
595
|
+
### Example
|
|
596
|
+
```ruby
|
|
597
|
+
# load the gem
|
|
598
|
+
require 'bf_ruby2'
|
|
599
|
+
|
|
600
|
+
api_instance = BillForward::InvoicesApi.new
|
|
601
|
+
|
|
602
|
+
opts = {
|
|
603
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
604
|
+
recognition_start: "recognition_start_example", # String | The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24).
|
|
605
|
+
recognition_end: "recognition_end_example" # String | The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24).
|
|
606
|
+
}
|
|
607
|
+
|
|
608
|
+
begin
|
|
609
|
+
#Retrieves received revenue from InvoicePayments upon line items, in CSV format.
|
|
610
|
+
result = api_instance.get_debit_invoice_line_payments_from_invoices_as_csv(opts)
|
|
611
|
+
p result
|
|
612
|
+
rescue BillForward::ApiError => e
|
|
613
|
+
puts "Exception when calling InvoicesApi->get_debit_invoice_line_payments_from_invoices_as_csv: #{e}"
|
|
614
|
+
end
|
|
615
|
+
```
|
|
616
|
+
|
|
617
|
+
### Parameters
|
|
618
|
+
|
|
619
|
+
Name | Type | Description | Notes
|
|
620
|
+
------------- | ------------- | ------------- | -------------
|
|
621
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
622
|
+
**recognition_start** | **String**| The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24). | [optional]
|
|
623
|
+
**recognition_end** | **String**| The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24). | [optional]
|
|
624
|
+
|
|
625
|
+
### Return type
|
|
626
|
+
|
|
627
|
+
[**InvoiceLinePaymentPagedMetadata**](InvoiceLinePaymentPagedMetadata.md)
|
|
628
|
+
|
|
629
|
+
### Authorization
|
|
630
|
+
|
|
631
|
+
No authorization required
|
|
632
|
+
|
|
633
|
+
### HTTP request headers
|
|
634
|
+
|
|
635
|
+
- **Content-Type**: text/plain, application/json
|
|
636
|
+
- **Accept**: text/csv
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
# **get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received**
|
|
641
|
+
> InvoiceLinePaymentPagedMetadata get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received(opts)
|
|
642
|
+
|
|
643
|
+
Retrieves received revenue from InvoicePayments upon line items, in CSV format.
|
|
644
|
+
|
|
645
|
+
{ \"nickname\" : \"Debit InvoiceLinePayments CSV\",\"response\" : \"Debit InvoiceLinePayments.csv\"}
|
|
646
|
+
|
|
647
|
+
### Example
|
|
648
|
+
```ruby
|
|
649
|
+
# load the gem
|
|
650
|
+
require 'bf_ruby2'
|
|
651
|
+
|
|
652
|
+
api_instance = BillForward::InvoicesApi.new
|
|
653
|
+
|
|
654
|
+
opts = {
|
|
655
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
656
|
+
recognition_start: "recognition_start_example", # String | The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24).
|
|
657
|
+
recognition_end: "recognition_end_example" # String | The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24).
|
|
658
|
+
}
|
|
659
|
+
|
|
660
|
+
begin
|
|
661
|
+
#Retrieves received revenue from InvoicePayments upon line items, in CSV format.
|
|
662
|
+
result = api_instance.get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received(opts)
|
|
663
|
+
p result
|
|
664
|
+
rescue BillForward::ApiError => e
|
|
665
|
+
puts "Exception when calling InvoicesApi->get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received: #{e}"
|
|
666
|
+
end
|
|
667
|
+
```
|
|
668
|
+
|
|
669
|
+
### Parameters
|
|
670
|
+
|
|
671
|
+
Name | Type | Description | Notes
|
|
672
|
+
------------- | ------------- | ------------- | -------------
|
|
673
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
674
|
+
**recognition_start** | **String**| The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24). | [optional]
|
|
675
|
+
**recognition_end** | **String**| The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24). | [optional]
|
|
676
|
+
|
|
677
|
+
### Return type
|
|
678
|
+
|
|
679
|
+
[**InvoiceLinePaymentPagedMetadata**](InvoiceLinePaymentPagedMetadata.md)
|
|
680
|
+
|
|
681
|
+
### Authorization
|
|
682
|
+
|
|
683
|
+
No authorization required
|
|
684
|
+
|
|
685
|
+
### HTTP request headers
|
|
686
|
+
|
|
687
|
+
- **Content-Type**: text/plain, application/json
|
|
688
|
+
- **Accept**: text/csv
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
# **get_invoice_as_html**
|
|
693
|
+
> String get_invoice_as_html(id, opts)
|
|
694
|
+
|
|
695
|
+
Retrieves a single invoice specified by the ID parameter.
|
|
696
|
+
|
|
697
|
+
{ \"nickname\" : \"HTML invoice\",\"response\" : \"getInvoiceByID.HTML.html\"}
|
|
698
|
+
|
|
699
|
+
### Example
|
|
700
|
+
```ruby
|
|
701
|
+
# load the gem
|
|
702
|
+
require 'bf_ruby2'
|
|
703
|
+
|
|
704
|
+
api_instance = BillForward::InvoicesApi.new
|
|
705
|
+
|
|
706
|
+
id = "id_example" # String | The ID of the invoice.
|
|
707
|
+
|
|
708
|
+
opts = {
|
|
709
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
710
|
+
offset: 0, # Integer | The offset from the first invoice to return.
|
|
711
|
+
records: 10, # Integer | The maximum number of invoices to return.
|
|
712
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
713
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
714
|
+
include_retired: false, # BOOLEAN | Whether retired products should be returned.
|
|
715
|
+
tier_breakdown: false, # BOOLEAN | Whether to provide a breakdown of charge tiering.
|
|
716
|
+
inclusive_end: false, # BOOLEAN | Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the \"period end\" date shown to the customer.
|
|
717
|
+
show_zero_cost: true, # BOOLEAN | Whether to show zero-cost lines.
|
|
718
|
+
show_plan_only_when_ambiguous: true # BOOLEAN | Whether to state which plan the Invoice lines came from, regardless of whether there's only one plan involved in this Invoice.
|
|
719
|
+
}
|
|
720
|
+
|
|
721
|
+
begin
|
|
722
|
+
#Retrieves a single invoice specified by the ID parameter.
|
|
723
|
+
result = api_instance.get_invoice_as_html(id, opts)
|
|
724
|
+
p result
|
|
725
|
+
rescue BillForward::ApiError => e
|
|
726
|
+
puts "Exception when calling InvoicesApi->get_invoice_as_html: #{e}"
|
|
727
|
+
end
|
|
728
|
+
```
|
|
729
|
+
|
|
730
|
+
### Parameters
|
|
731
|
+
|
|
732
|
+
Name | Type | Description | Notes
|
|
733
|
+
------------- | ------------- | ------------- | -------------
|
|
734
|
+
**id** | **String**| The ID of the invoice. |
|
|
735
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
736
|
+
**offset** | **Integer**| The offset from the first invoice to return. | [optional] [default to 0]
|
|
737
|
+
**records** | **Integer**| The maximum number of invoices to return. | [optional] [default to 10]
|
|
738
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
739
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
740
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to false]
|
|
741
|
+
**tier_breakdown** | **BOOLEAN**| Whether to provide a breakdown of charge tiering. | [optional] [default to false]
|
|
742
|
+
**inclusive_end** | **BOOLEAN**| Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the \"period end\" date shown to the customer. | [optional] [default to false]
|
|
743
|
+
**show_zero_cost** | **BOOLEAN**| Whether to show zero-cost lines. | [optional] [default to true]
|
|
744
|
+
**show_plan_only_when_ambiguous** | **BOOLEAN**| Whether to state which plan the Invoice lines came from, regardless of whether there's only one plan involved in this Invoice. | [optional] [default to true]
|
|
745
|
+
|
|
746
|
+
### Return type
|
|
747
|
+
|
|
748
|
+
**String**
|
|
749
|
+
|
|
750
|
+
### Authorization
|
|
751
|
+
|
|
752
|
+
No authorization required
|
|
753
|
+
|
|
754
|
+
### HTTP request headers
|
|
755
|
+
|
|
756
|
+
- **Content-Type**: text/plain, application/json
|
|
757
|
+
- **Accept**: text/html
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
# **get_invoice_as_pdf**
|
|
762
|
+
> File get_invoice_as_pdf(id, opts)
|
|
763
|
+
|
|
764
|
+
Retrieves a single invoice specified by the ID parameter.
|
|
765
|
+
|
|
766
|
+
{ \"nickname\" : \"PDF Invoice\",\"response\" : \"getInvoiceByID.pdf\"}
|
|
767
|
+
|
|
768
|
+
### Example
|
|
769
|
+
```ruby
|
|
770
|
+
# load the gem
|
|
771
|
+
require 'bf_ruby2'
|
|
772
|
+
|
|
773
|
+
api_instance = BillForward::InvoicesApi.new
|
|
774
|
+
|
|
775
|
+
id = "id_example" # String | The ID of the invoice.
|
|
776
|
+
|
|
777
|
+
opts = {
|
|
778
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
779
|
+
offset: 0, # Integer | The offset from the first invoice to return.
|
|
780
|
+
records: 10, # Integer | The maximum number of invoices to return.
|
|
781
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
782
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
783
|
+
include_retired: false, # BOOLEAN | Whether retired products should be returned.
|
|
784
|
+
tier_breakdown: false, # BOOLEAN | Whether to provide a breakdown of charge tiering.
|
|
785
|
+
inclusive_end: false, # BOOLEAN | Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the \"period end\" date shown to the customer.
|
|
786
|
+
show_zero_cost: true, # BOOLEAN | Whether to show zero-cost lines.
|
|
787
|
+
show_plan_only_when_ambiguous: true, # BOOLEAN | Whether to state which plan the Invoice lines came from, regardless of whether there's only one plan involved in this Invoice.
|
|
788
|
+
include_footer: true, # BOOLEAN |
|
|
789
|
+
group_line_items_by: "group_line_items_by_example" # String |
|
|
790
|
+
}
|
|
791
|
+
|
|
792
|
+
begin
|
|
793
|
+
#Retrieves a single invoice specified by the ID parameter.
|
|
794
|
+
result = api_instance.get_invoice_as_pdf(id, opts)
|
|
795
|
+
p result
|
|
796
|
+
rescue BillForward::ApiError => e
|
|
797
|
+
puts "Exception when calling InvoicesApi->get_invoice_as_pdf: #{e}"
|
|
798
|
+
end
|
|
799
|
+
```
|
|
800
|
+
|
|
801
|
+
### Parameters
|
|
802
|
+
|
|
803
|
+
Name | Type | Description | Notes
|
|
804
|
+
------------- | ------------- | ------------- | -------------
|
|
805
|
+
**id** | **String**| The ID of the invoice. |
|
|
806
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
807
|
+
**offset** | **Integer**| The offset from the first invoice to return. | [optional] [default to 0]
|
|
808
|
+
**records** | **Integer**| The maximum number of invoices to return. | [optional] [default to 10]
|
|
809
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
810
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
811
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to false]
|
|
812
|
+
**tier_breakdown** | **BOOLEAN**| Whether to provide a breakdown of charge tiering. | [optional] [default to false]
|
|
813
|
+
**inclusive_end** | **BOOLEAN**| Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the \"period end\" date shown to the customer. | [optional] [default to false]
|
|
814
|
+
**show_zero_cost** | **BOOLEAN**| Whether to show zero-cost lines. | [optional] [default to true]
|
|
815
|
+
**show_plan_only_when_ambiguous** | **BOOLEAN**| Whether to state which plan the Invoice lines came from, regardless of whether there's only one plan involved in this Invoice. | [optional] [default to true]
|
|
816
|
+
**include_footer** | **BOOLEAN**| | [optional]
|
|
817
|
+
**group_line_items_by** | **String**| | [optional]
|
|
818
|
+
|
|
819
|
+
### Return type
|
|
820
|
+
|
|
821
|
+
**File**
|
|
822
|
+
|
|
823
|
+
### Authorization
|
|
824
|
+
|
|
825
|
+
No authorization required
|
|
826
|
+
|
|
827
|
+
### HTTP request headers
|
|
828
|
+
|
|
829
|
+
- **Content-Type**: text/plain, application/json
|
|
830
|
+
- **Accept**: application/pdf
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
# **get_invoice_by_id**
|
|
835
|
+
> InvoicePagedMetadata get_invoice_by_id(invoice_id, opts)
|
|
836
|
+
|
|
837
|
+
Retrieves a single invoice specified by the invoice-ID parameter.
|
|
838
|
+
|
|
839
|
+
{ \"nickname\" : \"Retrieve an existing invoice\",\"response\" : \"getInvoiceByID.html\"}
|
|
840
|
+
|
|
841
|
+
### Example
|
|
842
|
+
```ruby
|
|
843
|
+
# load the gem
|
|
844
|
+
require 'bf_ruby2'
|
|
845
|
+
|
|
846
|
+
api_instance = BillForward::InvoicesApi.new
|
|
847
|
+
|
|
848
|
+
invoice_id = "invoice_id_example" # String | The ID of the invoice.
|
|
849
|
+
|
|
850
|
+
opts = {
|
|
851
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
852
|
+
offset: 0, # Integer | The offset from the first invoice to return.
|
|
853
|
+
records: 10, # Integer | The maximum number of invoices to return.
|
|
854
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
855
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
856
|
+
include_retired: false, # BOOLEAN | Whether retired products should be returned.
|
|
857
|
+
exclude_children: true # BOOLEAN | Should child invoices be excluded.
|
|
858
|
+
}
|
|
859
|
+
|
|
860
|
+
begin
|
|
861
|
+
#Retrieves a single invoice specified by the invoice-ID parameter.
|
|
862
|
+
result = api_instance.get_invoice_by_id(invoice_id, opts)
|
|
863
|
+
p result
|
|
864
|
+
rescue BillForward::ApiError => e
|
|
865
|
+
puts "Exception when calling InvoicesApi->get_invoice_by_id: #{e}"
|
|
866
|
+
end
|
|
867
|
+
```
|
|
868
|
+
|
|
869
|
+
### Parameters
|
|
870
|
+
|
|
871
|
+
Name | Type | Description | Notes
|
|
872
|
+
------------- | ------------- | ------------- | -------------
|
|
873
|
+
**invoice_id** | **String**| The ID of the invoice. |
|
|
874
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
875
|
+
**offset** | **Integer**| The offset from the first invoice to return. | [optional] [default to 0]
|
|
876
|
+
**records** | **Integer**| The maximum number of invoices to return. | [optional] [default to 10]
|
|
877
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
878
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
879
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to false]
|
|
880
|
+
**exclude_children** | **BOOLEAN**| Should child invoices be excluded. | [optional] [default to true]
|
|
881
|
+
|
|
882
|
+
### Return type
|
|
883
|
+
|
|
884
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
885
|
+
|
|
886
|
+
### Authorization
|
|
887
|
+
|
|
888
|
+
No authorization required
|
|
889
|
+
|
|
890
|
+
### HTTP request headers
|
|
891
|
+
|
|
892
|
+
- **Content-Type**: text/plain, application/json
|
|
893
|
+
- **Accept**: application/json
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
# **get_invoice_by_id_as_csv**
|
|
898
|
+
> String get_invoice_by_id_as_csv(id, opts)
|
|
899
|
+
|
|
900
|
+
Retrieves a single invoice specified by the ID parameter.
|
|
901
|
+
|
|
902
|
+
{ \"nickname\" : \"CSV invoice\",\"response\" : \"getInvoiceByID.csv\"}
|
|
903
|
+
|
|
904
|
+
### Example
|
|
905
|
+
```ruby
|
|
906
|
+
# load the gem
|
|
907
|
+
require 'bf_ruby2'
|
|
908
|
+
|
|
909
|
+
api_instance = BillForward::InvoicesApi.new
|
|
910
|
+
|
|
911
|
+
id = "id_example" # String | The ID of the invoice.
|
|
912
|
+
|
|
913
|
+
opts = {
|
|
914
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
915
|
+
}
|
|
916
|
+
|
|
917
|
+
begin
|
|
918
|
+
#Retrieves a single invoice specified by the ID parameter.
|
|
919
|
+
result = api_instance.get_invoice_by_id_as_csv(id, opts)
|
|
920
|
+
p result
|
|
921
|
+
rescue BillForward::ApiError => e
|
|
922
|
+
puts "Exception when calling InvoicesApi->get_invoice_by_id_as_csv: #{e}"
|
|
923
|
+
end
|
|
924
|
+
```
|
|
925
|
+
|
|
926
|
+
### Parameters
|
|
927
|
+
|
|
928
|
+
Name | Type | Description | Notes
|
|
929
|
+
------------- | ------------- | ------------- | -------------
|
|
930
|
+
**id** | **String**| The ID of the invoice. |
|
|
931
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
932
|
+
|
|
933
|
+
### Return type
|
|
934
|
+
|
|
935
|
+
**String**
|
|
936
|
+
|
|
937
|
+
### Authorization
|
|
938
|
+
|
|
939
|
+
No authorization required
|
|
940
|
+
|
|
941
|
+
### HTTP request headers
|
|
942
|
+
|
|
943
|
+
- **Content-Type**: text/plain, application/json
|
|
944
|
+
- **Accept**: text/csv
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
# **get_invoice_by_subscription_id**
|
|
949
|
+
> InvoicePagedMetadata get_invoice_by_subscription_id(subscription_id, opts)
|
|
950
|
+
|
|
951
|
+
Retrieves a collection of invoices specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
952
|
+
|
|
953
|
+
{ \"nickname\" : \"Retrieve by subscription\",\"response\" : \"getInvoiceBySubscriptionID.html\"}
|
|
954
|
+
|
|
955
|
+
### Example
|
|
956
|
+
```ruby
|
|
957
|
+
# load the gem
|
|
958
|
+
require 'bf_ruby2'
|
|
959
|
+
|
|
960
|
+
api_instance = BillForward::InvoicesApi.new
|
|
961
|
+
|
|
962
|
+
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
|
963
|
+
|
|
964
|
+
opts = {
|
|
965
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
966
|
+
offset: 0, # Integer | The offset from the first invoice to return.
|
|
967
|
+
records: 10, # Integer | The maximum number of invoices to return.
|
|
968
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
969
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
970
|
+
include_retired: false, # BOOLEAN | Whether retired products should be returned.
|
|
971
|
+
exclude_children: true # BOOLEAN | Should child invoices be excluded.
|
|
972
|
+
}
|
|
973
|
+
|
|
974
|
+
begin
|
|
975
|
+
#Retrieves a collection of invoices specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
976
|
+
result = api_instance.get_invoice_by_subscription_id(subscription_id, opts)
|
|
977
|
+
p result
|
|
978
|
+
rescue BillForward::ApiError => e
|
|
979
|
+
puts "Exception when calling InvoicesApi->get_invoice_by_subscription_id: #{e}"
|
|
980
|
+
end
|
|
981
|
+
```
|
|
982
|
+
|
|
983
|
+
### Parameters
|
|
984
|
+
|
|
985
|
+
Name | Type | Description | Notes
|
|
986
|
+
------------- | ------------- | ------------- | -------------
|
|
987
|
+
**subscription_id** | **String**| ID of the subscription. |
|
|
988
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
989
|
+
**offset** | **Integer**| The offset from the first invoice to return. | [optional] [default to 0]
|
|
990
|
+
**records** | **Integer**| The maximum number of invoices to return. | [optional] [default to 10]
|
|
991
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
992
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
993
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to false]
|
|
994
|
+
**exclude_children** | **BOOLEAN**| Should child invoices be excluded. | [optional] [default to true]
|
|
995
|
+
|
|
996
|
+
### Return type
|
|
997
|
+
|
|
998
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
999
|
+
|
|
1000
|
+
### Authorization
|
|
1001
|
+
|
|
1002
|
+
No authorization required
|
|
1003
|
+
|
|
1004
|
+
### HTTP request headers
|
|
1005
|
+
|
|
1006
|
+
- **Content-Type**: text/plain, application/json
|
|
1007
|
+
- **Accept**: application/json
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
# **get_invoice_by_subscription_version_id**
|
|
1012
|
+
> InvoicePagedMetadata get_invoice_by_subscription_version_id(subscription_version_id, opts)
|
|
1013
|
+
|
|
1014
|
+
Retrieves a collection of invoices specified by the subscription-version-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
1015
|
+
|
|
1016
|
+
{ \"nickname\" : \"Retrieve by subscription version\",\"response\" : \"getInvoiceBySubscriptionVersionID.html\"}
|
|
1017
|
+
|
|
1018
|
+
### Example
|
|
1019
|
+
```ruby
|
|
1020
|
+
# load the gem
|
|
1021
|
+
require 'bf_ruby2'
|
|
1022
|
+
|
|
1023
|
+
api_instance = BillForward::InvoicesApi.new
|
|
1024
|
+
|
|
1025
|
+
subscription_version_id = "subscription_version_id_example" # String | Version ID of the subscription.
|
|
1026
|
+
|
|
1027
|
+
opts = {
|
|
1028
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1029
|
+
offset: 0, # Integer | The offset from the first invoice to return.
|
|
1030
|
+
records: 10, # Integer | The maximum number of invoices to return.
|
|
1031
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
1032
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1033
|
+
include_retired: false, # BOOLEAN | Whether retired products should be returned.
|
|
1034
|
+
exclude_children: true # BOOLEAN | Should child invoices be excluded.
|
|
1035
|
+
}
|
|
1036
|
+
|
|
1037
|
+
begin
|
|
1038
|
+
#Retrieves a collection of invoices specified by the subscription-version-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
1039
|
+
result = api_instance.get_invoice_by_subscription_version_id(subscription_version_id, opts)
|
|
1040
|
+
p result
|
|
1041
|
+
rescue BillForward::ApiError => e
|
|
1042
|
+
puts "Exception when calling InvoicesApi->get_invoice_by_subscription_version_id: #{e}"
|
|
1043
|
+
end
|
|
1044
|
+
```
|
|
1045
|
+
|
|
1046
|
+
### Parameters
|
|
1047
|
+
|
|
1048
|
+
Name | Type | Description | Notes
|
|
1049
|
+
------------- | ------------- | ------------- | -------------
|
|
1050
|
+
**subscription_version_id** | **String**| Version ID of the subscription. |
|
|
1051
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1052
|
+
**offset** | **Integer**| The offset from the first invoice to return. | [optional] [default to 0]
|
|
1053
|
+
**records** | **Integer**| The maximum number of invoices to return. | [optional] [default to 10]
|
|
1054
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
1055
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1056
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to false]
|
|
1057
|
+
**exclude_children** | **BOOLEAN**| Should child invoices be excluded. | [optional] [default to true]
|
|
1058
|
+
|
|
1059
|
+
### Return type
|
|
1060
|
+
|
|
1061
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
1062
|
+
|
|
1063
|
+
### Authorization
|
|
1064
|
+
|
|
1065
|
+
No authorization required
|
|
1066
|
+
|
|
1067
|
+
### HTTP request headers
|
|
1068
|
+
|
|
1069
|
+
- **Content-Type**: text/plain, application/json
|
|
1070
|
+
- **Accept**: application/json
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
# **get_invoice_by_version_id**
|
|
1075
|
+
> InvoicePagedMetadata get_invoice_by_version_id(version_id, opts)
|
|
1076
|
+
|
|
1077
|
+
Retrieves a single invoice, specified by the version-ID parameter.
|
|
1078
|
+
|
|
1079
|
+
{ \"nickname\" : \"Retrieve by version\",\"response\" : \"getInvoiceByVersionID.html\"}
|
|
1080
|
+
|
|
1081
|
+
### Example
|
|
1082
|
+
```ruby
|
|
1083
|
+
# load the gem
|
|
1084
|
+
require 'bf_ruby2'
|
|
1085
|
+
|
|
1086
|
+
api_instance = BillForward::InvoicesApi.new
|
|
1087
|
+
|
|
1088
|
+
version_id = "version_id_example" # String | The version-ID of the invoice.
|
|
1089
|
+
|
|
1090
|
+
opts = {
|
|
1091
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1092
|
+
}
|
|
1093
|
+
|
|
1094
|
+
begin
|
|
1095
|
+
#Retrieves a single invoice, specified by the version-ID parameter.
|
|
1096
|
+
result = api_instance.get_invoice_by_version_id(version_id, opts)
|
|
1097
|
+
p result
|
|
1098
|
+
rescue BillForward::ApiError => e
|
|
1099
|
+
puts "Exception when calling InvoicesApi->get_invoice_by_version_id: #{e}"
|
|
1100
|
+
end
|
|
1101
|
+
```
|
|
1102
|
+
|
|
1103
|
+
### Parameters
|
|
1104
|
+
|
|
1105
|
+
Name | Type | Description | Notes
|
|
1106
|
+
------------- | ------------- | ------------- | -------------
|
|
1107
|
+
**version_id** | **String**| The version-ID of the invoice. |
|
|
1108
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1109
|
+
|
|
1110
|
+
### Return type
|
|
1111
|
+
|
|
1112
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
1113
|
+
|
|
1114
|
+
### Authorization
|
|
1115
|
+
|
|
1116
|
+
No authorization required
|
|
1117
|
+
|
|
1118
|
+
### HTTP request headers
|
|
1119
|
+
|
|
1120
|
+
- **Content-Type**: text/plain, application/json
|
|
1121
|
+
- **Accept**: application/json, text/xml
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
# **get_invoices_by_account_id**
|
|
1126
|
+
> InvoicePagedMetadata get_invoices_by_account_id(account_id, opts)
|
|
1127
|
+
|
|
1128
|
+
Retrieves a collection of invoices specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
1129
|
+
|
|
1130
|
+
{ \"nickname\" : \"Retrieve by account\",\"response\" : \"getInvoiceByAccountID.html\"}
|
|
1131
|
+
|
|
1132
|
+
### Example
|
|
1133
|
+
```ruby
|
|
1134
|
+
# load the gem
|
|
1135
|
+
require 'bf_ruby2'
|
|
1136
|
+
|
|
1137
|
+
api_instance = BillForward::InvoicesApi.new
|
|
1138
|
+
|
|
1139
|
+
account_id = "account_id_example" # String | ID of the account.
|
|
1140
|
+
|
|
1141
|
+
opts = {
|
|
1142
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1143
|
+
offset: 0, # Integer | The offset from the first invoice to return.
|
|
1144
|
+
records: 10, # Integer | The maximum number of invoices to return.
|
|
1145
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
1146
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1147
|
+
include_retired: false, # BOOLEAN | Whether retired products should be returned.
|
|
1148
|
+
exclude_children: true # BOOLEAN | Should child invoices be excluded.
|
|
1149
|
+
}
|
|
1150
|
+
|
|
1151
|
+
begin
|
|
1152
|
+
#Retrieves a collection of invoices specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
1153
|
+
result = api_instance.get_invoices_by_account_id(account_id, opts)
|
|
1154
|
+
p result
|
|
1155
|
+
rescue BillForward::ApiError => e
|
|
1156
|
+
puts "Exception when calling InvoicesApi->get_invoices_by_account_id: #{e}"
|
|
1157
|
+
end
|
|
1158
|
+
```
|
|
1159
|
+
|
|
1160
|
+
### Parameters
|
|
1161
|
+
|
|
1162
|
+
Name | Type | Description | Notes
|
|
1163
|
+
------------- | ------------- | ------------- | -------------
|
|
1164
|
+
**account_id** | **String**| ID of the account. |
|
|
1165
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1166
|
+
**offset** | **Integer**| The offset from the first invoice to return. | [optional] [default to 0]
|
|
1167
|
+
**records** | **Integer**| The maximum number of invoices to return. | [optional] [default to 10]
|
|
1168
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
1169
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1170
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to false]
|
|
1171
|
+
**exclude_children** | **BOOLEAN**| Should child invoices be excluded. | [optional] [default to true]
|
|
1172
|
+
|
|
1173
|
+
### Return type
|
|
1174
|
+
|
|
1175
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
1176
|
+
|
|
1177
|
+
### Authorization
|
|
1178
|
+
|
|
1179
|
+
No authorization required
|
|
1180
|
+
|
|
1181
|
+
### HTTP request headers
|
|
1182
|
+
|
|
1183
|
+
- **Content-Type**: text/plain, application/json
|
|
1184
|
+
- **Accept**: application/json
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
# **get_invoices_by_period_end**
|
|
1189
|
+
> InvoicePagedMetadata get_invoices_by_period_end(lower_threshold, upper_threshold, opts)
|
|
1190
|
+
|
|
1191
|
+
Retrieves a collection of invoice objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
1192
|
+
|
|
1193
|
+
{ \"nickname\" : \"Retrieve by period-end\",\"response\" : \"getInvoiceByPeriodEnd.html\"}
|
|
1194
|
+
|
|
1195
|
+
### Example
|
|
1196
|
+
```ruby
|
|
1197
|
+
# load the gem
|
|
1198
|
+
require 'bf_ruby2'
|
|
1199
|
+
|
|
1200
|
+
api_instance = BillForward::InvoicesApi.new
|
|
1201
|
+
|
|
1202
|
+
lower_threshold = "lower_threshold_example" # String | The UTC DateTime specifying the start of the result period.
|
|
1203
|
+
|
|
1204
|
+
upper_threshold = "upper_threshold_example" # String | The UTC DateTime specifying the end of the result period.
|
|
1205
|
+
|
|
1206
|
+
opts = {
|
|
1207
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1208
|
+
offset: 0, # Integer | The offset from the first taxation-link to return.
|
|
1209
|
+
records: 10, # Integer | The maximum number of taxation-links to return.
|
|
1210
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
1211
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1212
|
+
include_retired: false # BOOLEAN | Whether retired products should be returned.
|
|
1213
|
+
}
|
|
1214
|
+
|
|
1215
|
+
begin
|
|
1216
|
+
#Retrieves a collection of invoice objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
1217
|
+
result = api_instance.get_invoices_by_period_end(lower_threshold, upper_threshold, opts)
|
|
1218
|
+
p result
|
|
1219
|
+
rescue BillForward::ApiError => e
|
|
1220
|
+
puts "Exception when calling InvoicesApi->get_invoices_by_period_end: #{e}"
|
|
1221
|
+
end
|
|
1222
|
+
```
|
|
1223
|
+
|
|
1224
|
+
### Parameters
|
|
1225
|
+
|
|
1226
|
+
Name | Type | Description | Notes
|
|
1227
|
+
------------- | ------------- | ------------- | -------------
|
|
1228
|
+
**lower_threshold** | **String**| The UTC DateTime specifying the start of the result period. |
|
|
1229
|
+
**upper_threshold** | **String**| The UTC DateTime specifying the end of the result period. |
|
|
1230
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1231
|
+
**offset** | **Integer**| The offset from the first taxation-link to return. | [optional] [default to 0]
|
|
1232
|
+
**records** | **Integer**| The maximum number of taxation-links to return. | [optional] [default to 10]
|
|
1233
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
1234
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1235
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to false]
|
|
1236
|
+
|
|
1237
|
+
### Return type
|
|
1238
|
+
|
|
1239
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
1240
|
+
|
|
1241
|
+
### Authorization
|
|
1242
|
+
|
|
1243
|
+
No authorization required
|
|
1244
|
+
|
|
1245
|
+
### HTTP request headers
|
|
1246
|
+
|
|
1247
|
+
- **Content-Type**: text/plain, application/json
|
|
1248
|
+
- **Accept**: application/json
|
|
1249
|
+
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
# **get_invoices_by_period_start**
|
|
1253
|
+
> InvoicePagedMetadata get_invoices_by_period_start(lower_threshold, upper_threshold, opts)
|
|
1254
|
+
|
|
1255
|
+
Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
1256
|
+
|
|
1257
|
+
{ \"nickname\" : \"Retrieve by period-start\",\"response\" : \"getInvoiceByPeriodStart.html\"}
|
|
1258
|
+
|
|
1259
|
+
### Example
|
|
1260
|
+
```ruby
|
|
1261
|
+
# load the gem
|
|
1262
|
+
require 'bf_ruby2'
|
|
1263
|
+
|
|
1264
|
+
api_instance = BillForward::InvoicesApi.new
|
|
1265
|
+
|
|
1266
|
+
lower_threshold = "lower_threshold_example" # String | The UTC DateTime specifying the start of the result period.
|
|
1267
|
+
|
|
1268
|
+
upper_threshold = "upper_threshold_example" # String | The UTC DateTime specifying the end of the result period.
|
|
1269
|
+
|
|
1270
|
+
opts = {
|
|
1271
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1272
|
+
offset: 0, # Integer | The offset from the first taxation-link to return.
|
|
1273
|
+
records: 10, # Integer | The maximum number of taxation-links to return.
|
|
1274
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
1275
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1276
|
+
include_retired: false # BOOLEAN | Whether retired products should be returned.
|
|
1277
|
+
}
|
|
1278
|
+
|
|
1279
|
+
begin
|
|
1280
|
+
#Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
1281
|
+
result = api_instance.get_invoices_by_period_start(lower_threshold, upper_threshold, opts)
|
|
1282
|
+
p result
|
|
1283
|
+
rescue BillForward::ApiError => e
|
|
1284
|
+
puts "Exception when calling InvoicesApi->get_invoices_by_period_start: #{e}"
|
|
1285
|
+
end
|
|
1286
|
+
```
|
|
1287
|
+
|
|
1288
|
+
### Parameters
|
|
1289
|
+
|
|
1290
|
+
Name | Type | Description | Notes
|
|
1291
|
+
------------- | ------------- | ------------- | -------------
|
|
1292
|
+
**lower_threshold** | **String**| The UTC DateTime specifying the start of the result period. |
|
|
1293
|
+
**upper_threshold** | **String**| The UTC DateTime specifying the end of the result period. |
|
|
1294
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1295
|
+
**offset** | **Integer**| The offset from the first taxation-link to return. | [optional] [default to 0]
|
|
1296
|
+
**records** | **Integer**| The maximum number of taxation-links to return. | [optional] [default to 10]
|
|
1297
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
1298
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1299
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to false]
|
|
1300
|
+
|
|
1301
|
+
### Return type
|
|
1302
|
+
|
|
1303
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
1304
|
+
|
|
1305
|
+
### Authorization
|
|
1306
|
+
|
|
1307
|
+
No authorization required
|
|
1308
|
+
|
|
1309
|
+
### HTTP request headers
|
|
1310
|
+
|
|
1311
|
+
- **Content-Type**: text/plain, application/json
|
|
1312
|
+
- **Accept**: application/json
|
|
1313
|
+
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
# **get_invoices_by_period_start_as_csv**
|
|
1317
|
+
> InvoicePagedMetadata get_invoices_by_period_start_as_csv(lower_threshold, upper_threshold, opts)
|
|
1318
|
+
|
|
1319
|
+
Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
1320
|
+
|
|
1321
|
+
{ \"nickname\" : \"Retrieve by period-start\",\"response\" : \"getInvoiceByPeriodStart.csv\"}
|
|
1322
|
+
|
|
1323
|
+
### Example
|
|
1324
|
+
```ruby
|
|
1325
|
+
# load the gem
|
|
1326
|
+
require 'bf_ruby2'
|
|
1327
|
+
|
|
1328
|
+
api_instance = BillForward::InvoicesApi.new
|
|
1329
|
+
|
|
1330
|
+
lower_threshold = "lower_threshold_example" # String | The UTC DateTime specifying the start of the result period.
|
|
1331
|
+
|
|
1332
|
+
upper_threshold = "upper_threshold_example" # String | The UTC DateTime specifying the end of the result period.
|
|
1333
|
+
|
|
1334
|
+
opts = {
|
|
1335
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1336
|
+
offset: 0, # Integer | The offset from the first taxation-link to return.
|
|
1337
|
+
records: 10, # Integer | The maximum number of taxation-links to return.
|
|
1338
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
1339
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1340
|
+
include_retired: false # BOOLEAN | Whether retired products should be returned.
|
|
1341
|
+
}
|
|
1342
|
+
|
|
1343
|
+
begin
|
|
1344
|
+
#Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
1345
|
+
result = api_instance.get_invoices_by_period_start_as_csv(lower_threshold, upper_threshold, opts)
|
|
1346
|
+
p result
|
|
1347
|
+
rescue BillForward::ApiError => e
|
|
1348
|
+
puts "Exception when calling InvoicesApi->get_invoices_by_period_start_as_csv: #{e}"
|
|
1349
|
+
end
|
|
1350
|
+
```
|
|
1351
|
+
|
|
1352
|
+
### Parameters
|
|
1353
|
+
|
|
1354
|
+
Name | Type | Description | Notes
|
|
1355
|
+
------------- | ------------- | ------------- | -------------
|
|
1356
|
+
**lower_threshold** | **String**| The UTC DateTime specifying the start of the result period. |
|
|
1357
|
+
**upper_threshold** | **String**| The UTC DateTime specifying the end of the result period. |
|
|
1358
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1359
|
+
**offset** | **Integer**| The offset from the first taxation-link to return. | [optional] [default to 0]
|
|
1360
|
+
**records** | **Integer**| The maximum number of taxation-links to return. | [optional] [default to 10]
|
|
1361
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
1362
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1363
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to false]
|
|
1364
|
+
|
|
1365
|
+
### Return type
|
|
1366
|
+
|
|
1367
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
1368
|
+
|
|
1369
|
+
### Authorization
|
|
1370
|
+
|
|
1371
|
+
No authorization required
|
|
1372
|
+
|
|
1373
|
+
### HTTP request headers
|
|
1374
|
+
|
|
1375
|
+
- **Content-Type**: text/plain, application/json
|
|
1376
|
+
- **Accept**: text/csv
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
|
|
1380
|
+
# **get_invoices_by_state**
|
|
1381
|
+
> InvoicePagedMetadata get_invoices_by_state(state, opts)
|
|
1382
|
+
|
|
1383
|
+
Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
|
|
1384
|
+
|
|
1385
|
+
{ \"nickname\" : \"Retrieve by state\",\"response\" : \"getInvoiceByState.html\"}
|
|
1386
|
+
|
|
1387
|
+
### Example
|
|
1388
|
+
```ruby
|
|
1389
|
+
# load the gem
|
|
1390
|
+
require 'bf_ruby2'
|
|
1391
|
+
|
|
1392
|
+
api_instance = BillForward::InvoicesApi.new
|
|
1393
|
+
|
|
1394
|
+
state = "state_example" # String | The current state of the invoice, either Paid, Pending, Unpaid or Voided.
|
|
1395
|
+
|
|
1396
|
+
opts = {
|
|
1397
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1398
|
+
offset: 0, # Integer | The offset from the first subscription to return.
|
|
1399
|
+
records: 10, # Integer | The maximum number of subscriptions to return.
|
|
1400
|
+
order_by: "ID", # String | Specify a field used to order the result set.
|
|
1401
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1402
|
+
include_retired: false # BOOLEAN | Whether retired products should be returned.
|
|
1403
|
+
}
|
|
1404
|
+
|
|
1405
|
+
begin
|
|
1406
|
+
#Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
|
|
1407
|
+
result = api_instance.get_invoices_by_state(state, opts)
|
|
1408
|
+
p result
|
|
1409
|
+
rescue BillForward::ApiError => e
|
|
1410
|
+
puts "Exception when calling InvoicesApi->get_invoices_by_state: #{e}"
|
|
1411
|
+
end
|
|
1412
|
+
```
|
|
1413
|
+
|
|
1414
|
+
### Parameters
|
|
1415
|
+
|
|
1416
|
+
Name | Type | Description | Notes
|
|
1417
|
+
------------- | ------------- | ------------- | -------------
|
|
1418
|
+
**state** | **String**| The current state of the invoice, either Paid, Pending, Unpaid or Voided. |
|
|
1419
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1420
|
+
**offset** | **Integer**| The offset from the first subscription to return. | [optional] [default to 0]
|
|
1421
|
+
**records** | **Integer**| The maximum number of subscriptions to return. | [optional] [default to 10]
|
|
1422
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to ID]
|
|
1423
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1424
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to false]
|
|
1425
|
+
|
|
1426
|
+
### Return type
|
|
1427
|
+
|
|
1428
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
1429
|
+
|
|
1430
|
+
### Authorization
|
|
1431
|
+
|
|
1432
|
+
No authorization required
|
|
1433
|
+
|
|
1434
|
+
### HTTP request headers
|
|
1435
|
+
|
|
1436
|
+
- **Content-Type**: text/plain, application/json
|
|
1437
|
+
- **Accept**: application/json
|
|
1438
|
+
|
|
1439
|
+
|
|
1440
|
+
|
|
1441
|
+
# **get_invoices_by_state_and_period_start**
|
|
1442
|
+
> InvoicePagedMetadata get_invoices_by_state_and_period_start(state, lower_threshold, upper_threshold, opts)
|
|
1443
|
+
|
|
1444
|
+
Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
1445
|
+
|
|
1446
|
+
{ \"nickname\" : \"Retrieve by state and period-start\",\"response\" : \"getInvoiceByStateAndPeriodStart.html\"}
|
|
1447
|
+
|
|
1448
|
+
### Example
|
|
1449
|
+
```ruby
|
|
1450
|
+
# load the gem
|
|
1451
|
+
require 'bf_ruby2'
|
|
1452
|
+
|
|
1453
|
+
api_instance = BillForward::InvoicesApi.new
|
|
1454
|
+
|
|
1455
|
+
state = "state_example" # String | The current state of the invoice, either Paid, Pending, Unpaid or Voided.
|
|
1456
|
+
|
|
1457
|
+
lower_threshold = "lower_threshold_example" # String | The UTC DateTime specifying the start of the result period.
|
|
1458
|
+
|
|
1459
|
+
upper_threshold = "upper_threshold_example" # String | The UTC DateTime specifying the end of the result period.
|
|
1460
|
+
|
|
1461
|
+
opts = {
|
|
1462
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1463
|
+
offset: 0, # Integer | The offset from the first taxation-link to return.
|
|
1464
|
+
records: 10, # Integer | The maximum number of taxation-links to return.
|
|
1465
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
1466
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1467
|
+
include_retired: false # BOOLEAN | Whether retired products should be returned.
|
|
1468
|
+
}
|
|
1469
|
+
|
|
1470
|
+
begin
|
|
1471
|
+
#Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
1472
|
+
result = api_instance.get_invoices_by_state_and_period_start(state, lower_threshold, upper_threshold, opts)
|
|
1473
|
+
p result
|
|
1474
|
+
rescue BillForward::ApiError => e
|
|
1475
|
+
puts "Exception when calling InvoicesApi->get_invoices_by_state_and_period_start: #{e}"
|
|
1476
|
+
end
|
|
1477
|
+
```
|
|
1478
|
+
|
|
1479
|
+
### Parameters
|
|
1480
|
+
|
|
1481
|
+
Name | Type | Description | Notes
|
|
1482
|
+
------------- | ------------- | ------------- | -------------
|
|
1483
|
+
**state** | **String**| The current state of the invoice, either Paid, Pending, Unpaid or Voided. |
|
|
1484
|
+
**lower_threshold** | **String**| The UTC DateTime specifying the start of the result period. |
|
|
1485
|
+
**upper_threshold** | **String**| The UTC DateTime specifying the end of the result period. |
|
|
1486
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1487
|
+
**offset** | **Integer**| The offset from the first taxation-link to return. | [optional] [default to 0]
|
|
1488
|
+
**records** | **Integer**| The maximum number of taxation-links to return. | [optional] [default to 10]
|
|
1489
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
1490
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1491
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to false]
|
|
1492
|
+
|
|
1493
|
+
### Return type
|
|
1494
|
+
|
|
1495
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
1496
|
+
|
|
1497
|
+
### Authorization
|
|
1498
|
+
|
|
1499
|
+
No authorization required
|
|
1500
|
+
|
|
1501
|
+
### HTTP request headers
|
|
1502
|
+
|
|
1503
|
+
- **Content-Type**: text/plain, application/json
|
|
1504
|
+
- **Accept**: application/json
|
|
1505
|
+
|
|
1506
|
+
|
|
1507
|
+
|
|
1508
|
+
# **get_invoices_by_state_and_period_start_as_csv**
|
|
1509
|
+
> InvoicePagedMetadata get_invoices_by_state_and_period_start_as_csv(state, lower_threshold, upper_threshold, opts)
|
|
1510
|
+
|
|
1511
|
+
Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
1512
|
+
|
|
1513
|
+
{ \"nickname\" : \"Retrieve by state and period-start\",\"response\" : \"getInvoiceByStateAndPeriodStart.csv\"}
|
|
1514
|
+
|
|
1515
|
+
### Example
|
|
1516
|
+
```ruby
|
|
1517
|
+
# load the gem
|
|
1518
|
+
require 'bf_ruby2'
|
|
1519
|
+
|
|
1520
|
+
api_instance = BillForward::InvoicesApi.new
|
|
1521
|
+
|
|
1522
|
+
state = "state_example" # String | The current state of the invoice, either Paid, Pending, Unpaid or Voided.
|
|
1523
|
+
|
|
1524
|
+
lower_threshold = "lower_threshold_example" # String | The UTC DateTime specifying the start of the result period.
|
|
1525
|
+
|
|
1526
|
+
upper_threshold = "upper_threshold_example" # String | The UTC DateTime specifying the end of the result period.
|
|
1527
|
+
|
|
1528
|
+
opts = {
|
|
1529
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1530
|
+
offset: 0, # Integer | The offset from the first taxation-link to return.
|
|
1531
|
+
records: 10, # Integer | The maximum number of taxation-links to return.
|
|
1532
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
1533
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1534
|
+
include_retired: false # BOOLEAN | Whether retired products should be returned.
|
|
1535
|
+
}
|
|
1536
|
+
|
|
1537
|
+
begin
|
|
1538
|
+
#Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
1539
|
+
result = api_instance.get_invoices_by_state_and_period_start_as_csv(state, lower_threshold, upper_threshold, opts)
|
|
1540
|
+
p result
|
|
1541
|
+
rescue BillForward::ApiError => e
|
|
1542
|
+
puts "Exception when calling InvoicesApi->get_invoices_by_state_and_period_start_as_csv: #{e}"
|
|
1543
|
+
end
|
|
1544
|
+
```
|
|
1545
|
+
|
|
1546
|
+
### Parameters
|
|
1547
|
+
|
|
1548
|
+
Name | Type | Description | Notes
|
|
1549
|
+
------------- | ------------- | ------------- | -------------
|
|
1550
|
+
**state** | **String**| The current state of the invoice, either Paid, Pending, Unpaid or Voided. |
|
|
1551
|
+
**lower_threshold** | **String**| The UTC DateTime specifying the start of the result period. |
|
|
1552
|
+
**upper_threshold** | **String**| The UTC DateTime specifying the end of the result period. |
|
|
1553
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1554
|
+
**offset** | **Integer**| The offset from the first taxation-link to return. | [optional] [default to 0]
|
|
1555
|
+
**records** | **Integer**| The maximum number of taxation-links to return. | [optional] [default to 10]
|
|
1556
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
1557
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1558
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to false]
|
|
1559
|
+
|
|
1560
|
+
### Return type
|
|
1561
|
+
|
|
1562
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
1563
|
+
|
|
1564
|
+
### Authorization
|
|
1565
|
+
|
|
1566
|
+
No authorization required
|
|
1567
|
+
|
|
1568
|
+
### HTTP request headers
|
|
1569
|
+
|
|
1570
|
+
- **Content-Type**: text/plain, application/json
|
|
1571
|
+
- **Accept**: text/csv
|
|
1572
|
+
|
|
1573
|
+
|
|
1574
|
+
|
|
1575
|
+
# **get_invoices_by_state_as_csv**
|
|
1576
|
+
> InvoicePagedMetadata get_invoices_by_state_as_csv(state, opts)
|
|
1577
|
+
|
|
1578
|
+
Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
|
|
1579
|
+
|
|
1580
|
+
{ \"nickname\" : \"Retrieve by state\",\"response\" : \"getInvoiceByState.csv\"}
|
|
1581
|
+
|
|
1582
|
+
### Example
|
|
1583
|
+
```ruby
|
|
1584
|
+
# load the gem
|
|
1585
|
+
require 'bf_ruby2'
|
|
1586
|
+
|
|
1587
|
+
api_instance = BillForward::InvoicesApi.new
|
|
1588
|
+
|
|
1589
|
+
state = "state_example" # String | The current state of the invoice, either Paid, Pending, Unpaid or Voided.
|
|
1590
|
+
|
|
1591
|
+
opts = {
|
|
1592
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1593
|
+
offset: 0, # Integer | The offset from the first subscription to return.
|
|
1594
|
+
records: 10, # Integer | The maximum number of subscriptions to return.
|
|
1595
|
+
order_by: "ID", # String | Specify a field used to order the result set.
|
|
1596
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
1597
|
+
include_retired: false # BOOLEAN | Whether retired products should be returned.
|
|
1598
|
+
}
|
|
1599
|
+
|
|
1600
|
+
begin
|
|
1601
|
+
#Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
|
|
1602
|
+
result = api_instance.get_invoices_by_state_as_csv(state, opts)
|
|
1603
|
+
p result
|
|
1604
|
+
rescue BillForward::ApiError => e
|
|
1605
|
+
puts "Exception when calling InvoicesApi->get_invoices_by_state_as_csv: #{e}"
|
|
1606
|
+
end
|
|
1607
|
+
```
|
|
1608
|
+
|
|
1609
|
+
### Parameters
|
|
1610
|
+
|
|
1611
|
+
Name | Type | Description | Notes
|
|
1612
|
+
------------- | ------------- | ------------- | -------------
|
|
1613
|
+
**state** | **String**| The current state of the invoice, either Paid, Pending, Unpaid or Voided. |
|
|
1614
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1615
|
+
**offset** | **Integer**| The offset from the first subscription to return. | [optional] [default to 0]
|
|
1616
|
+
**records** | **Integer**| The maximum number of subscriptions to return. | [optional] [default to 10]
|
|
1617
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to ID]
|
|
1618
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
1619
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to false]
|
|
1620
|
+
|
|
1621
|
+
### Return type
|
|
1622
|
+
|
|
1623
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
1624
|
+
|
|
1625
|
+
### Authorization
|
|
1626
|
+
|
|
1627
|
+
No authorization required
|
|
1628
|
+
|
|
1629
|
+
### HTTP request headers
|
|
1630
|
+
|
|
1631
|
+
- **Content-Type**: text/plain, application/json
|
|
1632
|
+
- **Accept**: text/csv
|
|
1633
|
+
|
|
1634
|
+
|
|
1635
|
+
|
|
1636
|
+
# **get_line_payments**
|
|
1637
|
+
> InvoiceLinePaymentPagedMetadata get_line_payments(opts)
|
|
1638
|
+
|
|
1639
|
+
Retrieves all InvoiceLine payment attributions.
|
|
1640
|
+
|
|
1641
|
+
{ \"nickname\" : \"Retrieve InvoiceLine payment attributions\",\"response\" : \"getInvoiceLinePayments.html\"}
|
|
1642
|
+
|
|
1643
|
+
### Example
|
|
1644
|
+
```ruby
|
|
1645
|
+
# load the gem
|
|
1646
|
+
require 'bf_ruby2'
|
|
1647
|
+
|
|
1648
|
+
api_instance = BillForward::InvoicesApi.new
|
|
1649
|
+
|
|
1650
|
+
opts = {
|
|
1651
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1652
|
+
recognition_start: "recognition_start_example", # String | The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24).
|
|
1653
|
+
recognition_end: "recognition_end_example", # String | The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24).
|
|
1654
|
+
include_gateway: ["include_gateway_example"], # Array<String> | Include attributions only from payments made via these payment gateways. Takes precedence over `exclude_gateway` param (if both are provided).
|
|
1655
|
+
exclude_gateway: ["exclude_gateway_example"] # Array<String> | Include attributions from payments made via all payment gateways, except these.
|
|
1656
|
+
}
|
|
1657
|
+
|
|
1658
|
+
begin
|
|
1659
|
+
#Retrieves all InvoiceLine payment attributions.
|
|
1660
|
+
result = api_instance.get_line_payments(opts)
|
|
1661
|
+
p result
|
|
1662
|
+
rescue BillForward::ApiError => e
|
|
1663
|
+
puts "Exception when calling InvoicesApi->get_line_payments: #{e}"
|
|
1664
|
+
end
|
|
1665
|
+
```
|
|
1666
|
+
|
|
1667
|
+
### Parameters
|
|
1668
|
+
|
|
1669
|
+
Name | Type | Description | Notes
|
|
1670
|
+
------------- | ------------- | ------------- | -------------
|
|
1671
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1672
|
+
**recognition_start** | **String**| The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24). | [optional]
|
|
1673
|
+
**recognition_end** | **String**| The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24). | [optional]
|
|
1674
|
+
**include_gateway** | [**Array<String>**](String.md)| Include attributions only from payments made via these payment gateways. Takes precedence over `exclude_gateway` param (if both are provided). | [optional]
|
|
1675
|
+
**exclude_gateway** | [**Array<String>**](String.md)| Include attributions from payments made via all payment gateways, except these. | [optional]
|
|
1676
|
+
|
|
1677
|
+
### Return type
|
|
1678
|
+
|
|
1679
|
+
[**InvoiceLinePaymentPagedMetadata**](InvoiceLinePaymentPagedMetadata.md)
|
|
1680
|
+
|
|
1681
|
+
### Authorization
|
|
1682
|
+
|
|
1683
|
+
No authorization required
|
|
1684
|
+
|
|
1685
|
+
### HTTP request headers
|
|
1686
|
+
|
|
1687
|
+
- **Content-Type**: Not defined
|
|
1688
|
+
- **Accept**: Not defined
|
|
1689
|
+
|
|
1690
|
+
|
|
1691
|
+
|
|
1692
|
+
# **get_line_payments_as_csv**
|
|
1693
|
+
> InvoiceLinePaymentPagedMetadata get_line_payments_as_csv(opts)
|
|
1694
|
+
|
|
1695
|
+
Retrieves (as CSV) all InvoiceLine payment attributions.
|
|
1696
|
+
|
|
1697
|
+
{ \"nickname\" : \"(CSV) Retrieve InvoiceLine payment attributions\",\"response\" : \"getInvoiceLinePayments.csv\"}
|
|
1698
|
+
|
|
1699
|
+
### Example
|
|
1700
|
+
```ruby
|
|
1701
|
+
# load the gem
|
|
1702
|
+
require 'bf_ruby2'
|
|
1703
|
+
|
|
1704
|
+
api_instance = BillForward::InvoicesApi.new
|
|
1705
|
+
|
|
1706
|
+
opts = {
|
|
1707
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1708
|
+
recognition_start: "recognition_start_example", # String | The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24).
|
|
1709
|
+
recognition_end: "recognition_end_example", # String | The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24).
|
|
1710
|
+
include_gateway: ["include_gateway_example"], # Array<String> | Include attributions only from payments made via these payment gateways. Takes precedence over `exclude_gateway` param (if both are provided).
|
|
1711
|
+
exclude_gateway: ["exclude_gateway_example"] # Array<String> | Include attributions from payments made via all payment gateways, except these.
|
|
1712
|
+
}
|
|
1713
|
+
|
|
1714
|
+
begin
|
|
1715
|
+
#Retrieves (as CSV) all InvoiceLine payment attributions.
|
|
1716
|
+
result = api_instance.get_line_payments_as_csv(opts)
|
|
1717
|
+
p result
|
|
1718
|
+
rescue BillForward::ApiError => e
|
|
1719
|
+
puts "Exception when calling InvoicesApi->get_line_payments_as_csv: #{e}"
|
|
1720
|
+
end
|
|
1721
|
+
```
|
|
1722
|
+
|
|
1723
|
+
### Parameters
|
|
1724
|
+
|
|
1725
|
+
Name | Type | Description | Notes
|
|
1726
|
+
------------- | ------------- | ------------- | -------------
|
|
1727
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1728
|
+
**recognition_start** | **String**| The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24). | [optional]
|
|
1729
|
+
**recognition_end** | **String**| The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24). | [optional]
|
|
1730
|
+
**include_gateway** | [**Array<String>**](String.md)| Include attributions only from payments made via these payment gateways. Takes precedence over `exclude_gateway` param (if both are provided). | [optional]
|
|
1731
|
+
**exclude_gateway** | [**Array<String>**](String.md)| Include attributions from payments made via all payment gateways, except these. | [optional]
|
|
1732
|
+
|
|
1733
|
+
### Return type
|
|
1734
|
+
|
|
1735
|
+
[**InvoiceLinePaymentPagedMetadata**](InvoiceLinePaymentPagedMetadata.md)
|
|
1736
|
+
|
|
1737
|
+
### Authorization
|
|
1738
|
+
|
|
1739
|
+
No authorization required
|
|
1740
|
+
|
|
1741
|
+
### HTTP request headers
|
|
1742
|
+
|
|
1743
|
+
- **Content-Type**: Not defined
|
|
1744
|
+
- **Accept**: Not defined
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
|
|
1748
|
+
# **get_metadata_for_invoice**
|
|
1749
|
+
> DynamicMetadata get_metadata_for_invoice(invoice_id, opts)
|
|
1750
|
+
|
|
1751
|
+
Retrieve any associated metadata.
|
|
1752
|
+
|
|
1753
|
+
{\"nickname\":\"Retrieve metadata on invoice\",\"request\":\"getInvoiceMetadataRequest.html\",\"response\":\"getInvoiceMetadataResponse.html\"}
|
|
1754
|
+
|
|
1755
|
+
### Example
|
|
1756
|
+
```ruby
|
|
1757
|
+
# load the gem
|
|
1758
|
+
require 'bf_ruby2'
|
|
1759
|
+
|
|
1760
|
+
api_instance = BillForward::InvoicesApi.new
|
|
1761
|
+
|
|
1762
|
+
invoice_id = "invoice_id_example" # String |
|
|
1763
|
+
|
|
1764
|
+
opts = {
|
|
1765
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1766
|
+
}
|
|
1767
|
+
|
|
1768
|
+
begin
|
|
1769
|
+
#Retrieve any associated metadata.
|
|
1770
|
+
result = api_instance.get_metadata_for_invoice(invoice_id, opts)
|
|
1771
|
+
p result
|
|
1772
|
+
rescue BillForward::ApiError => e
|
|
1773
|
+
puts "Exception when calling InvoicesApi->get_metadata_for_invoice: #{e}"
|
|
1774
|
+
end
|
|
1775
|
+
```
|
|
1776
|
+
|
|
1777
|
+
### Parameters
|
|
1778
|
+
|
|
1779
|
+
Name | Type | Description | Notes
|
|
1780
|
+
------------- | ------------- | ------------- | -------------
|
|
1781
|
+
**invoice_id** | **String**| |
|
|
1782
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1783
|
+
|
|
1784
|
+
### Return type
|
|
1785
|
+
|
|
1786
|
+
[**DynamicMetadata**](DynamicMetadata.md)
|
|
1787
|
+
|
|
1788
|
+
### Authorization
|
|
1789
|
+
|
|
1790
|
+
No authorization required
|
|
1791
|
+
|
|
1792
|
+
### HTTP request headers
|
|
1793
|
+
|
|
1794
|
+
- **Content-Type**: text/plain, application/json
|
|
1795
|
+
- **Accept**: application/json
|
|
1796
|
+
|
|
1797
|
+
|
|
1798
|
+
|
|
1799
|
+
# **get_refund_invoice_line_payments_from_invoices_as_csv**
|
|
1800
|
+
> InvoiceLinePaymentPagedMetadata get_refund_invoice_line_payments_from_invoices_as_csv(opts)
|
|
1801
|
+
|
|
1802
|
+
Retrieves awarded refunds from InvoicePayments upon line items, in CSV format.
|
|
1803
|
+
|
|
1804
|
+
{ \"nickname\" : \"Refund InvoiceLinePayments CSV\",\"response\" : \"Refund InvoiceLinePayments.csv\"}
|
|
1805
|
+
|
|
1806
|
+
### Example
|
|
1807
|
+
```ruby
|
|
1808
|
+
# load the gem
|
|
1809
|
+
require 'bf_ruby2'
|
|
1810
|
+
|
|
1811
|
+
api_instance = BillForward::InvoicesApi.new
|
|
1812
|
+
|
|
1813
|
+
opts = {
|
|
1814
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1815
|
+
recognition_start: "recognition_start_example", # String | The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24).
|
|
1816
|
+
recognition_end: "recognition_end_example" # String | The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24).
|
|
1817
|
+
}
|
|
1818
|
+
|
|
1819
|
+
begin
|
|
1820
|
+
#Retrieves awarded refunds from InvoicePayments upon line items, in CSV format.
|
|
1821
|
+
result = api_instance.get_refund_invoice_line_payments_from_invoices_as_csv(opts)
|
|
1822
|
+
p result
|
|
1823
|
+
rescue BillForward::ApiError => e
|
|
1824
|
+
puts "Exception when calling InvoicesApi->get_refund_invoice_line_payments_from_invoices_as_csv: #{e}"
|
|
1825
|
+
end
|
|
1826
|
+
```
|
|
1827
|
+
|
|
1828
|
+
### Parameters
|
|
1829
|
+
|
|
1830
|
+
Name | Type | Description | Notes
|
|
1831
|
+
------------- | ------------- | ------------- | -------------
|
|
1832
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1833
|
+
**recognition_start** | **String**| The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24). | [optional]
|
|
1834
|
+
**recognition_end** | **String**| The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24). | [optional]
|
|
1835
|
+
|
|
1836
|
+
### Return type
|
|
1837
|
+
|
|
1838
|
+
[**InvoiceLinePaymentPagedMetadata**](InvoiceLinePaymentPagedMetadata.md)
|
|
1839
|
+
|
|
1840
|
+
### Authorization
|
|
1841
|
+
|
|
1842
|
+
No authorization required
|
|
1843
|
+
|
|
1844
|
+
### HTTP request headers
|
|
1845
|
+
|
|
1846
|
+
- **Content-Type**: text/plain, application/json
|
|
1847
|
+
- **Accept**: text/csv
|
|
1848
|
+
|
|
1849
|
+
|
|
1850
|
+
|
|
1851
|
+
# **get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received**
|
|
1852
|
+
> InvoiceLinePaymentPagedMetadata get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received(opts)
|
|
1853
|
+
|
|
1854
|
+
Retrieves awarded refunds from InvoicePayments upon line items, in CSV format.
|
|
1855
|
+
|
|
1856
|
+
{ \"nickname\" : \"Refund InvoiceLinePayments CSV\",\"response\" : \"Refund InvoiceLinePayments.csv\"}
|
|
1857
|
+
|
|
1858
|
+
### Example
|
|
1859
|
+
```ruby
|
|
1860
|
+
# load the gem
|
|
1861
|
+
require 'bf_ruby2'
|
|
1862
|
+
|
|
1863
|
+
api_instance = BillForward::InvoicesApi.new
|
|
1864
|
+
|
|
1865
|
+
opts = {
|
|
1866
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1867
|
+
recognition_start: "recognition_start_example", # String | The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24).
|
|
1868
|
+
recognition_end: "recognition_end_example" # String | The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24).
|
|
1869
|
+
}
|
|
1870
|
+
|
|
1871
|
+
begin
|
|
1872
|
+
#Retrieves awarded refunds from InvoicePayments upon line items, in CSV format.
|
|
1873
|
+
result = api_instance.get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received(opts)
|
|
1874
|
+
p result
|
|
1875
|
+
rescue BillForward::ApiError => e
|
|
1876
|
+
puts "Exception when calling InvoicesApi->get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received: #{e}"
|
|
1877
|
+
end
|
|
1878
|
+
```
|
|
1879
|
+
|
|
1880
|
+
### Parameters
|
|
1881
|
+
|
|
1882
|
+
Name | Type | Description | Notes
|
|
1883
|
+
------------- | ------------- | ------------- | -------------
|
|
1884
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1885
|
+
**recognition_start** | **String**| The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24). | [optional]
|
|
1886
|
+
**recognition_end** | **String**| The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24). | [optional]
|
|
1887
|
+
|
|
1888
|
+
### Return type
|
|
1889
|
+
|
|
1890
|
+
[**InvoiceLinePaymentPagedMetadata**](InvoiceLinePaymentPagedMetadata.md)
|
|
1891
|
+
|
|
1892
|
+
### Authorization
|
|
1893
|
+
|
|
1894
|
+
No authorization required
|
|
1895
|
+
|
|
1896
|
+
### HTTP request headers
|
|
1897
|
+
|
|
1898
|
+
- **Content-Type**: text/plain, application/json
|
|
1899
|
+
- **Accept**: text/csv
|
|
1900
|
+
|
|
1901
|
+
|
|
1902
|
+
|
|
1903
|
+
# **get_revenue_attributions**
|
|
1904
|
+
> RevenueAttributionPagedMetadata get_revenue_attributions(opts)
|
|
1905
|
+
|
|
1906
|
+
Retrieves all attributions of Invoice costs to Invoice lines.
|
|
1907
|
+
|
|
1908
|
+
{ \"nickname\" : \"Retrieve revenue attributions\",\"response\" : \"getRevenueAttributions.html\"}
|
|
1909
|
+
|
|
1910
|
+
### Example
|
|
1911
|
+
```ruby
|
|
1912
|
+
# load the gem
|
|
1913
|
+
require 'bf_ruby2'
|
|
1914
|
+
|
|
1915
|
+
api_instance = BillForward::InvoicesApi.new
|
|
1916
|
+
|
|
1917
|
+
opts = {
|
|
1918
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1919
|
+
recognition_start: "recognition_start_example", # String | The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24).
|
|
1920
|
+
recognition_end: "recognition_end_example" # String | The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24).
|
|
1921
|
+
}
|
|
1922
|
+
|
|
1923
|
+
begin
|
|
1924
|
+
#Retrieves all attributions of Invoice costs to Invoice lines.
|
|
1925
|
+
result = api_instance.get_revenue_attributions(opts)
|
|
1926
|
+
p result
|
|
1927
|
+
rescue BillForward::ApiError => e
|
|
1928
|
+
puts "Exception when calling InvoicesApi->get_revenue_attributions: #{e}"
|
|
1929
|
+
end
|
|
1930
|
+
```
|
|
1931
|
+
|
|
1932
|
+
### Parameters
|
|
1933
|
+
|
|
1934
|
+
Name | Type | Description | Notes
|
|
1935
|
+
------------- | ------------- | ------------- | -------------
|
|
1936
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1937
|
+
**recognition_start** | **String**| The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24). | [optional]
|
|
1938
|
+
**recognition_end** | **String**| The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24). | [optional]
|
|
1939
|
+
|
|
1940
|
+
### Return type
|
|
1941
|
+
|
|
1942
|
+
[**RevenueAttributionPagedMetadata**](RevenueAttributionPagedMetadata.md)
|
|
1943
|
+
|
|
1944
|
+
### Authorization
|
|
1945
|
+
|
|
1946
|
+
No authorization required
|
|
1947
|
+
|
|
1948
|
+
### HTTP request headers
|
|
1949
|
+
|
|
1950
|
+
- **Content-Type**: Not defined
|
|
1951
|
+
- **Accept**: Not defined
|
|
1952
|
+
|
|
1953
|
+
|
|
1954
|
+
|
|
1955
|
+
# **get_revenue_attributions_as_csv**
|
|
1956
|
+
> String get_revenue_attributions_as_csv(opts)
|
|
1957
|
+
|
|
1958
|
+
Retrieves (as CSV) all attributions of Invoice costs to Invoice lines.
|
|
1959
|
+
|
|
1960
|
+
{ \"nickname\" : \"(CSV) Retrieve revenue attributions\",\"response\" : \"getRevenueAttributions.csv\"}
|
|
1961
|
+
|
|
1962
|
+
### Example
|
|
1963
|
+
```ruby
|
|
1964
|
+
# load the gem
|
|
1965
|
+
require 'bf_ruby2'
|
|
1966
|
+
|
|
1967
|
+
api_instance = BillForward::InvoicesApi.new
|
|
1968
|
+
|
|
1969
|
+
opts = {
|
|
1970
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
1971
|
+
recognition_start: "recognition_start_example", # String | The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24).
|
|
1972
|
+
recognition_end: "recognition_end_example" # String | The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24).
|
|
1973
|
+
}
|
|
1974
|
+
|
|
1975
|
+
begin
|
|
1976
|
+
#Retrieves (as CSV) all attributions of Invoice costs to Invoice lines.
|
|
1977
|
+
result = api_instance.get_revenue_attributions_as_csv(opts)
|
|
1978
|
+
p result
|
|
1979
|
+
rescue BillForward::ApiError => e
|
|
1980
|
+
puts "Exception when calling InvoicesApi->get_revenue_attributions_as_csv: #{e}"
|
|
1981
|
+
end
|
|
1982
|
+
```
|
|
1983
|
+
|
|
1984
|
+
### Parameters
|
|
1985
|
+
|
|
1986
|
+
Name | Type | Description | Notes
|
|
1987
|
+
------------- | ------------- | ------------- | -------------
|
|
1988
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1989
|
+
**recognition_start** | **String**| The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24). | [optional]
|
|
1990
|
+
**recognition_end** | **String**| The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24). | [optional]
|
|
1991
|
+
|
|
1992
|
+
### Return type
|
|
1993
|
+
|
|
1994
|
+
**String**
|
|
1995
|
+
|
|
1996
|
+
### Authorization
|
|
1997
|
+
|
|
1998
|
+
No authorization required
|
|
1999
|
+
|
|
2000
|
+
### HTTP request headers
|
|
2001
|
+
|
|
2002
|
+
- **Content-Type**: Not defined
|
|
2003
|
+
- **Accept**: Not defined
|
|
2004
|
+
|
|
2005
|
+
|
|
2006
|
+
|
|
2007
|
+
# **get_swagger_for_invoice**
|
|
2008
|
+
> SwaggerTypeListInv get_swagger_for_invoice(query_string, opts)
|
|
2009
|
+
|
|
2010
|
+
|
|
2011
|
+
|
|
2012
|
+
{ \"nickname\" : \"\",\"response\" : \"\"}
|
|
2013
|
+
|
|
2014
|
+
### Example
|
|
2015
|
+
```ruby
|
|
2016
|
+
# load the gem
|
|
2017
|
+
require 'bf_ruby2'
|
|
2018
|
+
|
|
2019
|
+
api_instance = BillForward::InvoicesApi.new
|
|
2020
|
+
|
|
2021
|
+
query_string = "query_string_example" # String | The query string used to search.
|
|
2022
|
+
|
|
2023
|
+
opts = {
|
|
2024
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
2025
|
+
offset: 0, # Integer | The starting index of the search results.
|
|
2026
|
+
records: 10, # Integer | The number of search results to return.
|
|
2027
|
+
format: "JSON", # String | The response format, either JSON or XML.
|
|
2028
|
+
wildcard: false, # BOOLEAN | Toggle if we search for full words or whether a wildcard is used.
|
|
2029
|
+
entity: false # BOOLEAN | Is an entity returned with the search results.
|
|
2030
|
+
}
|
|
2031
|
+
|
|
2032
|
+
begin
|
|
2033
|
+
#
|
|
2034
|
+
result = api_instance.get_swagger_for_invoice(query_string, opts)
|
|
2035
|
+
p result
|
|
2036
|
+
rescue BillForward::ApiError => e
|
|
2037
|
+
puts "Exception when calling InvoicesApi->get_swagger_for_invoice: #{e}"
|
|
2038
|
+
end
|
|
2039
|
+
```
|
|
2040
|
+
|
|
2041
|
+
### Parameters
|
|
2042
|
+
|
|
2043
|
+
Name | Type | Description | Notes
|
|
2044
|
+
------------- | ------------- | ------------- | -------------
|
|
2045
|
+
**query_string** | **String**| The query string used to search. |
|
|
2046
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
2047
|
+
**offset** | **Integer**| The starting index of the search results. | [optional] [default to 0]
|
|
2048
|
+
**records** | **Integer**| The number of search results to return. | [optional] [default to 10]
|
|
2049
|
+
**format** | **String**| The response format, either JSON or XML. | [optional] [default to JSON]
|
|
2050
|
+
**wildcard** | **BOOLEAN**| Toggle if we search for full words or whether a wildcard is used. | [optional] [default to false]
|
|
2051
|
+
**entity** | **BOOLEAN**| Is an entity returned with the search results. | [optional] [default to false]
|
|
2052
|
+
|
|
2053
|
+
### Return type
|
|
2054
|
+
|
|
2055
|
+
[**SwaggerTypeListInv**](SwaggerTypeListInv.md)
|
|
2056
|
+
|
|
2057
|
+
### Authorization
|
|
2058
|
+
|
|
2059
|
+
No authorization required
|
|
2060
|
+
|
|
2061
|
+
### HTTP request headers
|
|
2062
|
+
|
|
2063
|
+
- **Content-Type**: text/plain, application/json
|
|
2064
|
+
- **Accept**: application/json
|
|
2065
|
+
|
|
2066
|
+
|
|
2067
|
+
|
|
2068
|
+
# **import_invoice**
|
|
2069
|
+
> InvoicePagedMetadata import_invoice(request)
|
|
2070
|
+
|
|
2071
|
+
Import an invoice.
|
|
2072
|
+
|
|
2073
|
+
{\"nickname\":\"Import invoice\",\"response\":\"ImportInvoiceResponse.html\",\"request\":\"ImportInvoiceRequest.html\"}
|
|
2074
|
+
|
|
2075
|
+
### Example
|
|
2076
|
+
```ruby
|
|
2077
|
+
# load the gem
|
|
2078
|
+
require 'bf_ruby2'
|
|
2079
|
+
|
|
2080
|
+
api_instance = BillForward::InvoicesApi.new
|
|
2081
|
+
|
|
2082
|
+
request = BillForward::BillingEntityBase.new # BillingEntityBase |
|
|
2083
|
+
|
|
2084
|
+
|
|
2085
|
+
begin
|
|
2086
|
+
#Import an invoice.
|
|
2087
|
+
result = api_instance.import_invoice(request)
|
|
2088
|
+
p result
|
|
2089
|
+
rescue BillForward::ApiError => e
|
|
2090
|
+
puts "Exception when calling InvoicesApi->import_invoice: #{e}"
|
|
2091
|
+
end
|
|
2092
|
+
```
|
|
2093
|
+
|
|
2094
|
+
### Parameters
|
|
2095
|
+
|
|
2096
|
+
Name | Type | Description | Notes
|
|
2097
|
+
------------- | ------------- | ------------- | -------------
|
|
2098
|
+
**request** | [**BillingEntityBase**](BillingEntityBase.md)| |
|
|
2099
|
+
|
|
2100
|
+
### Return type
|
|
2101
|
+
|
|
2102
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
2103
|
+
|
|
2104
|
+
### Authorization
|
|
2105
|
+
|
|
2106
|
+
No authorization required
|
|
2107
|
+
|
|
2108
|
+
### HTTP request headers
|
|
2109
|
+
|
|
2110
|
+
- **Content-Type**: application/json
|
|
2111
|
+
- **Accept**: application/json
|
|
2112
|
+
|
|
2113
|
+
|
|
2114
|
+
|
|
2115
|
+
# **recalculate_invoice**
|
|
2116
|
+
> InvoicePagedMetadata recalculate_invoice(invoice_id, request)
|
|
2117
|
+
|
|
2118
|
+
Re-calculate an Invoice.
|
|
2119
|
+
|
|
2120
|
+
{\"nickname\":\"Re-calculate an invoice\",\"response\":\"recalculateInvoiceResponse.html\",\"request\":\"RecalculateInvoiceRequest.html\"}
|
|
2121
|
+
|
|
2122
|
+
### Example
|
|
2123
|
+
```ruby
|
|
2124
|
+
# load the gem
|
|
2125
|
+
require 'bf_ruby2'
|
|
2126
|
+
|
|
2127
|
+
api_instance = BillForward::InvoicesApi.new
|
|
2128
|
+
|
|
2129
|
+
invoice_id = "invoice_id_example" # String |
|
|
2130
|
+
|
|
2131
|
+
request = BillForward::InvoiceRecalculationRequest.new # InvoiceRecalculationRequest |
|
|
2132
|
+
|
|
2133
|
+
|
|
2134
|
+
begin
|
|
2135
|
+
#Re-calculate an Invoice.
|
|
2136
|
+
result = api_instance.recalculate_invoice(invoice_id, request)
|
|
2137
|
+
p result
|
|
2138
|
+
rescue BillForward::ApiError => e
|
|
2139
|
+
puts "Exception when calling InvoicesApi->recalculate_invoice: #{e}"
|
|
2140
|
+
end
|
|
2141
|
+
```
|
|
2142
|
+
|
|
2143
|
+
### Parameters
|
|
2144
|
+
|
|
2145
|
+
Name | Type | Description | Notes
|
|
2146
|
+
------------- | ------------- | ------------- | -------------
|
|
2147
|
+
**invoice_id** | **String**| |
|
|
2148
|
+
**request** | [**InvoiceRecalculationRequest**](InvoiceRecalculationRequest.md)| |
|
|
2149
|
+
|
|
2150
|
+
### Return type
|
|
2151
|
+
|
|
2152
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
2153
|
+
|
|
2154
|
+
### Authorization
|
|
2155
|
+
|
|
2156
|
+
No authorization required
|
|
2157
|
+
|
|
2158
|
+
### HTTP request headers
|
|
2159
|
+
|
|
2160
|
+
- **Content-Type**: application/json
|
|
2161
|
+
- **Accept**: application/json
|
|
2162
|
+
|
|
2163
|
+
|
|
2164
|
+
|
|
2165
|
+
# **remove_charge_from_invoice**
|
|
2166
|
+
> SubscriptionChargePagedMetadata remove_charge_from_invoice(invoice_id, charge_id, opts)
|
|
2167
|
+
|
|
2168
|
+
Removes the specified charge from the specified Invoice.
|
|
2169
|
+
|
|
2170
|
+
{\"nickname\":\"Remove from invoice\",\"response\":\"deleteChargesInvoice.html\"}
|
|
2171
|
+
|
|
2172
|
+
### Example
|
|
2173
|
+
```ruby
|
|
2174
|
+
# load the gem
|
|
2175
|
+
require 'bf_ruby2'
|
|
2176
|
+
|
|
2177
|
+
api_instance = BillForward::InvoicesApi.new
|
|
2178
|
+
|
|
2179
|
+
invoice_id = "invoice_id_example" # String |
|
|
2180
|
+
|
|
2181
|
+
charge_id = "charge_id_example" # String |
|
|
2182
|
+
|
|
2183
|
+
opts = {
|
|
2184
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
2185
|
+
}
|
|
2186
|
+
|
|
2187
|
+
begin
|
|
2188
|
+
#Removes the specified charge from the specified Invoice.
|
|
2189
|
+
result = api_instance.remove_charge_from_invoice(invoice_id, charge_id, opts)
|
|
2190
|
+
p result
|
|
2191
|
+
rescue BillForward::ApiError => e
|
|
2192
|
+
puts "Exception when calling InvoicesApi->remove_charge_from_invoice: #{e}"
|
|
2193
|
+
end
|
|
2194
|
+
```
|
|
2195
|
+
|
|
2196
|
+
### Parameters
|
|
2197
|
+
|
|
2198
|
+
Name | Type | Description | Notes
|
|
2199
|
+
------------- | ------------- | ------------- | -------------
|
|
2200
|
+
**invoice_id** | **String**| |
|
|
2201
|
+
**charge_id** | **String**| |
|
|
2202
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
2203
|
+
|
|
2204
|
+
### Return type
|
|
2205
|
+
|
|
2206
|
+
[**SubscriptionChargePagedMetadata**](SubscriptionChargePagedMetadata.md)
|
|
2207
|
+
|
|
2208
|
+
### Authorization
|
|
2209
|
+
|
|
2210
|
+
No authorization required
|
|
2211
|
+
|
|
2212
|
+
### HTTP request headers
|
|
2213
|
+
|
|
2214
|
+
- **Content-Type**: text/plain, application/json
|
|
2215
|
+
- **Accept**: application/json
|
|
2216
|
+
|
|
2217
|
+
|
|
2218
|
+
|
|
2219
|
+
# **remove_metadata_from_invoice**
|
|
2220
|
+
> DynamicMetadata remove_metadata_from_invoice(invoice_id, opts)
|
|
2221
|
+
|
|
2222
|
+
Remove any associated metadata.
|
|
2223
|
+
|
|
2224
|
+
{\"nickname\":\"Clear metadata from invoice\",\"request\" :\"deleteInvoiceMetadataRequest.html\",\"response\":\"deleteInvoiceMetadataResponse.html\"}
|
|
2225
|
+
|
|
2226
|
+
### Example
|
|
2227
|
+
```ruby
|
|
2228
|
+
# load the gem
|
|
2229
|
+
require 'bf_ruby2'
|
|
2230
|
+
|
|
2231
|
+
api_instance = BillForward::InvoicesApi.new
|
|
2232
|
+
|
|
2233
|
+
invoice_id = "invoice_id_example" # String |
|
|
2234
|
+
|
|
2235
|
+
opts = {
|
|
2236
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
2237
|
+
}
|
|
2238
|
+
|
|
2239
|
+
begin
|
|
2240
|
+
#Remove any associated metadata.
|
|
2241
|
+
result = api_instance.remove_metadata_from_invoice(invoice_id, opts)
|
|
2242
|
+
p result
|
|
2243
|
+
rescue BillForward::ApiError => e
|
|
2244
|
+
puts "Exception when calling InvoicesApi->remove_metadata_from_invoice: #{e}"
|
|
2245
|
+
end
|
|
2246
|
+
```
|
|
2247
|
+
|
|
2248
|
+
### Parameters
|
|
2249
|
+
|
|
2250
|
+
Name | Type | Description | Notes
|
|
2251
|
+
------------- | ------------- | ------------- | -------------
|
|
2252
|
+
**invoice_id** | **String**| |
|
|
2253
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
2254
|
+
|
|
2255
|
+
### Return type
|
|
2256
|
+
|
|
2257
|
+
[**DynamicMetadata**](DynamicMetadata.md)
|
|
2258
|
+
|
|
2259
|
+
### Authorization
|
|
2260
|
+
|
|
2261
|
+
No authorization required
|
|
2262
|
+
|
|
2263
|
+
### HTTP request headers
|
|
2264
|
+
|
|
2265
|
+
- **Content-Type**: text/plain, application/json
|
|
2266
|
+
- **Accept**: application/json
|
|
2267
|
+
|
|
2268
|
+
|
|
2269
|
+
|
|
2270
|
+
# **set_metadata_for_invoice**
|
|
2271
|
+
> DynamicMetadata set_metadata_for_invoice(metadata, invoice_id, opts)
|
|
2272
|
+
|
|
2273
|
+
Remove any existing metadata keys and create the provided data.
|
|
2274
|
+
|
|
2275
|
+
{\"nickname\":\"Set metadata on invoice\",\"request\":\"setInvoiceMetadataRequest.html\",\"response\":\"setInvoiceMetadataResponse.html\"}
|
|
2276
|
+
|
|
2277
|
+
### Example
|
|
2278
|
+
```ruby
|
|
2279
|
+
# load the gem
|
|
2280
|
+
require 'bf_ruby2'
|
|
2281
|
+
|
|
2282
|
+
api_instance = BillForward::InvoicesApi.new
|
|
2283
|
+
|
|
2284
|
+
metadata = BillForward::DynamicMetadata.new # DynamicMetadata |
|
|
2285
|
+
|
|
2286
|
+
invoice_id = "invoice_id_example" # String |
|
|
2287
|
+
|
|
2288
|
+
opts = {
|
|
2289
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
2290
|
+
}
|
|
2291
|
+
|
|
2292
|
+
begin
|
|
2293
|
+
#Remove any existing metadata keys and create the provided data.
|
|
2294
|
+
result = api_instance.set_metadata_for_invoice(metadata, invoice_id, opts)
|
|
2295
|
+
p result
|
|
2296
|
+
rescue BillForward::ApiError => e
|
|
2297
|
+
puts "Exception when calling InvoicesApi->set_metadata_for_invoice: #{e}"
|
|
2298
|
+
end
|
|
2299
|
+
```
|
|
2300
|
+
|
|
2301
|
+
### Parameters
|
|
2302
|
+
|
|
2303
|
+
Name | Type | Description | Notes
|
|
2304
|
+
------------- | ------------- | ------------- | -------------
|
|
2305
|
+
**metadata** | [**DynamicMetadata**](DynamicMetadata.md)| |
|
|
2306
|
+
**invoice_id** | **String**| |
|
|
2307
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
2308
|
+
|
|
2309
|
+
### Return type
|
|
2310
|
+
|
|
2311
|
+
[**DynamicMetadata**](DynamicMetadata.md)
|
|
2312
|
+
|
|
2313
|
+
### Authorization
|
|
2314
|
+
|
|
2315
|
+
No authorization required
|
|
2316
|
+
|
|
2317
|
+
### HTTP request headers
|
|
2318
|
+
|
|
2319
|
+
- **Content-Type**: application/json
|
|
2320
|
+
- **Accept**: application/json
|
|
2321
|
+
|
|
2322
|
+
|
|
2323
|
+
|
|
2324
|
+
# **update_invoice**
|
|
2325
|
+
> InvoicePagedMetadata update_invoice(invoice)
|
|
2326
|
+
|
|
2327
|
+
Update an Invoice.
|
|
2328
|
+
|
|
2329
|
+
{\"nickname\":\"Update an invoice\",\"response\":\"updateInvoiceResponse.html\",\"request\":\"updateInvoiceRequest.html\"}
|
|
2330
|
+
|
|
2331
|
+
### Example
|
|
2332
|
+
```ruby
|
|
2333
|
+
# load the gem
|
|
2334
|
+
require 'bf_ruby2'
|
|
2335
|
+
|
|
2336
|
+
api_instance = BillForward::InvoicesApi.new
|
|
2337
|
+
|
|
2338
|
+
invoice = BillForward::Invoice.new # Invoice | The invoice object to be updated.
|
|
2339
|
+
|
|
2340
|
+
|
|
2341
|
+
begin
|
|
2342
|
+
#Update an Invoice.
|
|
2343
|
+
result = api_instance.update_invoice(invoice)
|
|
2344
|
+
p result
|
|
2345
|
+
rescue BillForward::ApiError => e
|
|
2346
|
+
puts "Exception when calling InvoicesApi->update_invoice: #{e}"
|
|
2347
|
+
end
|
|
2348
|
+
```
|
|
2349
|
+
|
|
2350
|
+
### Parameters
|
|
2351
|
+
|
|
2352
|
+
Name | Type | Description | Notes
|
|
2353
|
+
------------- | ------------- | ------------- | -------------
|
|
2354
|
+
**invoice** | [**Invoice**](Invoice.md)| The invoice object to be updated. |
|
|
2355
|
+
|
|
2356
|
+
### Return type
|
|
2357
|
+
|
|
2358
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
2359
|
+
|
|
2360
|
+
### Authorization
|
|
2361
|
+
|
|
2362
|
+
No authorization required
|
|
2363
|
+
|
|
2364
|
+
### HTTP request headers
|
|
2365
|
+
|
|
2366
|
+
- **Content-Type**: application/json
|
|
2367
|
+
- **Accept**: text/xml, application/xml, application/json
|
|
2368
|
+
|
|
2369
|
+
|
|
2370
|
+
|
|
2371
|
+
# **upsert_metadata_for_invoice**
|
|
2372
|
+
> DynamicMetadata upsert_metadata_for_invoice(metadata, invoice_id, opts)
|
|
2373
|
+
|
|
2374
|
+
Update any existing metadata key-values and insert any new key-values, no keys will be removed.
|
|
2375
|
+
|
|
2376
|
+
{\"nickname\":\"Upsert metadata on invoice\",\"request\":\"upsertInvoiceMetadataRequest.html\",\"response\":\"upsertInvoiceMetadataResponse.html\"}
|
|
2377
|
+
|
|
2378
|
+
### Example
|
|
2379
|
+
```ruby
|
|
2380
|
+
# load the gem
|
|
2381
|
+
require 'bf_ruby2'
|
|
2382
|
+
|
|
2383
|
+
api_instance = BillForward::InvoicesApi.new
|
|
2384
|
+
|
|
2385
|
+
metadata = BillForward::DynamicMetadata.new # DynamicMetadata |
|
|
2386
|
+
|
|
2387
|
+
invoice_id = "invoice_id_example" # String |
|
|
2388
|
+
|
|
2389
|
+
opts = {
|
|
2390
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
2391
|
+
}
|
|
2392
|
+
|
|
2393
|
+
begin
|
|
2394
|
+
#Update any existing metadata key-values and insert any new key-values, no keys will be removed.
|
|
2395
|
+
result = api_instance.upsert_metadata_for_invoice(metadata, invoice_id, opts)
|
|
2396
|
+
p result
|
|
2397
|
+
rescue BillForward::ApiError => e
|
|
2398
|
+
puts "Exception when calling InvoicesApi->upsert_metadata_for_invoice: #{e}"
|
|
2399
|
+
end
|
|
2400
|
+
```
|
|
2401
|
+
|
|
2402
|
+
### Parameters
|
|
2403
|
+
|
|
2404
|
+
Name | Type | Description | Notes
|
|
2405
|
+
------------- | ------------- | ------------- | -------------
|
|
2406
|
+
**metadata** | [**DynamicMetadata**](DynamicMetadata.md)| |
|
|
2407
|
+
**invoice_id** | **String**| |
|
|
2408
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
2409
|
+
|
|
2410
|
+
### Return type
|
|
2411
|
+
|
|
2412
|
+
[**DynamicMetadata**](DynamicMetadata.md)
|
|
2413
|
+
|
|
2414
|
+
### Authorization
|
|
2415
|
+
|
|
2416
|
+
No authorization required
|
|
2417
|
+
|
|
2418
|
+
### HTTP request headers
|
|
2419
|
+
|
|
2420
|
+
- **Content-Type**: application/json
|
|
2421
|
+
- **Accept**: application/json
|
|
2422
|
+
|
|
2423
|
+
|
|
2424
|
+
|
|
2425
|
+
# **void_invoice**
|
|
2426
|
+
> InvoicePagedMetadata void_invoice(invoice_id, organizations)
|
|
2427
|
+
|
|
2428
|
+
Voids the invoice specified by the invoice identifier parameter.
|
|
2429
|
+
|
|
2430
|
+
{ \"nickname\" : \"Void an invoice\",\"response\" : \"voidInvoice.html\"}
|
|
2431
|
+
|
|
2432
|
+
### Example
|
|
2433
|
+
```ruby
|
|
2434
|
+
# load the gem
|
|
2435
|
+
require 'bf_ruby2'
|
|
2436
|
+
|
|
2437
|
+
api_instance = BillForward::InvoicesApi.new
|
|
2438
|
+
|
|
2439
|
+
invoice_id = "invoice_id_example" # String | ID of the invoice.
|
|
2440
|
+
|
|
2441
|
+
organizations = ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
2442
|
+
|
|
2443
|
+
|
|
2444
|
+
begin
|
|
2445
|
+
#Voids the invoice specified by the invoice identifier parameter.
|
|
2446
|
+
result = api_instance.void_invoice(invoice_id, organizations)
|
|
2447
|
+
p result
|
|
2448
|
+
rescue BillForward::ApiError => e
|
|
2449
|
+
puts "Exception when calling InvoicesApi->void_invoice: #{e}"
|
|
2450
|
+
end
|
|
2451
|
+
```
|
|
2452
|
+
|
|
2453
|
+
### Parameters
|
|
2454
|
+
|
|
2455
|
+
Name | Type | Description | Notes
|
|
2456
|
+
------------- | ------------- | ------------- | -------------
|
|
2457
|
+
**invoice_id** | **String**| ID of the invoice. |
|
|
2458
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. |
|
|
2459
|
+
|
|
2460
|
+
### Return type
|
|
2461
|
+
|
|
2462
|
+
[**InvoicePagedMetadata**](InvoicePagedMetadata.md)
|
|
2463
|
+
|
|
2464
|
+
### Authorization
|
|
2465
|
+
|
|
2466
|
+
No authorization required
|
|
2467
|
+
|
|
2468
|
+
### HTTP request headers
|
|
2469
|
+
|
|
2470
|
+
- **Content-Type**: text/plain, application/json
|
|
2471
|
+
- **Accept**: application/json
|
|
2472
|
+
|
|
2473
|
+
|
|
2474
|
+
|