Páginas filhas
  • NGF - FINA710 - Endpoint Bills/Email

Versões comparadas

Chave

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

NGF - FINA710 - Endpoint Bills/Email

  Draft

01. OVERVIEW

Initiates the process of resending the registered bank slip by email.

02. ENDPOINT

Method used: POST
/api/gfin/v1/Banks/Bills/Email

03. REQUEST PARAMETERS

Body parameters:

Attribute

Type

Description

Default

ea_filial

character

code of the financial bill's branch

-

ea_prefixo

character

financial bill prefix

-

ea_num

character

number of the financial bill

-

ea_parcela

character

financial bill installment

-

ea_tipo

character

type of the financial bill

-

Example:

body

body =
{
    "ea_filial": "D MG 01",
    "ea_num": "NGF000001",
    "ea_parcela": "",
    "ea_prefixo": "NGF",
    "ea_tipo": "BOL"
}

04. API RESPONSE

Json Object - Success

Attribute

Type

Description

message

character

success message


Json Object - Error

Attribute

Type

Description

code

character

HTTP code of the error

message

character

error title

detailedMessage

character

detailed error message

Example:

response

{
    "message": "Financial bill found. The process of submitting the bank slip by email will start."
}
 
{
    "code": "406",
    "message": "bill not found",
    "detailedMessage": "Financial Bill not found for the data received."
}