Este método é responsável pela criação de novos PisCofinsImpostos
- Endpoint: /api/retaguarda/v2/PisCofinsImpostos
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
Este endpoint recebe uma lista de PisCofins Impostos para que possam ser enviados vários na mesma requisição
| Aviso |
|---|
Para que a baixa do PisCofin Imposto criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 9 = PisCofins7 = Impostos |
| Deck of Cards |
|---|
|
|
| Expandir |
|---|
title | Exemplo de body da requisição[
{
"aliquotaTributo": "string",
|
|
|
"cstPis"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"indiceTributoImpressora": "string",
"loteOrigem": "string",
" |
|
|
aliquotaPiscstCofinsreducaoBaseCalculo": "string",
" |
|
|
aliquotaCofinssimbolo": "string",
"situacao": 0,
"tipo": "string",
"cfop": "string",
"cstcsosn": "string" }
] |
| Column |
|---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observação |
|---|
| AliquotaTributo | string | Aliquota do imposto | Sim |
| | idInquilino | string | Identificador do inquilino | Sim |
| | idProprietario | string | Identificador do proprietário | Sim |
| | idRetaguarda | string | Identificador do imposto na retaguarda | Sim | Tamanho máximo: 100 caracteres | | indiceTributoImpressora | string | Índice do tributo utilizado na impressora | Não | Tamanho máximo: 2 caracteres | | loteOrigem | string | Identificador do lote para envio dos dados | Sim |
| | modalidade | string | Descrição da modalidade | Sim | Tamanho máximo: 20 caracteres | | reducaoBaseCalculo | string | Valor de redução da base de cálculo | Não |
| | simbolo | string | Símbolo do imposto | Sim | Tamaho máximo: 20 caracteres | | situacao | int | Situação do imposto | Sim | 0 - inativo, 1 - ativo | | tipo | string | Tipo do imposto | Sim | | | cfop | string | Código Fiscal de Operações e Prestações | Não | Tamaho máximo: 4 caracteres | | cstcsosn | string | Código de Situação da Operação no Simples Nacional | Não | Tamaho máximo: 3 caracteres |
|
|
Retorno| Deck of Cards |
|---|
| | Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"success": true,
"message": "string",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | | Data | objeto | Objeto compartilhamento criado | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
|
| Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
|
|
|
|
"idRetaguarda "code": "string",
"message": "string",
"detailedMessage": "string"
}
]
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| code | string | Código de erro | | message | string | Mensagem do erro | | detailedMessage | string | Detalhamento do erro | | helpUrl | string | url de ajuda | | TotalTime | string | Tempo total de busca | | details | lista de objeto | Lista de objeto de erros | | details.guid | string | Identificador do erro | | details.code | string | Código do erro | | details.message | string | Mensagem do erro | | details.detailedMessage | string | Detalhamento do erro |
|
|
|
|
| Card |
|---|
| | Informações |
|---|
Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta, não sendo possível realizar a requisição. |
Requisição| Section |
|---|
| Column |
|---|
| Exemplo de body da requisição[
{
"aliquotaTributo": "string",
"cfop": "string",
"cstcsosn": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"modalidade": "string",
"reducaoBaseCalculo": "string",
"simbolo": "string",
"situacao": 0,
"tipo": "string", "cfop": "string",
"cstcsosn": "string"
}
] |
|
|
|
expand | title | Definição | de requisição | Observações | cstPisObrigatório | Observações |
|---|
| aliquotaTributo | numérico | Aliquota do atributo | Sim |
| | cfop | string | Código Fiscal de Operações e de Prestações | Não | Tamanho máximo: 4 caracteres | | cstCsosn | string |
|
|
|
CST do Pis | Opcional| Código de Operação do Simples Nacional | Não | Tamanho máximo: 3 caracteres |
|
|
|
aliquotaPisAliquota do Pis | Opcional | | Tipo do imposto | Sim | | | modalidade | string | Descrição do imposto cadastrada no sistema de retaguarda/ERP | Não |
|
|
|
cstCofins | string | CST Cofins | Opcional 3 aliquotaCofins| indiceTributoImpressora | string |
|
|
|
Aliquota Cofins | | DEFASADO | Não |
| | reducaoBaseCalculo | numérico | Valor de redução da base de cálculo | Não |
|
|
|
Opcional PisCofins ( Inativo Ativo)| ativo | | simbolo | string | Símbolo do imposto | Sim | Tamaha máximo: 20 caracteres |
|
|
|
Obrigatório | | idInquilino | string | Identificador do inquilino |
|
|
|
Obrigatório| Sim |
| | idRetaguarda | string | Identificador do |
|
|
|
PisCofins Obrigatório| Sim |
| | idProprietario | string | Identificador do proprietário |
|
|
|
Obrigatório| Expandir |
|---|
|
| Sim |
| | loteOrigem | string | Identificador do lote para envio dos dados |
|
|
|
Obrigatório para a integração |
|---|
| Expandir |
|---|
| title | Definição dos campos de retorno |
|---|
|
Retornos| Deck of Cards |
|---|
| | Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Column |
|---|
| Definições dos campos do retorno |
|
|
| Campo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | | Data | objeto | Objeto compartilhamento criado | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
|
|
| expand | title | | Column |
|---|
| Exemplo de body de retorno{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| code | string | Código de erro | | message | string | Mensagem do erro | | detailedMessage | string | Detalhamento do erro | | helpUrl | string | url de ajuda | | TotalTime | string | Tempo total de busca | | details | lista de objeto | Lista de objeto de erros | | details.guid | string | Identificador do erro | | details.code | string | Código do erro | | details.message | string | Mensagem do erro | | details.detailedMessage | string | Detalhamento do erro |
|
|
|
|
|
