Versões comparadas

Chave

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

...

Informações
iconfalse
titleGetOne

Nessa requisição serão retornadas as listagens das matrizes aplicadas, dos períodos letivos e das filiais dos períodos letivos da tabela de preços

Máscara de Url: http://{domínio}:{porta}/api/educational/financial/v1/pricetable/{internalId}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

internalId: 1|1|3

Url Utilizada: http://localhost:8051/api/educational/financial/v1/pricetable/1|1|3

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
	"companyCode": 1,
	"levelEducationCode": 1,
	"id": 3,
	"internalId": "1|1|3",
	"code": "00001",
	"name": "Tabela de Precos Um",
	"recCreatedOn": "2025-02-04T11:01:30.617-03:00",
	"active": false,
	"priceTableInUse": false,
	"appliedMatrixes": [
		{
			"companyCode": 1,
			"branchCode": 1,
			"levelEducationCode": 1,
			"appliedMatrixCode": 132,
			"priceTableCode": 3,
			"branchName": "Filial Belo Horizonte - Fantasia",
			"courseCode": "1-1",
			"courseName": "Curso Tabela de Preços",
			"curriculumGridCode": "1",
			"curriculumGridName": "Matriz Tabela de Preços",
			"majorCode": "1",
			"majorName": "Habilitação  Tabela de Preços",
			"classShiftCode": 11,
			"classShiftName": "INTEGRAL",
			"status": 0,
			"actionState": 0
		}
	],
	"terms": [],
	"termBranches": [
		{
			"branchCode": 1
		}
	]
}


1.2 - POST

...

1.2.1 - Post (Inserir uma

...

Tabela de preços)

...

Informações
iconfalse
titlePost

A inclusão de uma nova tabela de preços será feita contendo os seus dados e os dados das matrizes aplicadas vinculadas à tabela de preços. Não sendo possível inserir a tabela de preços com suas matrizes aplicadas com usas disciplinas e os períodos letivos de ingresso dessa tabela de preço. Essas informações serão inseridas em outras api's com essa responsabilidades.

Máscara de Url: http://{domínio}:{porta}/api/educational/financial/v1/prospection/prospectionspricetable

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/educational/financial/v1/prospection/prospectionspricetable

