Atualizar configurações

curl --request POST \
  --url https://api.base39.io/v1/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "steps": {},
  "disbursements": {},
  "flags": {
    "showCancelButtonBeforeDisbursement": true
  },
  "notifications": {
    "email": {
      "provider": "smtp",
      "config": {
        "email": "<string>",
        "host": "<string>",
        "port": 123,
        "username": "<string>",
        "password": "<string>"
      }
    },
    "sms": {
      "provider": "infobip",
      "config": {
        "token": "<string>",
        "basePath": "<string>"
      }
    },
    "whatsapp": {
      "provider": "twilio",
      "config": {
        "account": "<string>",
        "token": "<string>",
        "sender": "<string>"
      }
    }
  },
  "validations": {
    "pix": {
      "type": "qitech",
      "credentials": {
        "url": "https://api-auth.sandbox.qitech.app",
        "apiKey": "abcdef12345",
        "privateKey": "-----BEGIN RSA PRIVATE KEY-----\\nMIIBOgIBAAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9oQXSxo5c1iL+YC+dr4jm\\nkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQJAMtWs6j3ytIbJ4CofHAy5\\nD+aiZ+QqGMi8DqHl8spBNYYPlwNhpze2Ge9YnCx2Vkz46vLpP5KDAmQR8Vogea8E\\nAQIhAOZCyFD4PgUNg02UiV9eBsFG61qlOHBZBMmWnAKKe7uBAiEAwNMBhsc6Wsl8\\nyW7qYMtLljpBUdy0C5vEu0JKdvZYVnkCIAJ/gPrX5pxZbC5ASUk+lOYt5cnC9xzI\\n6nNhbendJMCBAiBZasAfdw3ZgewLIRMxFbUUkikuRBF9/JsLV19esTgfyQIhANv2\\n+R0S0bzykeZ5QZF+getN1TfdEviOxFnTu+my50DL\\n-----END RSA PRIVATE KEY-----",
        "publicKey": "-----BEGIN PUBLIC KEY-----\\nMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9\\noQXSxo5c1iL+YC+dr4jmkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQ==\\n-----END PUBLIC KEY-----",
        "ccbPrefix": "<string>",
        "passphrase": "<string>"
      }
    }
  },
  "loans": {
    "concurrency": [
      {
        "quantityAllowed": 123,
        "status": [
          "open"
        ]
      }
    ],
    "conditions": [
      {
        "title": "<string>",
        "content": "<string>"
      }
    ]
  },
  "invoices": {
    "payOff": {
      "fine": {
        "amount": 0.02,
        "daysToStart": 1
      },
      "interest": {
        "amount": 0.01,
        "daysToStart": 1
      },
      "allowOverduePayment": true,
      "daysUntilDue": {
        "type": "absolute",
        "amount": 1
      },
      "updateInvoiceItemOnInsert": true
    },
    "customerRecurring": {
      "fine": {
        "amount": 0.02,
        "daysToStart": 1
      },
      "interest": {
        "amount": 0.01,
        "daysToStart": 1
      },
      "allowOverduePayment": true,
      "daysUntilDue": {
        "type": "absolute",
        "amount": 10
      },
      "create": {
        "autoCreate": true
      },
      "updateInvoiceItemOnInsert": false
    },
    "companyRecurring": {
      "fine": {
        "amount": 0.02,
        "daysToStart": 1
      },
      "interest": {
        "amount": 0.01,
        "daysToStart": 1
      },
      "allowOverduePayment": true,
      "daysUntilDue": {
        "type": "static",
        "amount": 10
      },
      "create": {
        "cutoffDay": 25,
        "autoCreate": true
      },
      "updateInvoiceItemOnInsert": false
    },
    "autoMoneyRelocation": true
  },
  "locales": {
    "Brazil": {
      "states": {
        "MG": {
          "name": "Minas Gerais",
          "slug": "MG"
        }
      }
    }
  },
  "recaptcha": {
    "siteKey": "<string>"
  },
  "employments": {
    "expireInDays": 30
  },
  "domains": {
    "company": "<string>",
    "customer": "<string>",
    "backoffice": "<string>"
  },
  "queues": [
    {
      "name": "Fila de propostas",
      "query": "status:open OR status:pending AND customer.id:`${customer.id}` AND created_at<`${date}` AND company.document:`${company.document}`"
    }
  ]
}'

