Salvar detalhes de faturamento da organização
curl --request PUT \
--url https://billing.basaltic.sh/v1/profile \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"company_name": "<string>",
"country": "BR",
"tax_id": "<string>",
"foreign_tax_id": "<string>",
"no_tax_id_reason": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"street_name": "<string>",
"street_number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"municipality_code": "3550308",
"state": "<string>",
"postal_code": "<string>"
}
'import requests
url = "https://billing.basaltic.sh/v1/profile"
payload = {
"company_name": "<string>",
"country": "BR",
"tax_id": "<string>",
"foreign_tax_id": "<string>",
"no_tax_id_reason": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"street_name": "<string>",
"street_number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"municipality_code": "3550308",
"state": "<string>",
"postal_code": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
company_name: '<string>',
country: 'BR',
tax_id: '<string>',
foreign_tax_id: '<string>',
no_tax_id_reason: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
street_name: '<string>',
street_number: '<string>',
complement: '<string>',
neighborhood: '<string>',
city: '<string>',
municipality_code: '3550308',
state: '<string>',
postal_code: '<string>'
})
};
fetch('https://billing.basaltic.sh/v1/profile', 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://billing.basaltic.sh/v1/profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'company_name' => '<string>',
'country' => 'BR',
'tax_id' => '<string>',
'foreign_tax_id' => '<string>',
'no_tax_id_reason' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'street_name' => '<string>',
'street_number' => '<string>',
'complement' => '<string>',
'neighborhood' => '<string>',
'city' => '<string>',
'municipality_code' => '3550308',
'state' => '<string>',
'postal_code' => '<string>'
]),
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://billing.basaltic.sh/v1/profile"
payload := strings.NewReader("{\n \"company_name\": \"<string>\",\n \"country\": \"BR\",\n \"tax_id\": \"<string>\",\n \"foreign_tax_id\": \"<string>\",\n \"no_tax_id_reason\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"street_name\": \"<string>\",\n \"street_number\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"municipality_code\": \"3550308\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://billing.basaltic.sh/v1/profile")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"company_name\": \"<string>\",\n \"country\": \"BR\",\n \"tax_id\": \"<string>\",\n \"foreign_tax_id\": \"<string>\",\n \"no_tax_id_reason\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"street_name\": \"<string>\",\n \"street_number\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"municipality_code\": \"3550308\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://billing.basaltic.sh/v1/profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"company_name\": \"<string>\",\n \"country\": \"BR\",\n \"tax_id\": \"<string>\",\n \"foreign_tax_id\": \"<string>\",\n \"no_tax_id_reason\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"street_name\": \"<string>\",\n \"street_number\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"municipality_code\": \"3550308\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"customer_type": "",
"company_name": "<string>",
"country": "BR",
"tax_id": "<string>",
"foreign_tax_id": "<string>",
"no_tax_id_reason": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"street_name": "<string>",
"street_number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"municipality_code": "3550308",
"state": "<string>",
"postal_code": "<string>",
"ready": true,
"missing_fields": [
"<string>"
]
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Perfil
Salvar detalhes de faturamento da organização
Substitui os detalhes de faturamento para futuros documentos fiscais. Os documentos preparados ou emitidos existentes mantêm o instantâneo do destinatário. Um perfil completo termina a etapa de integração de detalhes de faturamento e permite que os fluxos de trabalho fiscais em espera prossigam.
PUT
/
v1
/
profile
Salvar detalhes de faturamento da organização
curl --request PUT \
--url https://billing.basaltic.sh/v1/profile \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"company_name": "<string>",
"country": "BR",
"tax_id": "<string>",
"foreign_tax_id": "<string>",
"no_tax_id_reason": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"street_name": "<string>",
"street_number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"municipality_code": "3550308",
"state": "<string>",
"postal_code": "<string>"
}
'import requests
url = "https://billing.basaltic.sh/v1/profile"
payload = {
"company_name": "<string>",
"country": "BR",
"tax_id": "<string>",
"foreign_tax_id": "<string>",
"no_tax_id_reason": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"street_name": "<string>",
"street_number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"municipality_code": "3550308",
"state": "<string>",
"postal_code": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
company_name: '<string>',
country: 'BR',
tax_id: '<string>',
foreign_tax_id: '<string>',
no_tax_id_reason: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
street_name: '<string>',
street_number: '<string>',
complement: '<string>',
neighborhood: '<string>',
city: '<string>',
municipality_code: '3550308',
state: '<string>',
postal_code: '<string>'
})
};
fetch('https://billing.basaltic.sh/v1/profile', 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://billing.basaltic.sh/v1/profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'company_name' => '<string>',
'country' => 'BR',
'tax_id' => '<string>',
'foreign_tax_id' => '<string>',
'no_tax_id_reason' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'street_name' => '<string>',
'street_number' => '<string>',
'complement' => '<string>',
'neighborhood' => '<string>',
'city' => '<string>',
'municipality_code' => '3550308',
'state' => '<string>',
'postal_code' => '<string>'
]),
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://billing.basaltic.sh/v1/profile"
payload := strings.NewReader("{\n \"company_name\": \"<string>\",\n \"country\": \"BR\",\n \"tax_id\": \"<string>\",\n \"foreign_tax_id\": \"<string>\",\n \"no_tax_id_reason\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"street_name\": \"<string>\",\n \"street_number\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"municipality_code\": \"3550308\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://billing.basaltic.sh/v1/profile")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"company_name\": \"<string>\",\n \"country\": \"BR\",\n \"tax_id\": \"<string>\",\n \"foreign_tax_id\": \"<string>\",\n \"no_tax_id_reason\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"street_name\": \"<string>\",\n \"street_number\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"municipality_code\": \"3550308\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://billing.basaltic.sh/v1/profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"company_name\": \"<string>\",\n \"country\": \"BR\",\n \"tax_id\": \"<string>\",\n \"foreign_tax_id\": \"<string>\",\n \"no_tax_id_reason\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"street_name\": \"<string>\",\n \"street_number\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"municipality_code\": \"3550308\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"customer_type": "",
"company_name": "<string>",
"country": "BR",
"tax_id": "<string>",
"foreign_tax_id": "<string>",
"no_tax_id_reason": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"street_name": "<string>",
"street_number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"municipality_code": "3550308",
"state": "<string>",
"postal_code": "<string>",
"ready": true,
"missing_fields": [
"<string>"
]
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Requer a ação do IAM
billing:UpdateBillingProfile. Consulte permissões de faturamento para obter a lista completa, o que cada uma cobre e um exemplo de política.Autorizações
Um token bearer OAuth 2.0, enviado como Authorization: Bearer <token>. Esta é a forma recomendada de autenticação.
Obtenha o token trocando o par de chaves de acesso de uma conta de serviço em POST /v1/oauth/token com grant_type=client_credentials. Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis com OAuth podem obter e renovar o token para você.
curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
https://iam.basaltic.sh/v1/oauth/token
Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso também serve como credencial AWS SigV4 para o endpoint de objetos compatível com S3, que aceita somente esse método de autenticação.
Corpo
application/json
Destinatário de faturamento da organização. Os rascunhos incompletos são salvos; pronto se torna verdadeiro somente depois que todos os campos específicos do país são válidos. A nova integração é concluída após essa etapa.
Opções disponíveis:
individual, company Nome legal completo do indivíduo ou empresa.
Maximum string length:
75Códigos de país ISO 3166-1 alpha-2.
Required string length:
2Exemplo:
"BR"
CPF para um indivíduo brasileiro ou CNPJ para uma empresa brasileira. Os dígitos de verificação são validados.
Identificador estrangeiro; não validado como documento brasileiro.
Maximum string length:
50Necessário para um destinatário estrangeiro sem identificação fiscal.
Maximum string length:
100E-mail de cobrança para entrega de fatura fiscal. O formulário de integração pré-preenche isso a partir do e-mail do usuário conectado.
Maximum string length:
75Maximum string length:
50Maximum string length:
50Maximum string length:
10Maximum string length:
30Maximum string length:
30Maximum string length:
100Código de município de sete dígitos do IBGE, necessário para um beneficiário brasileiro.
Exemplo:
"3550308"
UF de duas letras para o Brasil; estado/província de forma livre no exterior.
Maximum string length:
100CEP de oito dígitos para o Brasil; código postal internacional opcional no exterior.
Maximum string length:
20Resposta
Detalhes salvos, prontidão e campos ausentes.
Destinatário de faturamento da organização. Os rascunhos incompletos são salvos; pronto se torna verdadeiro somente depois que todos os campos específicos do país são válidos. A nova integração é concluída após essa etapa.
Opções disponíveis:
individual, company Nome legal completo do indivíduo ou empresa.
Maximum string length:
75Códigos de país ISO 3166-1 alpha-2.
Required string length:
2Exemplo:
"BR"
CPF para um indivíduo brasileiro ou CNPJ para uma empresa brasileira. Os dígitos de verificação são validados.
Identificador estrangeiro; não validado como documento brasileiro.
Maximum string length:
50Necessário para um destinatário estrangeiro sem identificação fiscal.
Maximum string length:
100E-mail de cobrança para entrega de fatura fiscal. O formulário de integração pré-preenche isso a partir do e-mail do usuário conectado.
Maximum string length:
75Maximum string length:
50Maximum string length:
50Maximum string length:
10Maximum string length:
30Maximum string length:
30Maximum string length:
100Código de município de sete dígitos do IBGE, necessário para um beneficiário brasileiro.
Exemplo:
"3550308"
UF de duas letras para o Brasil; estado/província de forma livre no exterior.
Maximum string length:
100CEP de oito dígitos para o Brasil; código postal internacional opcional no exterior.
Maximum string length:
20