Informações
iconfalse
titleExemplo de Entrada
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "description	"companyCode": "Nova prospecção 2024",
    "prospects": [
        {
            "prospectName": "1",
            "prospectType": "A",
            "candidateUserCode": 198,
            "companyCode1,
	"levelEducationCode": 1,
	"code": "00005",
	"name": "Tabela de Precos via Postman",
	"active": false,
	"priceTableInUse": false,
	"appliedMatrixes": []
}
ou 
{
	"companyCode": 1,
	"levelEducationCode": 1,
	"code": "00005",
	"name": "Tabela de Precos        "studentCodevia Postman",
	"active": "ES-00219",
            "prospectPaymentPlansfalse,
	"priceTableInUse": false,
	"appliedMatrixes": [
                {
                    		{
			"companyCode": 1,
                    "termCode": 32,
                    "termCodeDescription": "2023/1",
                    "paymentPlanCode": "2.0",
                    "levelEducationCode": 1,
                    "paymentPlanName": "Plano 2",
                    "branchCode": 1
                }
            ],
            "prospectScholarShips": [
                {                    
                    "companyCode": 1,
                    "scholarShipCode": "1",
                    "scholarShipName": "FUNCIONÁRIO DA ESCOLA",
                    "levelEducationCode": 1,
                    "serviceCode": "1",
                    "serviceName": "MENSALIDADE",
                    "termCode": 32,
                    "termCodeDescription": "2023/1",
                    "discountType": "P",
                    "discountValue": 25.1234,
                    "startDate": "2023-01-01T00:00:00-03:00",
                    "endDate": "2023-12-31T00:00:00-03:00",
                    "validityType": "T",
                    "branchCode": 1
                }
            ]
        },
        {
            "prospectName": "2",
            "prospectType": "C",
            "candidateUserCode": 212,
            "companyCode": 1,
            "prospectPaymentPlans": [
                {
                    "companyCode": 1,
                    "termCode": 32,
                    "termCodeDescription": "2023/1",
                    "paymentPlanCode": "2023/PS",
                    "levelEducationCode": 1,
                    "paymentPlanName": "2023 Processo seletivo teste",
                    "branchCode": 1
                }
            ],
            "prospectScholarShips": []
        },
        {
            "prospectName": "AAAA sss",
            "prospectType": "P",
            "individualRegistrationCode": "45657746589",
            "prospectPaymentPlans": [
                {
                    "companyCode": 1,
                    "termCode": 28,
                    "termCodeDescription": "2021",
                    "paymentPlanCode": "10112690",
                    "levelEducationCode": 2,
                    "paymentPlanName": "Plano 1 - Padrão 11 parcelas",
                    "branchCode": 1
                }
            ],
            "prospectScholarShips": [
                {
                    "companyCode": 1,
                    "scholarShipCode": "13",
                    "scholarShipName": "DIRETORIA",
                    "levelEducationCode": 2,
                    "serviceCode": "27",
                    "serviceName": "Mensalidade",
                    "termCode": 32,
                    "termCodeDescription": "2021",
                    "discountType": "P",
                    "discountValue": 11.0000,
                    "validityType": "P",
                    "startInstallment": 1,
                    "endInstallment": 1,
                    "branchCode": 1
                }
            ]
        },
        {
            "prospectName": "Antonio Lucas Peixoto",
            "prospectType": "A",
            "companyCode": 1,
            "studentCode": "EB-00238",
            "prospectPaymentPlans": [
                {
                    "companyCode": 1,
                    "termCode": 23,
                    "termCodeDescription": "2019",
                    "paymentPlanCode": "2019-12x",
                    "levelEducationCode": 2,
                    "paymentPlanName": "12 parcelas",
                    "branchCode": 1
                }
            ],
            "prospectScholarShips": []
        }
    ]
}			"branchCode": 1,
			"levelEducationCode": 1,
			"appliedMatrixCode": 132,
			"priceTableCode": 3,
			"branchName": "Filial Belo Horizonte - Fantasia",
			"courseCode": "1-1",
			"courseName": "Curso Tabela de Preços",
			"curriculumGridCode": "1",
			"curriculumGridName": "Matriz Tabela de Preços",
			"majorCode": "1",
			"majorName": "Habilitação  Tabela de Preços",
			"classShiftCode": 11,
			"classShiftName": "INTEGRAL",
			"status": 0,
			"actionState": 0
		}
	]
}
Informações
iconfalse
titleExemplo de Resultado Positivo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
	"companyCode": 1,
	"levelEducationCode": 1,
	"id": 12,
	"internalId": "1|1|12",
	"code": "00005",
	"name": "Tabela de Precos via Postman",
	"active": false,
	"priceTableInUse": false,
	"appliedMatrixes": [
		{
			"companyCode": 1,
			"branchCode": 1,
			"levelEducationCode": 1,
			"appliedMatrixCode": 132,
			"priceTableCode": 12,
			"branchName": "Filial Belo Horizonte - Fantasia",
			"courseCode": "1-1",
			"courseName": "Curso Tabela de Preços",
			"curriculumGridCode": "1",
			"curriculumGridName": "Matriz Tabela de Preços",
			"majorCode": "1",
			"majorName": "Habilitação  Tabela de Preços",
			"classShiftCode": 11,
			"classShiftName": "INTEGRAL",
			"status": 0,
			"actionState": 0
		}
	
Informações
iconfalse
titleExemplo de Resultado Positivo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "prospectionCode": 5,
    "description": "Nova prospecção 2024",
    "prospects": [
        {
            "prospectionCode": 5,
            "prospectCode": 137,
            "prospectName": "1",
            "prospectType": "A",
            "candidateUserCode": 198,
            "companyCode": 1,
            "studentCode": "ES-00219",
            "prospectPaymentPlans": [
                {
                    "prospectionCode": 5,
                    "prospectCode": 137,
                    "prospectPaymentPlanCode": 114,
                    "companyCode": 1,
                    "termCode": 32,
                    "termCodeDescription": "2023/1",
                    "paymentPlanCode": "2.0",
                    "levelEducationCode": 1,
                    "paymentPlanName": "Plano 2",
                    "branchCode": 1
                }
            ],
            "prospectScholarShips": [
                {
                    "prospectionCode": 5,
                    "prospectCode": 137,
                    "prospectSchoolshipCode": 86,
                    "companyCode": 1,
                    "scholarShipCode": "1",
                    "scholarShipName": "FUNCIONÁRIO DA ESCOLA",
                    "levelEducationCode": 1,
                    "serviceCode": "1",
                    "serviceName": "MENSALIDADE",
                    "termCode": 32,
                    "termCodeDescription": "2023/1",
                    "discountType": "P",
                    "discountValue": 25.1234,
                    "startDate": "2023-01-01T00:00:00-03:00",
                    "endDate": "2023-12-31T00:00:00-03:00",
                    "validityType": "T",
                    "branchCode": 1
                }
            ]
        },
        {
            "prospectionCode": 5,
            "prospectCode": 138,
            "prospectName": "2",
            "prospectType": "C",
            "candidateUserCode": 212,
            "companyCode": 1,
            "prospectPaymentPlans": [
                {
                    "prospectionCode": 5,
                    "prospectCode": 138,
                    "prospectPaymentPlanCode": 115,
                    "companyCode": 1,
                    "termCode": 32,
                    "termCodeDescription": "2023/1",
                    "paymentPlanCode": "2023/PS",
                    "levelEducationCode": 1,
                    "paymentPlanName": "2023 Processo seletivo teste",
                    "branchCode": 1
                }
            ],
            "prospectScholarShips": []
        },
        {
            "prospectionCode": 5,
            "prospectCode": 139,
            "prospectName": "AAAA sss",
            "prospectType": "P",
            "individualRegistrationCode": "45657746589",
            "prospectPaymentPlans": [
                {
                    "prospectionCode": 5,
                    "prospectCode": 139,
                    "prospectPaymentPlanCode": 116,
                    "companyCode": 1,
                    "termCode": 28,
                    "termCodeDescription": "2021",
                    "paymentPlanCode": "10112690",
                    "levelEducationCode": 2,
                    "paymentPlanName": "Plano 1 - Padrão 11 parcelas",
                    "branchCode": 1
                }
            ],
            "prospectScholarShips": [
                {
                    "prospectionCode": 5,
                    "prospectCode": 139,
                    "prospectSchoolshipCode": 87,
                    "companyCode": 1,
                    "scholarShipCode": "13",
                    "scholarShipName": "DIRETORIA",
                    "levelEducationCode": 2,
                    "serviceCode": "27",
                    "serviceName": "Mensalidade",
                    "termCode": 32,
                    "termCodeDescription": "2021",
                    "discountType": "P",
                    "discountValue": 11.0000,
                    "validityType": "P",
                    "startInstallment": 1,
                    "endInstallment": 1,
                    "branchCode": 1
                }
            ]
        },
        {
            "prospectionCode": 5,
            "prospectCode": 140,
            "prospectName": "Antonio Lucas Peixoto",
            "prospectType": "A",
            "companyCode": 1,
            "studentCode": "EB-00238",
            "prospectPaymentPlans": [
                {
                    "prospectionCode": 5,
                    "prospectCode": 140,
                    "prospectPaymentPlanCode": 117,
                    "companyCode": 1,
                    "termCode": 23,
                    "termCodeDescription": "2019",
                    "paymentPlanCode": "2019-12x",
                    "levelEducationCode": 2,
                    "paymentPlanName": "12 parcelas",
                    "branchCode": 1
                }
            ],
            "prospectScholarShips": []
        }
    ]
}
Informações
iconfalse
titleExemplo de Resultado Negativo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    	"code": null,
    	"message": "ANão bolsafoi 12possível incluir/editar estáa cadastradatabela parade opreços. prospect '1' na prospecção 'Matricula de ingressantes 2022'.\r\nA bolsa 20 já está cadastrada para o prospect 'AAAA sss' na prospecção 'Matricula de ingressantes 2022'.",
    A listagem de matrizes aplicadas está inválida.",
	"detailedMessage": null,
    	"helpUrl": null,
    	"details": null
}

1.3 - PUT

...