{
  "steps": {},
  "disbursements": {},
  "flags": {
    "showCancelButtonBeforeDisbursement": true
  },
  "notifications": {
    "email": {
      "provider": "smtp",
      "config": {
        "email": "<string>",
        "host": "<string>",
        "port": 123,
        "username": "<string>",
        "password": "<string>"
      }
    },
    "sms": {
      "provider": "infobip",
      "config": {
        "token": "<string>",
        "basePath": "<string>"
      }
    },
    "whatsapp": {
      "provider": "twilio",
      "config": {
        "account": "<string>",
        "token": "<string>",
        "sender": "<string>"
      }
    }
  },
  "validations": {
    "pix": {
      "type": "qitech",
      "credentials": {
        "url": "https://api-auth.sandbox.qitech.app",
        "apiKey": "abcdef12345",
        "privateKey": "-----BEGIN RSA PRIVATE KEY-----\\nMIIBOgIBAAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9oQXSxo5c1iL+YC+dr4jm\\nkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQJAMtWs6j3ytIbJ4CofHAy5\\nD+aiZ+QqGMi8DqHl8spBNYYPlwNhpze2Ge9YnCx2Vkz46vLpP5KDAmQR8Vogea8E\\nAQIhAOZCyFD4PgUNg02UiV9eBsFG61qlOHBZBMmWnAKKe7uBAiEAwNMBhsc6Wsl8\\nyW7qYMtLljpBUdy0C5vEu0JKdvZYVnkCIAJ/gPrX5pxZbC5ASUk+lOYt5cnC9xzI\\n6nNhbendJMCBAiBZasAfdw3ZgewLIRMxFbUUkikuRBF9/JsLV19esTgfyQIhANv2\\n+R0S0bzykeZ5QZF+getN1TfdEviOxFnTu+my50DL\\n-----END RSA PRIVATE KEY-----",
        "publicKey": "-----BEGIN PUBLIC KEY-----\\nMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9\\noQXSxo5c1iL+YC+dr4jmkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQ==\\n-----END PUBLIC KEY-----",
        "ccbPrefix": "<string>",
        "passphrase": "<string>"
      }
    }
  },
  "loans": {
    "concurrency": [
      {
        "quantityAllowed": 123,
        "status": [
          "open"
        ]
      }
    ],
    "conditions": [
      {
        "title": "<string>",
        "content": "<string>"
      }
    ]
  },
  "invoices": {
    "payOff": {
      "fine": {
        "amount": 0.02,
        "daysToStart": 1
      },
      "interest": {
        "amount": 0.01,
        "daysToStart": 1
      },
      "allowOverduePayment": true,
      "daysUntilDue": {
        "type": "absolute",
        "amount": 1
      },
      "updateInvoiceItemOnInsert": true
    },
    "customerRecurring": {
      "fine": {
        "amount": 0.02,
        "daysToStart": 1
      },
      "interest": {
        "amount": 0.01,
        "daysToStart": 1
      },
      "allowOverduePayment": true,
      "daysUntilDue": {
        "type": "absolute",
        "amount": 10
      },
      "create": {
        "autoCreate": true
      },
      "updateInvoiceItemOnInsert": false
    },
    "companyRecurring": {
      "fine": {
        "amount": 0.02,
        "daysToStart": 1
      },
      "interest": {
        "amount": 0.01,
        "daysToStart": 1
      },
      "allowOverduePayment": true,
      "daysUntilDue": {
        "type": "static",
        "amount": 10
      },
      "create": {
        "cutoffDay": 25,
        "autoCreate": true
      },
      "updateInvoiceItemOnInsert": false
    },
    "autoMoneyRelocation": true
  },
  "locales": {
    "Brazil": {
      "states": {
        "MG": {
          "name": "Minas Gerais",
          "slug": "MG"
        }
      }
    }
  },
  "recaptcha": {
    "siteKey": "<string>"
  },
  "employments": {
    "expireInDays": 30
  },
  "domains": {
    "company": "<string>",
    "customer": "<string>",
    "backoffice": "<string>"
  },
  "queues": [
    {
      "name": "Fila de propostas",
      "query": "status:open OR status:pending AND customer.id:`${customer.id}` AND created_at<`${date}` AND company.document:`${company.document}`"
    }
  ]
}

