Registrar Nota Fiscal
Registra a emissão de uma nota fiscal para um pagamento específico.
Método POST
Requisição
Dados da requisição
{
"conta_id": "{{conta_id}}",
"token": "{{token}}",
"doc": "{{doc}}",
"data": [
{
// Conjunto de registros de notas emitidas
// de acordo com o formato da nota, documentado abaixo.
}
]
}
Formato do registro da Nota Fiscal
pagamento_id
Id do registro de pagamento
Numérico
SIM
destinatario
Documento de identificação do destinatário
Texto
SIM
emitente
Documento de identificação do emitente
Texto
SIM
tipo
Tipo de nota emitida (E) - Entrada ; (S) - Saída
Texto
SIM
valor
Valor do documento
Double
SIM
número
Número da NFE
Numérico
SIM
série
Número de série da NFE
Numérico
SIM
chave
Chave de identificação da NFE na base da SEFAZ
Texto
SIM
xml
Url para obtenção do XML da NFE ou Arquivo BASE64 com o conteúdo do XML
Texto
NÃO
danfe
Url para obtenção do DANFE da NFE ou Arquivo BASE64 com o conteúdo do DANFE.
Texto
NÃO
mensagem
Mensagem de autorização de uso da NFE
Texto
NÃO
dt_emissao
Data e Hora da Emissão da NFE
Texto (YYYY-MM-DD HH:mm:ss)
SIM
dt_autorizacao
Data da Autorização de Uso da NFE
Texto (YYYY-MM-DD)
SIM
pagamento_id: Deve ser informado o ID de Identificação do pagamento, vinculado à folha de pagamento, que pode ser obtido por meio do método "Baixar Folha" ,documentado nesta API.
XML e Danfe: Devem ser enviados os links (url) para acesso aos arquivos armazenados em servidor próprio, caso a empresa não tenha este recurso, entrar em contato com nossa equipe técnica.
Exemplo de requisição
{
"conta_id": "{{conta_id}}",
"token": "{{token}}",
"doc": "{{doc}}",
"data": [
{
"pagamento_id": "167", // Identificador do registro de pagamento vinculado a folha
"destinatario": "99980339605", // Documento de identificação do destinatário na NFE
"emitente": "99988235000166", // Documento de identificaçào do emissor na NFE
"tipo": "E", // (E) - Entrada ; (S) - Saída
"valor": "6685.03", // Valor do Documento
"numero": "1", // Número da NFE
"serie": "2", // Série da NFE
"chave": "31250155488235000166550020000000011740498179", // Chave de identificação
"xml": "https://milks-space-ny.nyc3.digitaloceanspaces.com/milks-pay/nfe/2554600/2025/01/xml/677e900e0263c2cc3893a4dc.xml",
"danfe": "https://milks-space-ny.nyc3.digitaloceanspaces.com/milks-pay/nfe/2554600/2025/01/pdf/677e900e0263c2cc3893a4dc.pdf",
"mensagem":"Autorizado o uso da NF-e",
"dt_emissao":"2025-01-08 09:00:00",
"dt_autorizacao": "2025-01-08"
}
]
}
Resposta
200: Registros processados
Os registros das notas foram processados pela plataforma Milk's Rota com sucesso.
{
"success": true,
"results": {
"aceitas": 1,
"recusadas": 0,
"erros": []
},
"response.time": 0.615164041519165,
"server.date": "2025-01-21 09:41:51"
}
400: Conta não localizada
O que isso significa? Significa que o ID da conta não foi localizado na Plataforma Milk's.
403: Token inválido
{
"success": false,
"message": "Token inválido",
"data": [],
"monitor.time": 2.14737200737 // Tempo de execução
}
O que isso significa? Significa que o token informado na requisição não corresponde ao token cadastrado para a conta.
Last updated