Criar NFS-e

post

https://api.astongestao.com.br/nfse/

Cria uma nova NFS-e vinculada a uma fatura

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

invoiceId

int64 | null

Fatura de origem (opcional — nota manual pode existir sem fatura)

partnerId

int64

required

Cliente (tomador) da NFS-e — obrigatório. Com fatura o backend o deriva do parceiro da fatura (autoritativo); sem fatura, deve ser um parceiro existente.

nfseNumber

string

rpsNumber

string

value

double

required

externalCode

string | null

\S.*

Código externo opcional (SKU, ERP)

nbs

string

length ≥ 1

issRetained

boolean

required

issPercentage

double

cTribNac

string | null

\d{6}

Código de tributação nacional (cTribNac) — exatamente 6 dígitos numéricos (item + subitem da LC 116/2003 + desdobro nacional)

pisCofinsCst

string | null

0[0-9]|49|5[0-6]|6[0-7]|7[0-5]|98|99

CST de PIS/COFINS — código de 2 dígitos da tabela oficial (00-09, 49-56, 60-67, 70-75, 98, 99)

pisRate

number | null

Alíquota de PIS

cofinsRate

number | null

Alíquota de COFINS

inssRate

number | null

Alíquota de INSS

irRate

number | null

Alíquota de IR

csllRate

number | null

Alíquota de CSLL

cTribMun

string | null

Código de Tributação Municipal

operationNature

string | null

enum

Natureza da operação

issRetentionType

string | null

enum

Tipo de retenção do ISS

Allowed:

issExigibility

string | null

enum

Exigibilidade do ISS

Allowed:

incidenceMunicipalityCode

string | null

Código IBGE do município de incidência do ISS

serviceLocationRule

string | null

enum

Regra de local de prestação do serviço

Allowed:

specialTaxRegime

string | null

enum

Regime especial de tributação

municipalBenefit

string | null

Benefício municipal aplicável ao serviço

inssBase

string | null

enum

Base de cálculo do INSS retido

Allowed:

pisCofinsRetentionType

string | null

Tipo de retenção do PIS/COFINS

simplesAnnexIv

boolean | null

Serviço enquadrado no Anexo IV do Simples Nacional

takerType

string | null

enum

Tomador-alvo do perfil — linha da matriz de retenções prestador×tomador

Allowed:

cstIbsCbs

string | null

CST (Código de Situação Tributária) do IBS/CBS

cClassTrib

string | null

Código de Classificação Tributária — deve iniciar pelos 3 dígitos do cstIbsCbs

cIndOp

string | null

Código Indicador de Operação

ibsCbsRateReduction

number | null

Percentual de redução de alíquota do IBS/CBS — obrigatório quando cstIbsCbs = "200"

finalConsumer

boolean | null

Indica se o tomador é consumidor final

zfmAlc

boolean | null

Operação amparada por alíquota zero da Zona Franca de Manaus

deductions

number | null

Deduções aplicadas ao valor do serviço

unconditionalDiscount

number | null

Desconto incondicional

conditionalDiscount

number | null

Desconto condicional

textNfse

string | null

Texto próprio da NFS-e (opcional e editável). Na nota avulsa o front pode pré-preenchê-lo a partir do modelo de mensagem do perfil fiscal. Usado como base da discriminação do serviço na DPS (variáveis {{...}} resolvidas na transmissão).

accessKey

string | null

Chave de acesso da NFS-e (preencher marca a nota como transmitida — uso para notas emitidas fora do sistema)

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

201Created

400Bad Request