Skip to main content
GET
/
organizations
/
{organizationId}
/
invoices
/
{invoiceId}
Obter Fatura
curl --request GET \
  --url https://api.example.com/organizations/{organizationId}/invoices/{invoiceId} \
  --header 'Authorization: <authorization>'
{
  "statusCode": 400,
  "message": "Bad Request Error",
  "errors": [{"message": "required", "path": "field"}]
}
Retorna uma fatura pelo ID. 
curl https://api.awsales.io/studio/organizations/ORG_ID/invoices/INVOICE_ID \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Requer permissao invoice:read.

​
Cabecalhos

​
Authorization
string
required
Token bearer.

​
Parametros de Rota

​
organizationId
string
required
O UUID da organizacao.
​
invoiceId
string
required
O UUID da fatura.

​
Resposta

​
invoiceId
string
O UUID da fatura.
​
organizationId
string
O UUID da organizacao.
​
subscriptionId
string
O ID da assinatura.
​
externalRef
string
Referencia externa.
​
type
string
O tipo da fatura.
​
paymentMethod
string
O tipo de metodo de pagamento utilizado.
​
card
object | null
Detalhes do cartao, se o metodo de pagamento for CARD.
​
boleto
object | null
Detalhes do boleto, se o metodo de pagamento for BOLETO.
​
currency
string
O codigo da moeda.
​
totalAmount
integer
Valor total em centavos.
​
discountAmount
integer
Valor do desconto em centavos.
​
payableAmount
integer
Valor a pagar em centavos.
​
discounts
array
Descontos aplicados.
​
lines
array
Itens da fatura.
​
billingThreshold
object | null
Configuracao do limiar de cobranca.
​
status
string
O status da fatura.
​
issuedAt
string
Timestamp de emissao ISO 8601.
​
dueDate
string
Data de vencimento ISO 8601.
​
paidAt
string | null
Timestamp de pagamento ISO 8601.
​
createdAt
string
Timestamp de criacao ISO 8601.
​
updatedAt
string
Timestamp da ultima atualizacao ISO 8601.
{
  "statusCode": 400,
  "message": "Bad Request Error",
  "errors": [{"message": "required", "path": "field"}]
}

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
404organization.not_foundOrganizacao nao encontrada
404invoice.not_foundFatura nao encontrada
500internal_server_errorOcorreu um erro inesperado