POST

settings

curl --request POST \
  --url https://api.base39.io/v1/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "steps": {},
  "disbursements": {},
  "flags": {
    "showCancelButtonBeforeDisbursement": true
  },
  "notifications": {
    "email": {
      "provider": "smtp",
      "config": {
        "email": "<string>",
        "host": "<string>",
        "port": 123,
        "username": "<string>",
        "password": "<string>"
      }
    },
    "sms": {
      "provider": "infobip",
      "config": {
        "token": "<string>",
        "basePath": "<string>"
      }
    },
    "whatsapp": {
      "provider": "twilio",
      "config": {
        "account": "<string>",
        "token": "<string>",
        "sender": "<string>"
      }
    }
  },
  "validations": {
    "pix": {
      "type": "qitech",
      "credentials": {
        "url": "https://api-auth.sandbox.qitech.app",
        "apiKey": "abcdef12345",
        "privateKey": "-----BEGIN RSA PRIVATE KEY-----\\nMIIBOgIBAAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9oQXSxo5c1iL+YC+dr4jm\\nkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQJAMtWs6j3ytIbJ4CofHAy5\\nD+aiZ+QqGMi8DqHl8spBNYYPlwNhpze2Ge9YnCx2Vkz46vLpP5KDAmQR8Vogea8E\\nAQIhAOZCyFD4PgUNg02UiV9eBsFG61qlOHBZBMmWnAKKe7uBAiEAwNMBhsc6Wsl8\\nyW7qYMtLljpBUdy0C5vEu0JKdvZYVnkCIAJ/gPrX5pxZbC5ASUk+lOYt5cnC9xzI\\n6nNhbendJMCBAiBZasAfdw3ZgewLIRMxFbUUkikuRBF9/JsLV19esTgfyQIhANv2\\n+R0S0bzykeZ5QZF+getN1TfdEviOxFnTu+my50DL\\n-----END RSA PRIVATE KEY-----",
        "publicKey": "-----BEGIN PUBLIC KEY-----\\nMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9\\noQXSxo5c1iL+YC+dr4jmkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQ==\\n-----END PUBLIC KEY-----",
        "ccbPrefix": "<string>",
        "passphrase": "<string>"
      }
    }
  },
  "loans": {
    "concurrency": [
      {
        "quantityAllowed": 123,
        "status": [
          "open"
        ]
      }
    ],
    "conditions": [
      {
        "title": "<string>",
        "content": "<string>"
      }
    ]
  },
  "invoices": {
    "payOff": {
      "fine": {
        "amount": 0.02,
        "daysToStart": 1
      },
      "interest": {
        "amount": 0.01,
        "daysToStart": 1
      },
      "allowOverduePayment": true,
      "daysUntilDue": {
        "type": "absolute",
        "amount": 1
      },
      "updateInvoiceItemOnInsert": true
    },
    "customerRecurring": {
      "fine": {
        "amount": 0.02,
        "daysToStart": 1
      },
      "interest": {
        "amount": 0.01,
        "daysToStart": 1
      },
      "allowOverduePayment": true,
      "daysUntilDue": {
        "type": "absolute",
        "amount": 10
      },
      "create": {
        "autoCreate": true
      },
      "updateInvoiceItemOnInsert": false
    },
    "companyRecurring": {
      "fine": {
        "amount": 0.02,
        "daysToStart": 1
      },
      "interest": {
        "amount": 0.01,
        "daysToStart": 1
      },
      "allowOverduePayment": true,
      "daysUntilDue": {
        "type": "static",
        "amount": 10
      },
      "create": {
        "cutoffDay": 25,
        "autoCreate": true
      },
      "updateInvoiceItemOnInsert": false
    },
    "autoMoneyRelocation": true
  },
  "locales": {
    "Brazil": {
      "states": {
        "MG": {
          "name": "Minas Gerais",
          "slug": "MG"
        }
      }
    }
  },
  "recaptcha": {
    "siteKey": "<string>"
  },
  "employments": {
    "expireInDays": 30
  },
  "domains": {
    "company": "<string>",
    "customer": "<string>",
    "backoffice": "<string>"
  },
  "queues": [
    {
      "name": "Fila de propostas",
      "query": "status:open OR status:pending AND customer.id:`${customer.id}` AND created_at<`${date}` AND company.document:`${company.document}`"
    }
  ]
}'

