Asaas Notas fiscais API
The Notas fiscais API from Asaas — 4 operation(s) for notas fiscais.
The Notas fiscais API from Asaas — 4 operation(s) for notas fiscais.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/asaas:asaas-notas-fiscais-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Asaas Notas fiscais API
description: API pública de integração com a plataforma Asaas.
version: 3.0.0
servers:
- url: https://api-sandbox.asaas.com
description: Sandbox
security:
- Authorization: []
tags:
- name: Notas fiscais
paths:
/v3/invoices:
post:
tags:
- Notas fiscais
summary: Agendar nota fiscal
description: ''
operationId: agendar-nota-fiscal
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceSaveRequestDTO'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceGetResponseDTO'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseDTO'
example:
errors:
- code: error_code
description: Descrição do erro
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseDTO'
example:
errors:
- code: invalid_access_token
description: A chave de API fornecida é inválida
deprecated: false
get:
tags:
- Notas fiscais
summary: Listar notas fiscais
description: ''
operationId: listar-notas-fiscais
parameters:
- name: offset
in: query
description: Elemento inicial da lista
schema:
type: integer
example: 0
- name: limit
in: query
description: 'Número de elementos da lista (max: 100)'
schema:
maximum: 100
type: integer
example: 10
- name: effectiveDate[Ge]
in: query
description: Filtrar a partir de uma data de emissão
schema:
type: string
example: '2024-08-03'
- name: effectiveDate[Le]
in: query
description: Filtrar até uma data de emissão
schema:
type: string
example: '2024-09-03'
- name: payment
in: query
description: Filtrar pelo identificador único da cobrança
schema:
type: string
example: null
- name: installment
in: query
description: Filtrar pelo identificador único do parcelamento
schema:
type: string
example: null
- name: externalReference
in: query
description: Filtrar pelo identificador da nota fiscal no seu sistema
schema:
type: string
example: null
- name: status
in: query
description: Filtrar por situação
schema:
$ref: '#/components/schemas/InvoiceListRequestInvoiceStatus'
- name: customer
in: query
description: Filtrar pelo identificador único do cliente
schema:
type: string
example: null
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceListResponseDTO'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseDTO'
example:
errors:
- code: error_code
description: Descrição do erro
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseDTO'
example:
errors:
- code: invalid_access_token
description: A chave de API fornecida é inválida
'403':
description: Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio.
deprecated: false
/v3/invoices/{id}:
put:
tags:
- Notas fiscais
summary: Atualizar nota fiscal
description: ''
operationId: atualizar-nota-fiscal
parameters:
- name: id
in: path
description: Identificador único da nota fiscal no Asaas
required: true
schema:
type: string
example: inv_000000000232
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceUpdateRequestDTO'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceGetResponseDTO'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseDTO'
example:
errors:
- code: error_code
description: Descrição do erro
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseDTO'
example:
errors:
- code: invalid_access_token
description: A chave de API fornecida é inválida
'404':
description: Not found
deprecated: false
get:
tags:
- Notas fiscais
summary: Recuperar uma única nota fiscal
description: ''
operationId: recuperar-uma-nota-fiscal
parameters:
- name: id
in: path
description: Identificador único da nota fiscal no Asaas
required: true
schema:
type: string
example: inv_000000000232
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceGetResponseDTO'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseDTO'
example:
errors:
- code: error_code
description: Descrição do erro
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseDTO'
example:
errors:
- code: invalid_access_token
description: A chave de API fornecida é inválida
'403':
description: Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio.
'404':
description: Not found
deprecated: false
/v3/invoices/{id}/authorize:
post:
tags:
- Notas fiscais
summary: Emitir uma nota fiscal
description: ''
operationId: emitir-uma-nota-fiscal
parameters:
- name: id
in: path
description: Identificador único da nota fiscal no Asaas
required: true
schema:
type: string
example: inv_000000000232
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InvoicePathIdRequestDTO'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceGetResponseDTO'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseDTO'
example:
errors:
- code: error_code
description: Descrição do erro
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseDTO'
example:
errors:
- code: invalid_access_token
description: A chave de API fornecida é inválida
'404':
description: Not found
deprecated: false
/v3/invoices/{id}/cancel:
post:
tags:
- Notas fiscais
summary: Cancelar uma nota fiscal
description: ''
operationId: cancelar-uma-nota-fiscal
parameters:
- name: id
in: path
description: Identificador único da nota fiscal no Asaas
required: true
schema:
type: string
example: inv_000000000232
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceCancelRequestDTO'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceGetResponseDTO'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseDTO'
example:
errors:
- code: error_code
description: Descrição do erro
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseDTO'
example:
errors:
- code: invalid_access_token
description: A chave de API fornecida é inválida
'404':
description: Not found
deprecated: false
components:
schemas:
InvoiceTaxesResponseDTO:
required:
- retainIss
- iss
- pis
- cofins
- csll
- inss
- ir
type: object
properties:
nbsCode:
type: string
description: Código NBS (Nomenclatura Brasileira de Serviços)
example: '01.01'
deprecated: false
taxSituationCode:
type: string
description: Código de situação tributária
example: '011'
deprecated: false
taxClassificationCode:
type: string
description: Código de classificação tributária
example: '011001'
deprecated: false
operationIndicatorCode:
type: string
description: Código do indicador de operação
example: '020101'
deprecated: false
retainIss:
type: boolean
description: Tomador da nota fiscal deve reter ISS ou não
example: true
deprecated: false
iss:
type: number
description: Alíquota ISS
example: 2
deprecated: false
pisCofinsRetentionType:
type: string
description: Tipo de retenção de PIS/COFINS. Não envie este campo na requisição; ele é calculado automaticamente pelo Asaas com base nas alíquotas de PIS, COFINS e CSLL. Utilize o valor retornado na resposta para fins de conciliação
example: NOT_WITHHELD
deprecated: false
pisCofinsTaxStatus:
type: string
description: Situação tributária do PIS/COFINS
example: STANDARD_TAXABLE_OPERATION
deprecated: false
operationPis:
type: number
description: Alíquota de PIS de operação (apuração própria do contribuinte)
example: 0.65
deprecated: false
operationCofins:
type: number
description: Alíquota de COFINS de operação (apuração própria do contribuinte)
example: 3
deprecated: false
pis:
type: number
description: Alíquota PIS
example: 0.65
deprecated: false
cofins:
type: number
description: Alíquota COFINS
example: 3
deprecated: false
csll:
type: number
description: Alíquota CSLL
example: 9
deprecated: false
inss:
type: number
description: Alíquota INSS
example: 11
deprecated: false
ir:
type: number
description: Alíquota IR
example: 1.5
deprecated: false
stateIbs:
type: number
description: Alíquota estadual IBS
example: 0.1
deprecated: false
stateIbsValue:
type: number
description: Valor estadual IBS
example: 0.3
deprecated: false
municipalIbs:
type: number
description: Alíquota municipal IBS
example: 0
deprecated: false
municipalIbsValue:
type: number
description: Valor municipal IBS
example: 0
deprecated: false
cbs:
type: number
description: Alíquota CBS
example: 0.9
deprecated: false
cbsValue:
type: number
description: Valor CBS
example: 2.7
deprecated: false
operationTypeCode:
type: integer
description: Código do tipo de operação da reforma tributária. Obrigatório para notas de serviços de locação, cessão ou usufruto de bens imóveis
format: int32
example: '2'
deprecated: false
referencedInvoiceAccessKeyList:
type: array
description: Lista de chaves de acesso das NFS-e referenciadas por esta nota, exigida para determinados tipos de operação
deprecated: false
items:
type: string
description: Lista de chaves de acesso das NFS-e referenciadas por esta nota, exigida para determinados tipos de operação
deprecated: false
example: null
realEstateInfo:
$ref: '#/components/schemas/InvoiceRealEstateInfoResponseDTO'
description: Impostos da nota fiscal
deprecated: false
InvoiceGetResponseInvoiceStatus:
type: string
description: Status da nota fiscal
example: SCHEDULED
deprecated: false
enum:
- SCHEDULED
- AUTHORIZED
- PROCESSING_CANCELLATION
- CANCELED
- CANCELLATION_DENIED
- ERROR
InvoiceRealEstateInfoResponseDTO:
type: object
properties:
fiscalPropertyRegistration:
type: string
description: Inscrição fiscal do imóvel na prefeitura
example: '333'
deprecated: false
cibCode:
type: string
description: Código de Identificação do imóvel na Receita Federal (CIB)
example: '34567890'
deprecated: false
city:
type: integer
description: Identificador da cidade do imóvel no Asaas. Quando não informado, a cidade é resolvida a partir do postalCode
format: int64
example: 13660
deprecated: false
address:
type: string
description: Logradouro do imóvel
example: Rua das Acácias
deprecated: false
addressNumber:
type: string
description: Número do imóvel
example: '100'
deprecated: false
complement:
type: string
description: Complemento do endereço do imóvel
example: Bloco A
deprecated: false
province:
type: string
description: Bairro do imóvel
example: Centro
deprecated: false
postalCode:
type: string
description: CEP do imóvel
example: '89201002'
deprecated: false
description: Informações do imóvel, exigidas quando o indicador de operação corresponde a uma operação de locação, cessão ou usufruto de bem imóvel
deprecated: false
InvoiceRealEstateInfoRequestDTO:
required:
- cibCode
- address
- addressNumber
- province
- postalCode
type: object
properties:
fiscalPropertyRegistration:
type: string
description: Inscrição fiscal do imóvel na prefeitura
example: '333'
deprecated: false
cibCode:
type: string
description: Código de Identificação do imóvel na Receita Federal (CIB)
example: '34567890'
deprecated: false
city:
type: integer
description: Identificador da cidade do imóvel no Asaas. Quando não informado, a cidade é resolvida a partir do postalCode
format: int64
example: 13660
deprecated: false
address:
type: string
description: Logradouro do imóvel
example: Rua das Acácias
deprecated: false
addressNumber:
type: string
description: Número do imóvel
example: '100'
deprecated: false
complement:
type: string
description: Complemento do endereço do imóvel
example: Bloco A
deprecated: false
province:
type: string
description: Bairro do imóvel
example: Centro
deprecated: false
postalCode:
type: string
description: CEP do imóvel
example: '89201002'
deprecated: false
description: Informações do imóvel, exigidas quando o indicador de operação corresponde a uma operação de locação, cessão ou usufruto de bem imóvel
deprecated: false
ErrorResponseItemDTO:
type: object
properties:
code:
type: string
description: Código do erro
deprecated: false
example: null
description:
type: string
description: Descrição do erro
deprecated: false
example: null
description: Lista de objetos
deprecated: false
InvoiceUpdateRequestDTO:
type: object
properties:
serviceDescription:
type: string
description: Descrição dos serviços da nota fiscal
deprecated: false
example: null
observations:
type: string
description: Observações adicionais
example: Mensal referente aos trabalhos de Junho.
deprecated: false
externalReference:
type: string
description: Identificador da nota fiscal no seu sistema
deprecated: false
example: null
value:
type: number
description: Valor total
example: 300
deprecated: false
deductions:
type: number
description: Deduções. As deduções não alteram o valor total da nota fiscal, mas alteram a base de cálculo do ISS
example: 10
deprecated: false
effectiveDate:
type: string
description: Data de emissão da nota fiscal
format: date
example: '2024-08-20'
deprecated: false
updatePayment:
type: boolean
description: Atualizar o valor da cobrança com os impostos da nota já descontados.
deprecated: false
example: null
taxes:
$ref: '#/components/schemas/InvoiceTaxesRequestDTO'
InvoiceCancelRequestDTO:
type: object
properties:
cancelOnlyOnAsaas:
type: boolean
description: Cancelar nota fiscal somente no Asaas
deprecated: false
example: null
InvoiceGetResponseDTO:
type: object
properties:
object:
type: string
description: Tipo de objeto
example: invoice
deprecated: false
id:
type: string
description: Identificador único da nota fiscal no Asaas
example: inv_000000000232
deprecated: false
status:
$ref: '#/components/schemas/InvoiceGetResponseInvoiceStatus'
customer:
type: string
description: Identificador único do cliente no Asaas
example: cus_000000002750
deprecated: false
payment:
type: string
description: Identificador único da cobrança no Asaas
example: pay_145059895800
deprecated: false
installment:
type: string
description: Identificador único do parcelamento no Asaas
deprecated: false
example: null
type:
type: string
description: Tipo de nota fiscal
example: NFS-e
deprecated: false
enum:
- NFS-e
statusDescription:
type: string
description: Descrição da situação atual da nota fiscal
deprecated: false
example: null
serviceDescription:
type: string
description: Descrição dos serviços da nota fiscal
example: "Nota fiscal da Fatura 101940. \nDescrição dos Serviços: ANÁLISE E DESENVOLVIMENTO DE SISTEMAS"
deprecated: false
pdfUrl:
type: string
description: Link para arquivo pdf da nota fiscal emitida
deprecated: false
example: null
xmlUrl:
type: string
description: Link para arquivo xml da nota fiscal emitida
deprecated: false
example: null
rpsSerie:
type: string
description: Série da nota fiscal
deprecated: false
example: null
rpsNumber:
type: string
description: RPS convertido para a nota fiscal
deprecated: false
example: null
number:
type: string
description: Número da nota fiscal
deprecated: false
example: null
validationCode:
type: string
description: Código de verificação
deprecated: false
example: null
value:
type: number
description: Valor total
example: 300
deprecated: false
deductions:
type: number
description: Deduções. As deduções não alteram o valor total da nota fiscal, mas alteram a base de cálculo do ISS
example: 10
deprecated: false
effectiveDate:
type: string
description: Data de emissão da nota fiscal
format: date
example: '2024-08-15'
deprecated: false
observations:
type: string
description: Observações adicionais
example: Mensal referente aos trabalhos de Junho.
deprecated: false
estimatedTaxesDescription:
type: string
description: Impostos estimados da nota fiscal
deprecated: false
example: null
externalReference:
type: string
description: Identificador da nota fiscal no seu sistema
deprecated: false
example: null
taxes:
$ref: '#/components/schemas/InvoiceTaxesResponseDTO'
municipalServiceId:
type: string
description: Identificador único do serviço municipal
deprecated: false
example: null
municipalServiceCode:
type: string
description: Código de serviço municipal
example: '1.01'
deprecated: false
municipalServiceName:
type: string
description: Nome do serviço municipal
example: Análise e desenvolvimento de sistemas
deprecated: false
InvoiceTaxesRequestDTO:
required:
- retainIss
- iss
- pis
- cofins
- csll
- inss
- ir
type: object
properties:
nbsCode:
type: string
description: Código NBS (Nomenclatura Brasileira de Serviços)
example: '01.01'
deprecated: false
taxSituationCode:
type: string
description: Código de situação tributária
example: '011'
deprecated: false
taxClassificationCode:
type: string
description: Código de classificação tributária
example: '011001'
deprecated: false
operationIndicatorCode:
type: string
description: Código do indicador de operação
example: '020101'
deprecated: false
retainIss:
type: boolean
description: Tomador da nota fiscal deve reter ISS ou não
example: true
deprecated: false
iss:
type: number
description: Alíquota ISS
example: 2
deprecated: false
pisCofinsRetentionType:
type: string
description: Tipo de retenção de PIS/COFINS. Não envie este campo na requisição; ele é calculado automaticamente pelo Asaas com base nas alíquotas de PIS, COFINS e CSLL. Utilize o valor retornado na resposta para fins de conciliação
example: NOT_WITHHELD
deprecated: true
pisCofinsTaxStatus:
type: string
description: Situação tributária do PIS/COFINS
example: STANDARD_TAXABLE_OPERATION
deprecated: false
operationPis:
type: number
description: Alíquota de PIS de operação (apuração própria do contribuinte)
example: 0.65
deprecated: false
operationCofins:
type: number
description: Alíquota de COFINS de operação (apuração própria do contribuinte)
example: 3
deprecated: false
pis:
type: number
description: Alíquota PIS
example: 0.65
deprecated: false
cofins:
type: number
description: Alíquota COFINS
example: 3
deprecated: false
csll:
type: number
description: Alíquota CSLL
example: 9
deprecated: false
inss:
type: number
description: Alíquota INSS
example: 11
deprecated: false
ir:
type: number
description: Alíquota IR
example: 1.5
deprecated: false
operationTypeCode:
type: integer
description: Código do tipo de operação da reforma tributária. Obrigatório para notas de serviços de locação, cessão ou usufruto de bens imóveis
format: int32
example: '2'
deprecated: false
referencedInvoiceAccessKeyList:
type: array
description: Lista de chaves de acesso das NFS-e referenciadas por esta nota, exigida para determinados tipos de operação
deprecated: false
items:
type: string
description: Lista de chaves de acesso das NFS-e referenciadas por esta nota, exigida para determinados tipos de operação
deprecated: false
example: null
realEstateInfo:
$ref: '#/components/schemas/InvoiceRealEstateInfoRequestDTO'
description: Impostos da nota fiscal
deprecated: false
InvoiceListRequestInvoiceStatus:
type: string
description: Filtrar por situação
example: SCHEDULED
deprecated: false
enum:
- SCHEDULED
- AUTHORIZED
- PROCESSING_CANCELLATION
- CANCELED
- CANCELLATION_DENIED
- ERROR
InvoiceSaveRequestDTO:
required:
- serviceDescription
- observations
- value
- deductions
- effectiveDate
- municipalServiceName
- taxes
type: object
properties:
payment:
type: string
description: Identificador único da cobrança no Asaas
example: pay_637959110194
deprecated: false
installment:
type: string
description: Identificador único do parcelamento no Asaas
deprecated: false
example: null
customer:
type: string
description: Identificador único do cliente no Asaas
example: cus_000000002750
deprecated: false
serviceDescription:
type: string
description: Descrição dos serviços da nota fiscal
deprecated: false
example: null
observations:
type: string
description: Observações adicionais
example: Mensal referente aos trabalhos de Junho.
deprecated: false
externalReference:
type: string
description: Identificador da nota fiscal no seu sistema
deprecated: false
example: null
value:
type: number
description: Valor total
example: 300
deprecated: false
deductions:
type: number
description: Deduções. As deduções não alteram o valor total da nota fiscal, mas alteram a base de cálculo do ISS
example: 10
deprecated: false
effectiveDate:
type: string
description: Data de emissão da nota fiscal
format: date
example: '2024-08-20'
deprecated: false
municipalServiceId:
type: string
description: Identificador único do serviço municipal
deprecated: false
example: null
municipalServiceCode:
type: string
description: Código de serviço municipal
example: '1.01'
deprecated: false
municipalServiceName:
type: string
description: Nome do serviço municipal. Se não for informado, será utilizado o atributo municipalServiceCode como nome para identificação.
example: Análise e desenvolvimento de sistemas
deprecated: false
updatePayment:
type: boolean
description: Atualizar o valor da cobrança com os impostos da nota já descontados.
deprecated: false
example: null
taxes:
$ref: '#/components/schemas/InvoiceTaxesRequestDTO'
InvoicePathIdRequestDTO:
type: object
properties: {}
ErrorResponseDTO:
type: object
properties:
errors:
type: array
description: Lista de objetos
deprecated: false
items:
$ref: '#/components/schemas/ErrorResponseItemDTO'
InvoiceListResponseDTO:
type: object
properties:
object:
type: string
description: Tipo de objeto
example: list
deprecated: false
hasMore:
type: boolean
description: Indica se há mais uma página a ser buscada
example: false
deprecated: false
totalCount:
type: integer
description: Quantidade total de itens para os filtros informados
format: int32
example: 2
deprecated: false
limit:
type: integer
description: Quantidade de objetos por página
format: int32
example: 10
deprecated: false
offset:
type: integer
description: Posição do objeto a partir do qual a página deve ser carregada
format: int32
example: 0
deprecated: false
data:
type: array
description: Lista de objetos
deprecated: false
items:
$ref: '#/components/schemas/InvoiceGetResponseDTO'
securitySchemes:
Authorization:
type: apiKey
name: access_token
in: header
x-provenance:
method: searched
source: https://docs.asaas.com/reference
harvested: '2026-10-14'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://docs.asaas.com/reference/add-an-image-to-a-payments-link.md
# --- truncated at 32 KB (61 KB total) ---
# Full source: https://artifacts.apis.io/asaas/openapi/asaas-notas-fiscais-api-openapi.yml