API - Método GET

Exemplo de Resposta em Caso de Sucesso

{
    "total": 1,
    "count": 1,
    "startindex": 1,
    "resources": [
        {
            "id": "TAFA632",
            "operation": 1,
            "pk": "RCBNRyAwMSBEIE1HIDAxIDA1MjAyMDIgICAgIDAwMDAxMDEwMTAgIA==",
            "models": [
                {
                    "id": "MODEL_T1A",
                    "modeltype": "FIELDS",
                    "fields": [
                        {
                            "id": "T1A_FILIAL",
                            "order": 1,
                            "value": "D MG 01"
                        },
                        {
                            "id": "T1A_FILORI",
                            "order": 2,
                            "value": "T1D MG 02"
                        },
                        {
                            "id": "T1A_ID",
                            "order": 3,
                            "value": "fee36035-9e6a-df67-7586-b0b53a1b60a1"
                        },
                        {
                            "id": "T1A_IDDEBI",
                            "order": 4,
                            "value": "2"
                        },
                        {
                            "id": "T1A_ANOPOS",
                            "order": 5,
                            "value": "20"
                        },
                        {
                            "id": "T1A_IDTRIB",
                            "order": 6,
                            "value": "000010"
                        },
                        {
                            "id": "T1A_PERAPU",
                            "order": 9,
                            "value": "052020"
                        },
                        {
                            "id": "T1A_CODREC",
                            "order": 10,
                            "value": "1010"
                        },
                        {
                            "id": "T1A_TRIPOS",
                            "order": 11,
                            "value": "2"
                        },
                        {
                            "id": "T1A_CPNEST",
                            "order": 13,
                            "value": "13004999000350"
                        }
                    ]
                }
            ]
        }
    ]
}

API - GET [pk]

Exemplo de Resposta em Caso de Sucesso

