Avisar una transferencia de una factura del cliente
curl --request POST \
--url https://api.raul.ugps.io/api/v1/internal/atlas-portal/clients/{atlasClientId}/invoices/{invoiceId}/transfer-notice \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contractVersion": 1,
"author": {
"name": "Paula Contreras",
"email": "jsmith@example.com"
},
"bankReference": "TRF-20261011-01"
}
'import requests
url = "https://api.raul.ugps.io/api/v1/internal/atlas-portal/clients/{atlasClientId}/invoices/{invoiceId}/transfer-notice"
payload = {
"contractVersion": 1,
"author": {
"name": "Paula Contreras",
"email": "jsmith@example.com"
},
"bankReference": "TRF-20261011-01"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contractVersion: 1,
author: {name: 'Paula Contreras', email: 'jsmith@example.com'},
bankReference: 'TRF-20261011-01'
})
};
fetch('https://api.raul.ugps.io/api/v1/internal/atlas-portal/clients/{atlasClientId}/invoices/{invoiceId}/transfer-notice', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.raul.ugps.io/api/v1/internal/atlas-portal/clients/{atlasClientId}/invoices/{invoiceId}/transfer-notice",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contractVersion' => 1,
'author' => [
'name' => 'Paula Contreras',
'email' => 'jsmith@example.com'
],
'bankReference' => 'TRF-20261011-01'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.raul.ugps.io/api/v1/internal/atlas-portal/clients/{atlasClientId}/invoices/{invoiceId}/transfer-notice"
payload := strings.NewReader("{\n \"contractVersion\": 1,\n \"author\": {\n \"name\": \"Paula Contreras\",\n \"email\": \"jsmith@example.com\"\n },\n \"bankReference\": \"TRF-20261011-01\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.raul.ugps.io/api/v1/internal/atlas-portal/clients/{atlasClientId}/invoices/{invoiceId}/transfer-notice")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contractVersion\": 1,\n \"author\": {\n \"name\": \"Paula Contreras\",\n \"email\": \"jsmith@example.com\"\n },\n \"bankReference\": \"TRF-20261011-01\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.raul.ugps.io/api/v1/internal/atlas-portal/clients/{atlasClientId}/invoices/{invoiceId}/transfer-notice")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contractVersion\": 1,\n \"author\": {\n \"name\": \"Paula Contreras\",\n \"email\": \"jsmith@example.com\"\n },\n \"bankReference\": \"TRF-20261011-01\"\n}"
response = http.request(request)
puts response.read_body{
"contractVersion": 1,
"invoiceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcome": "notified",
"notifiedAt": "2023-11-07T05:31:56Z"
}{
"contractVersion": 1,
"code": "CLIENT_NOT_LINKED",
"message": "<string>"
}{
"contractVersion": 1,
"code": "CLIENT_NOT_LINKED",
"message": "<string>"
}{
"contractVersion": 1,
"code": "CLIENT_NOT_LINKED",
"message": "<string>"
}Atlas portal
Avisar una transferencia de una factura del cliente
Anota el aviso en la factura y manda el correo client_portal.bank_transfer a la casilla de facturación de la empresa. No cambia el estado de pago. Un aviso repetido dentro de 15 minutos responde alreadyNotified sin otro correo.
POST
/
api
/
v1
/
internal
/
atlas-portal
/
clients
/
{atlasClientId}
/
invoices
/
{invoiceId}
/
transfer-notice
Avisar una transferencia de una factura del cliente
curl --request POST \
--url https://api.raul.ugps.io/api/v1/internal/atlas-portal/clients/{atlasClientId}/invoices/{invoiceId}/transfer-notice \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contractVersion": 1,
"author": {
"name": "Paula Contreras",
"email": "jsmith@example.com"
},
"bankReference": "TRF-20261011-01"
}
'import requests
url = "https://api.raul.ugps.io/api/v1/internal/atlas-portal/clients/{atlasClientId}/invoices/{invoiceId}/transfer-notice"
payload = {
"contractVersion": 1,
"author": {
"name": "Paula Contreras",
"email": "jsmith@example.com"
},
"bankReference": "TRF-20261011-01"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contractVersion: 1,
author: {name: 'Paula Contreras', email: 'jsmith@example.com'},
bankReference: 'TRF-20261011-01'
})
};
fetch('https://api.raul.ugps.io/api/v1/internal/atlas-portal/clients/{atlasClientId}/invoices/{invoiceId}/transfer-notice', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.raul.ugps.io/api/v1/internal/atlas-portal/clients/{atlasClientId}/invoices/{invoiceId}/transfer-notice",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contractVersion' => 1,
'author' => [
'name' => 'Paula Contreras',
'email' => 'jsmith@example.com'
],
'bankReference' => 'TRF-20261011-01'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.raul.ugps.io/api/v1/internal/atlas-portal/clients/{atlasClientId}/invoices/{invoiceId}/transfer-notice"
payload := strings.NewReader("{\n \"contractVersion\": 1,\n \"author\": {\n \"name\": \"Paula Contreras\",\n \"email\": \"jsmith@example.com\"\n },\n \"bankReference\": \"TRF-20261011-01\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.raul.ugps.io/api/v1/internal/atlas-portal/clients/{atlasClientId}/invoices/{invoiceId}/transfer-notice")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contractVersion\": 1,\n \"author\": {\n \"name\": \"Paula Contreras\",\n \"email\": \"jsmith@example.com\"\n },\n \"bankReference\": \"TRF-20261011-01\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.raul.ugps.io/api/v1/internal/atlas-portal/clients/{atlasClientId}/invoices/{invoiceId}/transfer-notice")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contractVersion\": 1,\n \"author\": {\n \"name\": \"Paula Contreras\",\n \"email\": \"jsmith@example.com\"\n },\n \"bankReference\": \"TRF-20261011-01\"\n}"
response = http.request(request)
puts response.read_body{
"contractVersion": 1,
"invoiceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcome": "notified",
"notifiedAt": "2023-11-07T05:31:56Z"
}{
"contractVersion": 1,
"code": "CLIENT_NOT_LINKED",
"message": "<string>"
}{
"contractVersion": 1,
"code": "CLIENT_NOT_LINKED",
"message": "<string>"
}{
"contractVersion": 1,
"code": "CLIENT_NOT_LINKED",
"message": "<string>"
}Authorizations
Token de sesión Better Auth para rutas de backoffice; las rutas de portal usan su token propio.
Path Parameters
Id del client de Atlas (24 hex); se resuelve contra Client.atlas_client_id
Example:
"64f1c0ffee0ddba11ce55aa1"
Body
application/json
Versión del contrato; el consumidor acepta la vigente y la anterior
Required range:
x >= 1Example:
1
Show child attributes
Show child attributes
Referencia u operación de la transferencia; opcional
Maximum string length:
100Example:
"TRF-20261011-01"
Response
Versión del contrato; el consumidor acepta la vigente y la anterior
Required range:
x >= 1Example:
1
notified: nota y correo nuevos; alreadyNotified: aviso repetido dentro de la ventana, sin otro correo
Available options:
notified, alreadyNotified