Skip to main content

Preferenze

Il path parameter companyId è l'identificativo TS Digital di un'azienda correttamente registrata

Creazione di una preferenza

Permette di creare una preferenza per una specifica azienda

[POST] /preferences/{companyId}

Nella request abbiamo:

  • daysDueDate: giorni di scadenza che verranno aggiunti alla data di scadenza di una richiesta di pagamento
  • emailSettings: parametri di customizzazione per email
    • bodyText: testo della mail
    • name: nome inserito nell'intestazione della mail
    • surname: cognome inserito nell'intestazione della mail
  • paymentMethodSettings: identificativi delle rate del piano di pagamento da pagare
    • name: metodo di pagamento
    • langLocaleconstraints: linguaminimali dae utilizzaremassimali del singolo metodo di pagamento
      • minimumAmount: importo minimo per il metodo di pagamento
      maximumAmount: importo massimo per il metodo di pagamento

      Nella response l'API ritorna:

      • idcompanyId: identificativoid univocoazienda delTS pagamento creatoDigital
      • linkdaysDueDate: linkgiorni di scadenza che verranno aggiunti alla data di scadenza di una richiesta di pagamento
      emailSettings: parametri di customizzazione per email
        bodyText: testo della mail name: nome inserito nell'intestazione della mail surname: cognome inserito nell'intestazione della mail paymentMethodSettings: identificativi delle rate del piano di pagamento versoda lapagare piattaforma
          name: metodo di riferimentopagamento constraints: minimali e massimali del singolo metodo di pagamento
            minimumAmount: importo minimo per il metodo di pagamento maximumAmount: importo massimo per il metodo di pagamento

             

            Modifica di una preferenza

            Permette di modificare una preferenza precedentemente creata per una specifica azienda

            [PATCH] /preferences/{companyId}

            Nella request abbiamo:

              daysDueDate: giorni di scadenza che verranno aggiunti alla data di scadenza di una richiesta di pagamento emailSettings: parametri di customizzazione per email
                bodyText: testo della mail name: nome inserito nell'intestazione della mail surname: cognome inserito nell'intestazione della mail paymentMethodSettings: identificativi delle rate del piano di pagamento da pagare
                  name: metodo di pagamento constraints: minimali e massimali del singolo metodo di pagamento
                    minimumAmount: importo minimo per il metodo di pagamento maximumAmount: importo massimo per il metodo di pagamento

                    Nella response l'API ritorna:

                      companyId: id azienda TS Digital daysDueDate: giorni di scadenza che verranno aggiunti alla data di scadenza di una richiesta di pagamento emailSettings: parametri di customizzazione per email
                        bodyText: testo della mail name: nome inserito nell'intestazione della mail surname: cognome inserito nell'intestazione della mail paymentMethodSettings: identificativi delle rate del piano di pagamento da pagare
                          name: metodo di pagamento constraints: minimali e massimali del singolo metodo di pagamento
                            minimumAmount: importo minimo per il metodo di pagamento maximumAmount: importo massimo per il metodo di pagamento

                             

                            Visualizzazione di una preferenza

                            Permette di modificare una preferenza precedentemente creata per una specifica azienda

                            [GET] /preferences/{companyId}

                            Nella response l'API ritorna:

                              companyId: id azienda TS Digital daysDueDate: giorni di scadenza che verranno aggiunti alla data di scadenza di una richiesta di pagamento emailSettings: parametri di customizzazione per email
                                bodyText: testo della mail name: nome inserito nell'intestazione della mail surname: cognome inserito nell'intestazione della mail paymentMethodSettings: identificativi delle rate del piano di pagamento da pagare
                                  name: metodo di pagamento constraints: minimali e massimali del singolo metodo di pagamento
                                    minimumAmount: importo minimo per il metodo di pagamento maximumAmount: importo massimo per il metodo di pagamento