{
    "id": "TAFA632",
    "operation": 1,
    "pk": "RCBNRyAwMSBEIE1HIDAxIDA1MjAyMDIgICAgIDAwMDAxMDEwMTAgIA==",
    "models": [
        {
            "id": "MODEL_T1A",
            "modeltype": "FIELDS",
            "fields": [
                {
                    "id": "T1A_FILIAL",
                    "order": 1,
                    "value": "D MG 01"
                },
                {
                    "id": "T1A_FILORI",
                    "order": 2,
                    "value": "T1D MG 02"
                },
                {
                    "id": "T1A_ID",
                    "order": 3,
                    "value": "fee36035-9e6a-df67-7586-b0b53a1b60a1"
                },
                {
                    "id": "T1A_IDDEBI",
                    "order": 4,
                    "value": "2"
                },
                {
                    "id": "T1A_ANOPOS",
                    "order": 5,
                    "value": "20"
                },
                {
                    "id": "T1A_IDTRIB",
                    "order": 6,
                    "value": "000010"
                },
                {
                    "id": "T1A_PERAPU",
                    "order": 9,
                    "value": "052020"
                },
                {
                    "id": "T1A_CODREC",
                    "order": 10,
                    "value": "1010"
                },
                {
                    "id": "T1A_TRIPOS",
                    "order": 11,
                    "value": "2"
                },
                {
                    "id": "T1A_CPNEST",
                    "order": 13,
                    "value": "13004999000350"
                }
            ],
            "models": [
                {
                    "id": "MODEL_T1B",
                    "modeltype": "GRID",
                    "optional": 1,
                    "struct": [
                        {
                            "id": "T1B_FILIAL",
                            "order": 1
                        },
                        {
                            "id": "T1B_ID",
                            "order": 2
                        },
                        {
                            "id": "T1B_IDPROC",
                            "order": 3
                        },
                        {
                            "id": "T1B_TERCEI",
                            "order": 5
                        },
                        {
                            "id": "T1B_VALSUS",
                            "order": 6
                        },
                        {
                            "id": "T1B_IDSUSP",
                            "order": 7
                        }
                    ],
                    "items": [
                        {
                            "id": 1,
                            "deleted": 0,
                            "fields": [
                                {
                                    "id": "T1B_FILIAL",
                                    "value": "D MG 01"
                                },
                                {
                                    "id": "T1B_ID",
                                    "value": "fee36035-9e6a-df67-7586-b0b53a1b60a1"
                                },
                                {
                                    "id": "T1B_IDPROC",
                                    "value": "000001"
                                },
                                {
                                    "id": "T1B_TERCEI",
                                    "value": "1"
                                },
                                {
                                    "id": "T1B_VALSUS",
                                    "value": "5000.00"
                                },
                                {
                                    "id": "T1B_IDSUSP",
                                    "value": "00000117082017154055000150"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

API - Metodo POST

Para o POST de um pagamento, seguiremos a mesma abordagem dos métodos das API's anteriores. 
Removendo a PK do body e tratando os campos de controle interno do TAF (id). 

Exemplo de Envio Esperado

{
    "id": "TAFA632",
    "operation": 1,
    "models": [
        {
            "id": "MODEL_T1A",
            "modeltype": "FIELDS",
            "fields": [
                {
                    "id": "T1A_FILIAL",
                    "order": 1,
                    "value": "D MG 02"
                },
                {
                    "id": "T1A_FILORI",
                    "order": 2,
                    "value": "T1D MG 02"
                },
                {
                    "id": "T1A_IDDEBI",
                    "order": 4,
                    "value": "2"
                },
                {
                    "id": "T1A_ANOPOS",
                    "order": 5,
                    "value": "20"
                },
                {
                    "id": "T1A_IDTRIB",
                    "order": 6,
                    "value": "000010"
                },
                {
                    "id": "T1A_PERAPU",
                    "order": 9,
                    "value": "052020"
                },
                {
                    "id": "T1A_CODREC",
                    "order": 10,
                    "value": "1010"
                },
                {
                    "id": "T1A_TRIPOS",
                    "order": 11,
                    "value": "2"
                },
                {
                    "id": "T1A_CPNEST",
                    "order": 13,
                    "value": "13004999000350"
                }
            ],
            "models": [
                {
                    "id": "MODEL_T1B",
                    "modeltype": "GRID",
                    "optional": 1,
                    "struct": [
                        {
                            "id": "T1B_FILIAL",
                            "order": 1
                        },
                        {
                            "id": "T1B_ID",
                            "order": 2
                        },
                        {
                            "id": "T1B_IDPROC",
                            "order": 3
                        },
                        {
                            "id": "T1B_TERCEI",
                            "order": 5
                        },
                        {
                            "id": "T1B_VALSUS",
                            "order": 6
                        },
                        {
                            "id": "T1B_IDSUSP",
                            "order": 7
                        }
                    ],
                    "items": [
                        {
                            "id": 1,
                            "deleted": 0,
                            "fields": [
                                {
                                    "id": "T1B_FILIAL",
                                    "value": "D MG 01"
                                },
                                {
                                    "id": "T1B_ID",
                                    "value": "fee36035-9e6a-df67-7586-b0b53a1b60a1"
                                },
                                {
                                    "id": "T1B_IDPROC",
                                    "value": "000001"
                                },
                                {
                                    "id": "T1B_TERCEI",
                                    "value": "1"
                                },
                                {
                                    "id": "T1B_VALSUS",
                                    "value": "5000.00"
                                },
                                {
                                    "id": "T1B_IDSUSP",
                                    "value": "00000117082017154055000150"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

Exemplo de Resposta em Caso de Sucesso

{
    "id": "TAFA632",
    "operation": 1,
    "pk": "RCBNRyAwMSBEIE1HIDAxIDA1MjAyMDMgICAgIDAwMDAxMDEwMTAgIA==",
    "models": [
        {
            "id": "MODEL_T1A",
            "modeltype": "FIELDS",
            "fields": [
                {
                    "id": "T1A_FILIAL",
                    "order": 1,
                    "value": "D MG 01"
                },
                {
                    "id": "T1A_FILORI",
                    "order": 2,
                    "value": "T1D MG 02"
                },
                {
                    "id": "T1A_ID",
                    "order": 3,
                    "value": "36f1a1c3-96d3-4ddb-2f83-c8de660ff3bf"
                },
                {
                    "id": "T1A_IDDEBI",
                    "order": 4,
                    "value": "3"
                },
                {
                    "id": "T1A_ANOPOS",
                    "order": 5,
                    "value": "20"
                },
                {
                    "id": "T1A_IDTRIB",
                    "order": 6,
                    "value": "000010"
                },
                {
                    "id": "T1A_PERAPU",
                    "order": 9,
                    "value": "052020"
                },
                {
                    "id": "T1A_CODREC",
                    "order": 10,
                    "value": "1010"
                },
                {
                    "id": "T1A_TRIPOS",
                    "order": 11,
                    "value": "2"
                },
                {
                    "id": "T1A_CPNEST",
                    "order": 13,
                    "value": "13004999000350"
                }
            ],
            "models": [
                {
                    "id": "MODEL_T1B",
                    "modeltype": "GRID",
                    "optional": 1,
                    "struct": [
                        {
                            "id": "T1B_FILIAL",
                            "order": 1
                        },
                        {
                            "id": "T1B_ID",
                            "order": 2
                        },
                        {
                            "id": "T1B_IDPROC",
                            "order": 3
                        },
                        {
                            "id": "T1B_TERCEI",
                            "order": 5
                        },
                        {
                            "id": "T1B_VALSUS",
                            "order": 6
                        },
                        {
                            "id": "T1B_IDSUSP",
                            "order": 7
                        }
                    ],
                    "items": [
                        {
                            "id": 1,
                            "deleted": 0,
                            "fields": [
                                {
                                    "id": "T1B_FILIAL",
                                    "value": "D MG 01"
                                },
                                {
                                    "id": "T1B_ID",
                                    "value": "36f1a1c3-96d3-4ddb-2f83-c8de660ff3bf"
                                },
                                {
                                    "id": "T1B_IDPROC",
                                    "value": "000001"
                                },
                                {
                                    "id": "T1B_TERCEI",
                                    "value": "1"
                                },
                                {
                                    "id": "T1B_VALSUS",
                                    "value": "5000.00"
                                },
                                {
                                    "id": "T1B_IDSUSP",
                                    "value": "00000117082017154055000150"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

API - Metodo PUT

{
    "id": "TAFA535",
    "operation": 1,
    "models": [
        {
            "id": "MODEL_V3U",
            "modeltype": "FIELDS",
            "fields": [
                {
                    "id": "V3U_FILIAL",
                    "order": 1,
                    "value": "D MG 01"
                },
                {
                    "id": "V3U_NUMERO",
                    "order": 3,
                    "value": "PGTO-PUT"
                },
                {
                    "id": "V3U_SERIE",
                    "order": 4,
                    "value": "123"
                },
                {
                    "id": "V3U_CODPAR",
                    "order": 5,
                    "value": "FF4020101"
                },
                {
                    "id": "V3U_DTEMIS",
                    "order": 8,
                    "value": "20230401"
                },
                {
                    "id": "V3U_NATTIT",
                    "order": 9,
                    "value": "0"
                },
                {
                    "id": "V3U_DTPAGT",
                    "order": 11,
                    "value": "20230401"
                },
                {
                    "id": "V3U_SEQUEN",
                    "order": 12,
                    "value": "01"
                }
            ],
            "models": [
                {
                    "id": "MODEL_V3V",
                    "modeltype": "GRID",
                    "struct": [
                        {
                            "id": "V3V_FILIAL",
                            "order": 1
                        },
                        {
                            "id": "V3V_ID",
                            "order": 2
                        },
                        {
                            "id": "V3V_CNATRE",
                            "order": 4
                        },
                        {
                            "id": "V3V_VALOR",
                            "order": 5
                        },
                        {
                            "id": "V3V_DECTER",
                            "order": 6
                        },
                        {
                            "id": "V3V_IDPROC",
                            "order": 10
                        },
                        {
                            "id": "V3V_IFCISC",
                            "order": 12
                        },
                        {
                            "id": "V3V_COMPFP",
                            "order": 13
                        }
                    ],
                    "items": [
                        {
                            "id": 1,
                            "deleted": 0,
                            "fields": [
                                {
                                    "id": "V3V_FILIAL",
                                    "value": "D MG 01"
                                },
                                {
                                    "id": "V3V_CNATRE",
                                    "value": "000016"
                                },
                                {
                                    "id": "V3V_VALOR",
                                    "value": "10000.00"
                                },
                                {
                                    "id": "V3V_DECTER",
                                    "value": "2"
                                }
                            ],
                            "models": [
                                {
                                    "id": "MODEL_V46",
                                    "modeltype": "GRID",
                                    "optional": 1,
                                    "struct": [
                                        {
                                            "id": "V46_FILIAL",
                                            "order": 1
                                        },
                                        {
                                            "id": "V46_ID",
                                            "order": 2
                                        },
                                        {
                                            "id": "V46_IDNAT",
                                            "order": 3
                                        },
                                        {
                                            "id": "V46_IDTRIB",
                                            "order": 4
                                        },
                                        {
                                            "id": "V46_BASE",
                                            "order": 6
                                        },
                                        {
                                            "id": "V46_VALOR",
                                            "order": 7
                                        },
                                        {
                                            "id": "V46_ALIQ",
                                            "order": 8
                                        }
                                    ]
                                },
                                {
                                    "id": "MODEL_V4H",
                                    "modeltype": "GRID",
                                    "optional": 1,
                                    "struct": [
                                        {
                                            "id": "V4H_FILIAL",
                                            "order": 1
                                        },
                                        {
                                            "id": "V4H_ID",
                                            "order": 2
                                        },
                                        {
                                            "id": "V4H_IDPROC",
                                            "order": 3
                                        },
                                        {
                                            "id": "V4H_IDSUSP",
                                            "order": 6
                                        },
                                        {
                                            "id": "V4H_IDTRIB",
                                            "order": 7
                                        },
                                        {
                                            "id": "V4H_VALSUS",
                                            "order": 9
                                        },
                                        {
                                            "id": "V4H_VBASSU",
                                            "order": 10
                                        },
                                        {
                                            "id": "V4H_VLRANO",
                                            "order": 11
                                        },
                                        {
                                            "id": "V4H_VLRANA",
                                            "order": 12
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

Exemplo de Resposta em Caso de Sucesso

{
    "id": "TAFA632",
    "operation": 1,
    "pk": "RCBNRyAwMiBEIE1HIDAyIDAxMjAyNTEgICAgIDAwMDAwNTU2NzgxMQ==",
    "models": [
        {
            "id": "MODEL_T1A",
            "modeltype": "FIELDS",
            "fields": [
                {
                    "id": "T1A_FILIAL",
                    "order": 1,
                    "value": "D MG 02"
                },
                {
                    "id": "T1A_FILORI",
                    "order": 2,
                    "value": "T1X TAF02"
                },
                {
                    "id": "T1A_ID",
                    "order": 3,
                    "value": "63cdfedc-d19e-2ed2-965b-aff6f23ab038"
                },
                {
                    "id": "T1A_IDDEBI",
                    "order": 4,
                    "value": "1"
                },
                {
                    "id": "T1A_ANOPOS",
                    "order": 5,
                    "value": "2026"
                },
                {
                    "id": "T1A_IDTRIB",
                    "order": 6,
                    "value": "000005"
                },
                {
                    "id": "T1A_PERAPU",
                    "order": 9,
                    "value": "012025"
                },
                {
                    "id": "T1A_CODREC",
                    "order": 10,
                    "value": "567811"
                },
                {
                    "id": "T1A_TRIPOS",
                    "order": 11,
                    "value": "1"
                },
                {
                    "id": "T1A_PERIOD",
                    "order": 12,
                    "value": "2"
                },
                {
                    "id": "T1A_CPNEST",
                    "order": 13,
                    "value": "53113791000637"
                },
                {
                    "id": "T1A_VALTRI",
                    "order": 15,
                    "value": "10457.78"
                },
                {
                    "id": "T1A_CODMUN",
                    "order": 16,
                    "value": "002818"
                },
                {
                    "id": "T1A_UF",
                    "order": 20,
                    "value": "000012"
                },
                {
                    "id": "T1A_DTDEBI",
                    "order": 23,
                    "value": "20250110"
                }
            ],
            "models": [
                {
                    "id": "MODEL_T1B",
                    "modeltype": "GRID",
                    "optional": 1,
                    "struct": [
                        {
                            "id": "T1B_FILIAL",
                            "order": 1
                        },
                        {
                            "id": "T1B_ID",
                            "order": 2
                        },
                        {
                            "id": "T1B_IDPROC",
                            "order": 3
                        },
                        {
                            "id": "T1B_TERCEI",
                            "order": 5
                        },
                        {
                            "id": "T1B_VALSUS",
                            "order": 6
                        },
                        {
                            "id": "T1B_IDSUSP",
                            "order": 7
                        }
                    ],
                    "items": [
                        {
                            "id": 1,
                            "deleted": 0,
                            "fields": [
                                {
                                    "id": "T1B_FILIAL",
                                    "value": "D MG 01"
                                },
                                {
                                    "id": "T1B_ID",
                                    "value": "63cdfedc-d19e-2ed2-965b-aff6f23ab038"
                                },
                                {
                                    "id": "T1B_IDPROC",
                                    "value": "000001"
                                },
                                {
                                    "id": "T1B_TERCEI",
                                    "value": "1"
                                },
                                {
                                    "id": "T1B_VALSUS",
                                    "value": "5000.00"
                                },
                                {
                                    "id": "T1B_IDSUSP",
                                    "value": "00000117082017154055000150"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

API - Método DELETE

Exemplo de Resposta em Caso de Sucesso

true