API Destinatário

Cadastro de Destinatário

Disponibilizado endpoint para cadastro de Destinatário.

Método POST:

http:127.0.0.1:8080/api/entity/v1/destinatario

Estrutura de dados:

Destinatário

{
    "instancia": "ALBER",
    "cdDestinat": 99,
    "deDestinat": "TESTE DESTINATARIO",
    "cdIntErp": null,
    "deEndereco": null,
    "cdMunic": 32,
    "noCep": "14.025-140",
    "noTelefone": "9999-9999",
    "fgTpPess": "J",
    "noCgcCpf": "71.320.857/0001-37",
    "noInscrEst": "664.003.070.110",
    "cdTpTabela": 15,
    "fgTpDestinat": null,
    "rowVersion": 99999
}

Destinatário

instancia: Código da Instância.
cdDestinat: Código do Destinatário.
deDestinat: Descrição da Destinatário.
cdIntErp: Código Interface ERP.
deEndereco: Endereço.
cdMunic: Código do Município.
noCep: CEP.
noTelefone: Número Telefone.
fgTpPess: Tipo de Pessoa.
noCgcCpf: Número CNPJ / CPF.
noInscrEst: Número Inscrição Estadual.
cdTpTabela: Tipo de Tabela de Correção.
fgTpDestinat: Flag para indicar Tipo de Destinatário (P - Próprio, T - Terceiro).
rowVersion: Controle interno.

Exemplo de retorno após cadastrar:

Response (200 OK)

{
    "instancia": "ALBER",
    "cdDestinat": 99,
    "deDestinat": "TESTE DESTINATARIO",
    "cdIntErp": null,
    "deEndereco": null,
    "cdMunic": 32,
    "noCep": "14.025-140",
    "noTelefone": "9999-9999",
    "fgTpPess": "J",
    "noCgcCpf": "71.320.857/0001-37",
    "noInscrEst": "664.003.070.110",
    "cdTpTabela": null,
    "fgTpDestinat": "P",
    "rowVersion": 99999
}

Consulta de Destinatários

Disponibilizado endpoint para consulta de Destinatário.

Método GET:

http:127.0.0.1:8080/api/entity/v1/destinatario?instancia=ALBER&cdDestinat=99&page=1&pageSize=15

Response (200 OK)

{
    "hasNext": false,
    "items": [
        {
            "instancia": "ALBER",
            "cdDestinat": 99,
            "deDestinat": "TESTE DESTINATARIO",
            "cdIntErp": null,
            "deEndereco": null,
            "cdMunic": 32,
            "noCep": "14.025-140",
            "noTelefone": "9999-9999",
            "fgTpPess": "J",
            "noCgcCpf": "71.320.857/0001-37",
            "noInscrEst": "664.003.070.110",
            "cdTpTabela": null,
            "fgTpDestinat": "P",
            "rowVersion": 99999
        }
    ]
}

Parâmetros (opcionais)

instancia: Código da Instância.
cdDestinat: Código do Destinatário.
page: Número da página.
pagesize: Quantidade de registros por página.

Alteração de Destinatário

Disponibilizado endpoint para modificar Destinatário.

Método PUT:

http:127.0.0.1:8080/api/entity/v1/destinatario

Estrutura de dados:

Destinatário

{
    "instancia": "ALBER",
    "cdDestinat": 99,
    "deDestinat": "UPDATE DESTINATARIO",
    "cdIntErp": null,
    "deEndereco": null,
    "cdMunic": 1,
    "noCep": "14.025-140",
    "noTelefone": "9999-9911",
    "fgTpPess": "F",
    "noCgcCpf": "422.880.478-01",
    "noInscrEst": "664.003.070.110",
    "cdTpTabela": null,
    "fgTpDestinat": null,
    "rowVersion": 9999
}

Exclusão de Destinatário

Disponibilizado endpoint para excluir Destinatário.

Método DELETE:

http:127.0.0.1:8080/api/entity/v1/destinatario?cdDestinat=99&instancia=ALBER

Parâmetros

instancia: Código da Instância
cdDestinat: Código do Destinatário.

Retorno: 204 No Content.

Páginas filhas