Histórico da Página
- Created and last modified by Alessandro Figueiredo on Nov 26,2015
Esta entidade exibe informações de Manutenção de Comissões e suporta as seguintes operações: POST, GET, DELETE
Campos do retorno
Nome | Descrição | Tipo | Tamanho do campo | Mais detalhes |
person | Pessoa | C | 6 |
|
titleNumber | Número do Título | C | 9 |
|
Series | Série | C | 3 |
|
parcel | Parcela | C | 2 |
|
commissionDate | Data da comissão | D | 8 |
|
basisValue | Valor Base | N | 17,2 |
|
percentBasisValur | % do Valor Base | N | 6,2 |
|
comissionValue | Valor da Comissão | N | 14,2 |
|
paymentDate | Data de Pagamento | D | 8 |
|
product | Produto | C | 15 |
|
client | Cliente | C | 6 |
|
commissionType | Tipo de comissão | C | 100 |
|
origin | Origem | C | 1 |
|
reason | Motivo | M | 80 |
|
Exemplo de inclusão de registros
Para adicionar um novo registro deve-se usar o método de POST, e no campo de requisição informar os campos necessários para inclusão.
first/api/v1/MaintenanceOfComission |
Body:
{ "person": "000003", "titleNumber": "999999144", "series": "1", "parcel": "3", "commissionDate": "20151209", "basisValue": 3000, "percentBasisValur": 50, "comissionValue": 1500, "paymentDate": "20151230", "product": "", "client": "000058", "commissionType": "C", "origin": "", "reason": "teste teste teste" } |
Retorno:
{ "url": "/first/api/v1/ MaintenanceOfComission /MDAwMDAzLDk5OTk5OTE0NCwx", "person": "000003", "titleNumber": "999999144", "series": "1" } |
Exemplo de obtenção de informações para todos registros
first/api/v1/MaintenanceOfComission |
{ "total": 10086, "hasNext": true, "syncing": false, "lines": [ { "id": "MDAwMDAxLDAwMDAwMjIxMCwx", "person": "000001", "titleNumber": "000002210", "series": "1", "parcel": "", "commissionDate": "20121010", "basisValue": 1770, "percentBasisValur": 1.5, "comissionValue": 26.55, "paymentDate": "20121128", "product": "", "client": "000058", "commissionType": "C", "origin": "", "reason": "" }, { "id": "MDAwMDAxLDAwMDAwMjIxNSwx", "person": "000001", "titleNumber": "000002215", "series": "1", "parcel": "", "commissionDate": "20121010", "basisValue": 1180, "percentBasisValur": 1.5, "comissionValue": 17.7, "paymentDate": "20121128", "product": "", "client": "000058", "commissionType": "C", "origin": "", "reason": "" }, { "id": "MDAwMDAxLDAwMDAwMjI0Miwx", "person": "000001", "titleNumber": "000002242", "series": "1", "parcel": "", "commissionDate": "20121018", "basisValue": 1180, "percentBasisValur": 1.5, "comissionValue": 17.7, "paymentDate": "20121128", "product": "", "client": "000058", "commissionType": "C", "origin": "", "reason": "" }, { "id": "MDAwMDAxLDAwMDAwMjI0OCwx", "person": "000001", "titleNumber": "000002248", "series": "1", "parcel": "", "commissionDate": "20121018", "basisValue": 347.5, "percentBasisValur": 3, "comissionValue": 10.43, "paymentDate": "20121128", "product": "", "client": "000026", "commissionType": "C", "origin": "", "reason": "" }, { "id": "MDAwMDAxLDAwMDAwMjI1Mywx", "person": "000001", "titleNumber": "000002253", "series": "1", "parcel": "", "commissionDate": "20121022", "basisValue": 1770, "percentBasisValur": 1.5, "comissionValue": 26.55, "paymentDate": "20121128", "product": "", "client": "000058", "commissionType": "C", "origin": "", "reason": "" }, { "id": "MDAwMDAxLDAwMDAwMjI3OSwx", "person": "000001", "titleNumber": "000002279", "series": "1", "parcel": "", "commissionDate": "20121029", "basisValue": 405, "percentBasisValur": 1.5, "comissionValue": 6.08, "paymentDate": "20121128", "product": "", "client": "000039", "commissionType": "C", "origin": "", "reason": "" }, { "id": "MDAwMDAxLDAwMDAwMjMyOCwx", "person": "000001", "titleNumber": "000002328", "series": "1", "parcel": "", "commissionDate": "20121110", "basisValue": 2183, "percentBasisValur": 1.5, "comissionValue": 32.74, "paymentDate": "20130103", "product": "", "client": "000058", "commissionType": "C", "origin": "", "reason": "" }, { "id": "MDAwMDAxLDAwMDAwMjMzMywx", "person": "000001", "titleNumber": "000002333", "series": "1", "parcel": "", "commissionDate": "20121112", "basisValue": 767, "percentBasisValur": 1.5, "comissionValue": 11.51, "paymentDate": "20130103", "product": "", "client": "000058", "commissionType": "C", "origin": "", "reason": "" }, { "id": "MDAwMDAxLDAwMDAwMjM0Mywx", "person": "000001", "titleNumber": "000002343", "series": "1", "parcel": "", "commissionDate": "20121114", "basisValue": 398, "percentBasisValur": 3, "comissionValue": 11.94, "paymentDate": "20130103", "product": "", "client": "000026", "commissionType": "C", "origin": "", "reason": "" }, { "id": "MDAwMDAxLDAwMDAwMjM0NSwx", "person": "000001", "titleNumber": "000002345", "series": "1", "parcel": "", "commissionDate": "20121114", "basisValue": 810, "percentBasisValur": 1.5, "comissionValue": 12.15, "paymentDate": "20130103", "product": "", "client": "000107", "commissionType": "C", "origin": "", "reason": "" } ] } |
Exemplo de obtenção de informações específicas sobre um registro usando ID como chave
first/api/v1/MaintenanceOfComission/MDAwMDAxLDAwMDAwMjMyOCwx |
{ "id": "MDAwMDAxLDAwMDAwMjMyOCwx", "person": "000001", "titleNumber": "000002328", "series": "1", "parcel": "", "commissionDate": "20121110", "basisValue": 2183, "percentBasisValur": 1.5, "comissionValue": 32.74, "paymentDate": "20130103", "product": "", "client": "000058", "commissionType": "C", "origin": "", "reason": "" } |
Exemplo de obtenção de registro usando filtro em campo :
first/api/v1/MaintenanceOfComission?basisValue=2183 |
{ "total": 2, "hasNext": false, "syncing": false, "lines": [ { "id": "MDAwMDAxLDAwMDAwMjMyOCwx", "person": "000001", "titleNumber": "000002328", "series": "1", "parcel": "", "commissionDate": "20121110", "basisValue": 2183, "percentBasisValur": 1.5, "comissionValue": 32.74, "paymentDate": "20130103", "product": "", "client": "000058", "commissionType": "C", "origin": "", "reason": "" }, { "id": "MDAwMDAyLDAwMDAwMjMyOCwx", "person": "000002", "titleNumber": "000002328", "series": "1", "parcel": "", "commissionDate": "20121110", "basisValue": 2183, "percentBasisValur": 1.5, "comissionValue": 32.74, "paymentDate": "20121210", "product": "", "client": "000058", "commissionType": "C", "origin": "", "reason": "" } ] } |
Exemplo de exclusão de registros
Para excluir um registro deve-se usar o método de DELETE, e informar o registro que deve ser excluído, via URL
first/api/v1/MaintenanceOfComission/MDAwMDAxLDAwMDAwMjMyOCwx |
Retorno:
{ "url": "/first/api/v1/MaintenanceOfComission/MDAwMDAxLDAwMDAwMjMyOCwx", "person": "000001", "titleNumber": "000002328", "series": "1" } |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas