Update connector invoice settings

post

https://api.stage.payouts.com/invoice-settings/connector/{id}

Required permissions for this API:

WRITE:MARKETING

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

number

required

Body Params

currentStep

string

enum

The step the user stopped at when creating the connector

connectorName

string | null

Connector name

connectorCoreDepartment

string | null

Connector core department

selfInvoiceSettingCurrenciesPreferences

array of arrays

Specify the currencies in which you allow invoices to be generated and paid.

selfInvoiceSettingCurrenciesPreferences

selfInvoiceSettingGenerationSchedule

object | null

Set the invoice generation scheduler config

selfInvoiceSettingIssueDateBase

string | null

enum

Should the count start from Commission period or the invoice generation date?

Allowed:

paymentTermType

string | null

enum

Payment term type

Allowed:

paymentTermDays

number | null

Net days for payment terms

selfInvoiceSettingInvoiceRequiredForPayouts

boolean

Invoice required for payouts.

selfInvoiceSettingInvoiceMandatoryForCountries

array of arrays

Defaults to

Specify the countries for which invoice is mandatory before payment processing.

selfInvoiceSettingInvoiceMandatoryForCountries

selfInvoiceSettingVatSalesTax

boolean

VAT / Sales Tax / GST Calculation.

selfInvoiceSettingVatInclusive

string

enum

Choose whether to include or exclude VAT (Value Added Tax) from your invoices.

Allowed:

invoiceEditingWorkflowEnabled

boolean

Enable or disable permissions

invoiceApprovalWorkflowEnabled

boolean

Enable or disable permissions

invoicePayoutWorkflowEnabled

boolean

Enable or disable permissions

invoiceEditingPermissionsMode

string

enum

Permissions mode

Allowed:

invoiceApprovalPermissionsMode

string

enum

Permissions mode

Allowed:

invoicePayoutPermissionsMode

string

enum

Permissions mode

Allowed:

payoutsSettingsSchedule

object | null

Weekly payment cycle time.

wirePaymentTypeSettings

object | null

Wire payment type settings

cryptoPaymentTypeSettings

object | null

Crypto payment type settings

cryptoPaymentTypeEnabled

boolean

Crypto payment type enabled/disabled field

payoneerPaymentTypeSettings

object | null

Payoneer payment type settings. Required if payoneerPaymentTypeEnabled is true

payoneerPaymentTypeEnabled

boolean

Payoneer payment type enabled/disabled field

paypalPaymentTypeSettings

object | null

Paypal payment type settings. Required if paypalPaymentTypeEnabled is true

paypalPaymentTypeEnabled

boolean

Payoneer payment type enabled/disabled field

vendorSettingsProfileCustomizationAccountInfo

boolean

Account information.

vendorSettingsProfileCustomizationContactInfo

boolean

Contact information.

vendorSettingsProfileCustomizationAccountAddress

boolean

Account address.

enableVendorAutocreation

boolean

Enable vendor auto creation on match

vendorSettingsPaymentMethod

boolean

Payment method.

vendorSettingsPaymentMethodRequired

boolean

Payment method required.

vendorSettingsTaxFormCollection

boolean

Tax form collection.

vendorSettingsTaxFormCollectionRequired

boolean

Tax form collection required.

vendorSettingsPaymentCurrency

boolean

Vendor payment currency.

taxSettingsPurposesPayments

array of objects

Purposes for your payments.

taxSettingsPurposesPayments

taxSettingsPurposePaymentDefaultId

number | null

Default payment purpose tax code id that will be used during calculation if vendor does not have a tax code for some reason. Right now it used in recalculation workflow

taxCollectFromRecipients

string | null

enum

Select the tax form you want to collect from your recipients.

Allowed:

taxW9FormSubmitted

string | null

enum

Action to take when a W9 form is submitted.

Allowed:

taxW9FormApprovePermissions

array of objects

W9 form approve permissions. Required if taxW9FormSubmitted is not Automatically

taxW9FormApprovePermissions

taxW8FormSubmitted

string | null

enum

Action to take when a W8 form is submitted.

Allowed:

taxW8FormApprovePermissions

array of objects

W8 form approve permissions. Required if taxW8FormSubmitted is not Automatically

taxW8FormApprovePermissions

taxWithoutTaxForm

string | null

enum

How would you like to handle payments without tax forms on file?

Allowed:

feeConnectorYourCompany

boolean

Who s responsible for paying the Connector fees?

feeTransferWireFeeYourCompany

boolean

Who s responsible for paying the wire transfer fees?

feeTransferCryptoYourCompany

boolean

Who s responsible for paying the crypto transfer fees?

feeTransferPayonnerYourCompany

boolean

Who s responsible for paying the payonner transfer fees?

feeTransferPayPalYourCompany

boolean

Who s responsible for paying the PayPal transfer fees?

feeCurrencyNotDefinedTransferYourCompany

boolean

Who s responsible for paying the wire transfer fees?

feeCurrencyNotDefinedConversionYourCompany

boolean

Who s responsible for paying the conversion transfer fees?

feeAccountVerificationManualUploadYourCompany

boolean

Who s responsible for a bank account verification fees, through Manual Upload?

feeAccountVerificationBankLinkageYourCompany

boolean

Who s responsible for a bank account verification fees, through Bank Linkage?

feeAccountVerificationMicroDepositYourCompany

boolean

Who s responsible for a bank account verification fees, through Micro Deposit?

feeInvoicingTaxFormsInvoiceGenerationYourCompany

boolean

Who s responsible for paying the invoice generation fees?

feeInvoicingTaxFormsCollectionYourCompany

boolean

Who s responsible for paying the Tax Forms Collection fees?

feeWithholdingVatTaxYourCompany

boolean

Withholding tax calculation fees.

feeWithholdingVatVatYourCompany

boolean

Withholding vat calculation fees.

feeEWalletPayPalConnectYourCompany

boolean

E-Wallet PayPal connect your company fees.

feeEWalletPayPalTransactionYourCompany

boolean

E-Wallet Payonner transaction your company fees.

feeEWalletPayonnerConnectYourCompany

boolean

E-Wallet Payonner connect your company fees.

feeEWalletPayonnerTransactionYourCompany

boolean

E-Wallet Payonner transaction your company fees.

feeFiatToCryptoCurrencyYourCompany

boolean

Who is responsible for paying the conversion fee from fiat to crypto currency?

vendorManagementPreference

string

enum

Vendor management preferences

Allowed:

vendorDataAdditionMethods

array of strings

Vendor data import preferences

vendorDataAdditionMethods

vendorDataAdditionMethodOther

string

Vendor data import preferences (other)

vendorPortalMigrateExistingOther

string

Vendor portal migrate existing preference (other)

vendorPortalOnboardPreference

string

enum

Vendor management preferences

Allowed:

vendorPortalMigrateExistingPreferences

array of strings

Vendor portal migrate existing preferences

vendorPortalMigrateExistingPreferences

isApiEnabled

boolean

Is API enabled

Responses

200

401A response indicating that the provided bearer token is invalid or has already expired