Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Informações
iconfalse
titleGetOne

Máscara de Url: http://{domínio}:{porta}/api/financial/v1/documenttypes/{company}|{code}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Company: 1

Code: 55

Url Utilizada: http://localhost:8051/api/financial/v1/documenttypes/1|55

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "id": "1|55",
    "company": 1,
    "code": "55",
    "description": "AO CONSUMIDOR - DES",
    "payReceiveType": 3,
    "lastNumber": "00000000",
    "mandatorySeller": 0,
    "isDevolution": 0,
    "payable": 1,
    "sequentialDocumentNumber": 0,
    "useGeneralParameters": 1,
    "generatesClearedBankStatement": 0,
    "considerLedger": 1,
    "applyFormula": "F",
    "consistsCustomerVendor": 1,
    "generateDocumentNumber": "2",
    "calculateAvp": 0,
    "budgetBalanceEffects": "N",
    "inactive": 0,
    "considerCashFlow": "1"
}

1.

...

Nota
titleImportante

Recurso disponível a partir da release 12.1.2406.

Informações
iconfalse
titleGetAll/Lookup

Essa rota permite a listagem dos registro de tipo de documento sem exigência de acesso do usuário ao cadastro de tipo de documento, ela deve ser utilizada para consumo em lookups. Os filtros, ordenações e paginações possíveis ao Get All também são possíveis nessa rota.

Máscara de Url: http://{domínio}:{porta}/api/financial/v1/documenttypes/lookup

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/financial/v1/documenttypes/lookup

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": false,
    "items": [
        {
            "id": "1|16",
            "company": 1,
            "code": "16",
            "description": "ADIANTAMENTO"
        },
        {
            "id": "1|9999",
            "company": 1,
            "code": "9999",
            "description": "Crédito de adiantamento"
        }
    ]
}

1.1.8 - GetOne/Lookup (Recuperar tipo de documento pelo identificador para Lookup)

Nota
titleImportante

Recurso disponível a partir da release 12.1.2406.

Informações
titleParâmetros

Nos parâmetros do GetOne/Lookup assim como para o GetOne é necessário passar uma chave composta ("id"), por isso informamos "company" que é o código da coligada do tipo de documento que queremos selecionar e o "code" que é o código do tipo de documento, sendo eles separados pelo caractere "|" pipe.

Informações
iconfalse
titleGetOne/Lookup

Essa rota permite a pesquisa de um registro do tipo de documento sem exigência de acesso do usuário ao cadastro de Tipo de Documento, ela deve ser utilizada para consumo em lookups.

Máscara de Url: http://{domínio}:{porta}/api/financial/v1/documenttypes/lookup/{company}|{code}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Company: 1

Code: 0001

Url Utilizada: http://localhost:8051/api/financial/v1/documenttypes/lookup/1|55

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "id": "1|55",
    "company": 1,
    "code": "55",
    "description": "AO CONSUMIDOR - DES"
}

1.2 - POST

...

1.2.1 - Post (Inserir um tipo de documento)

...