{
  "steps": {},
  "disbursements": {},
  "flags": {
    "showCancelButtonBeforeDisbursement": true
  },
  "notifications": {
    "email": {
      "provider": "smtp",
      "config": {
        "email": "<string>",
        "host": "<string>",
        "port": 123,
        "username": "<string>",
        "password": "<string>"
      }
    },
    "sms": {
      "provider": "infobip",
      "config": {
        "token": "<string>",
        "basePath": "<string>"
      }
    },
    "whatsapp": {
      "provider": "twilio",
      "config": {
        "account": "<string>",
        "token": "<string>",
        "sender": "<string>"
      }
    }
  },
  "validations": {
    "pix": {
      "type": "qitech",
      "credentials": {
        "url": "https://api-auth.sandbox.qitech.app",
        "apiKey": "abcdef12345",
        "privateKey": "-----BEGIN RSA PRIVATE KEY-----\\nMIIBOgIBAAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9oQXSxo5c1iL+YC+dr4jm\\nkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQJAMtWs6j3ytIbJ4CofHAy5\\nD+aiZ+QqGMi8DqHl8spBNYYPlwNhpze2Ge9YnCx2Vkz46vLpP5KDAmQR8Vogea8E\\nAQIhAOZCyFD4PgUNg02UiV9eBsFG61qlOHBZBMmWnAKKe7uBAiEAwNMBhsc6Wsl8\\nyW7qYMtLljpBUdy0C5vEu0JKdvZYVnkCIAJ/gPrX5pxZbC5ASUk+lOYt5cnC9xzI\\n6nNhbendJMCBAiBZasAfdw3ZgewLIRMxFbUUkikuRBF9/JsLV19esTgfyQIhANv2\\n+R0S0bzykeZ5QZF+getN1TfdEviOxFnTu+my50DL\\n-----END RSA PRIVATE KEY-----",
        "publicKey": "-----BEGIN PUBLIC KEY-----\\nMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9\\noQXSxo5c1iL+YC+dr4jmkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQ==\\n-----END PUBLIC KEY-----",
        "ccbPrefix": "<string>",
        "passphrase": "<string>"
      }
    }
  },
  "loans": {
    "concurrency": [
      {
        "quantityAllowed": 123,
        "status": [
          "open"
        ]
      }
    ],
    "conditions": [
      {
        "title": "<string>",
        "content": "<string>"
      }
    ]
  },
  "invoices": {
    "payOff": {
      "fine": {
        "amount": 0.02,
        "daysToStart": 1
      },
      "interest": {
        "amount": 0.01,
        "daysToStart": 1
      },
      "allowOverduePayment": true,
      "daysUntilDue": {
        "type": "absolute",
        "amount": 1
      },
      "updateInvoiceItemOnInsert": true
    },
    "customerRecurring": {
      "fine": {
        "amount": 0.02,
        "daysToStart": 1
      },
      "interest": {
        "amount": 0.01,
        "daysToStart": 1
      },
      "allowOverduePayment": true,
      "daysUntilDue": {
        "type": "absolute",
        "amount": 10
      },
      "create": {
        "autoCreate": true
      },
      "updateInvoiceItemOnInsert": false
    },
    "companyRecurring": {
      "fine": {
        "amount": 0.02,
        "daysToStart": 1
      },
      "interest": {
        "amount": 0.01,
        "daysToStart": 1
      },
      "allowOverduePayment": true,
      "daysUntilDue": {
        "type": "static",
        "amount": 10
      },
      "create": {
        "cutoffDay": 25,
        "autoCreate": true
      },
      "updateInvoiceItemOnInsert": false
    },
    "autoMoneyRelocation": true
  },
  "locales": {
    "Brazil": {
      "states": {
        "MG": {
          "name": "Minas Gerais",
          "slug": "MG"
        }
      }
    }
  },
  "recaptcha": {
    "siteKey": "<string>"
  },
  "employments": {
    "expireInDays": 30
  },
  "domains": {
    "company": "<string>",
    "customer": "<string>",
    "backoffice": "<string>"
  },
  "queues": [
    {
      "name": "Fila de propostas",
      "query": "status:open OR status:pending AND customer.id:`${customer.id}` AND created_at<`${date}` AND company.document:`${company.document}`"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

Chave única de idempotência para evitar duplicação de requisições.

Body

application/json

Criar configurações

steps

object

Configurações de fluxos em modo passo a passo do empréstimos.

Show child attributes

disbursements

object

Show child attributes

flags

object

Configurações de flags.

Show child attributes

notifications

object

Configurações de serviços provedores de notificações.

Show child attributes

validations

object

Configurações de validadores.

Show child attributes

loans

object

Configurações de empréstimos

Show child attributes

invoices

object

Configurações de faturas

Show child attributes

locales

object

Estes são textos personalizáveis da aplicação, que aceitam campos chave-valor. É importante notar que nesta página de documentação, você pode criar até três níveis de objetos aninhados. No entanto, ao realizar chamadas fora desta página de documentação, o suporte é estendido para além de três níveis.

Show child attributes

Example:

{
  "Brazil": {
    "states": {
      "MG": { "name": "Minas Gerais", "slug": "MG" }
    }
  }
}

recaptcha

object

Configurações do recaptcha. Estas configurações não são utilizadas em rotinas de Core, cabendo ao Core apenas responsabilidade de persistência e disponilidade de dados.

Show child attributes

employments

object

Configurações de vínculos empregatícios

Show child attributes

domains

object

Configurações de domínios customizados

Show child attributes

queues

SettingsQueues · object[]

Configurações de fila

Show child attributes

Response

201 - application/json

Retorna o objeto Settings se a atualização for bem-sucedida. Retorna um erro se os parâmetros de atualização forem inválidos.

Este objeto representa as configurações.

steps

object

Configurações de fluxos em modo passo a passo do empréstimos.

Show child attributes

disbursements

object

Show child attributes

flags

object

Configurações de flags.

Show child attributes

notifications

object

Configurações de serviços provedores de notificações.

Show child attributes

validations

object

Configurações de validadores.

Show child attributes

loans

object

Configurações de empréstimos

Show child attributes

invoices

object

Configurações de faturas

Show child attributes

locales

object

Show child attributes

Example:

{
  "Brazil": {
    "states": {
      "MG": { "name": "Minas Gerais", "slug": "MG" }
    }
  }
}

recaptcha

object

Configurações do recaptcha. Estas configurações não são utilizadas em rotinas de Core, cabendo ao Core apenas responsabilidade de persistência e disponilidade de dados.

Show child attributes

employments

object

Configurações de vínculos empregatícios

Show child attributes

domains

object

Configurações de domínios customizados

Show child attributes

queues

SettingsQueues · object[]

Configurações de fila

Show child attributes

Listar configurações Obter entidades

Referências

Authorizations

Headers

Body

Response