Portador

portador

Obter Listagem de Portadores

get

https://localhost/cadastrosgerais/v10http://localhost/cadastrosgerais/v10

/portador

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de consulta

continuationTokenstringOpcional

Identificador da Paginação da Consulta

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

continuationTokenstringOpcional

Identificador da Paginação da Consulta

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/portador

HTTPcURLJavaScriptPython

GET /cadastrosgerais/v10/portador HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "continuationToken": "text",
  "data": [
    {
      "codPortador": 1,
      "nome": "text",
      "endereco": "text",
      "cep": "text",
      "agencia": "text",
      "contaCorrente": "text",
      "fantasia": "text",
      "aceitaProrrogacao": 1,
      "codigoBACEN": 1,
      "cnpj": "text"
    }
  ]
}

Cadastrar um Portador

put

https://localhost/cadastrosgerais/v10http://localhost/cadastrosgerais/v10

/portador

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

application/json

Respostas

200

OK

application/json

codPortadorintegerObrigatório

Código do Portador

nomestringObrigatório

Nome do Portador

enderecostringOpcional

Endereço do Portador

cepstring · máx: 8Obrigatório

Código do CEP do Portador

agenciastringOpcional

Agência do Portador

contaCorrentestringOpcional

Código da Conta Corrente do Portador

fantasiastringObrigatório

Nome Fantasia do Portador

aceitaProrrogacaointegerObrigatório

Aceita Prorrogação? (0-Não,1-Sim)

codigoBACENinteger · máx: 999Opcional

Código BACEN do Portador

cnpjstringOpcional

Código do CNPJ do Portador (sem formatação)

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/portador

HTTPcURLJavaScriptPython

PUT /cadastrosgerais/v10/portador HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "data": [
    {
      "codPortador": 1,
      "nome": "text",
      "endereco": "text",
      "cep": "text",
      "agencia": "text",
      "contaCorrente": "text",
      "fantasia": "text",
      "aceitaProrrogacao": 1,
      "codigoBACEN": 1,
      "cnpj": "text"
    }
  ]
}

{
  "codPortador": 1,
  "nome": "text",
  "endereco": "text",
  "cep": "text",
  "agencia": "text",
  "contaCorrente": "text",
  "fantasia": "text",
  "aceitaProrrogacao": 1,
  "codigoBACEN": 1,
  "cnpj": "text"
}

Obter um Portador

get

https://localhost/cadastrosgerais/v10http://localhost/cadastrosgerais/v10

/portador/{id}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Portador

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

codPortadorintegerObrigatório

Código do Portador

nomestringObrigatório

Nome do Portador

enderecostringOpcional

Endereço do Portador

cepstring · máx: 8Obrigatório

Código do CEP do Portador

agenciastringOpcional

Agência do Portador

contaCorrentestringOpcional

Código da Conta Corrente do Portador

fantasiastringObrigatório

Nome Fantasia do Portador

aceitaProrrogacaointegerObrigatório

Aceita Prorrogação? (0-Não,1-Sim)

codigoBACENinteger · máx: 999Opcional

Código BACEN do Portador

cnpjstringOpcional

Código do CNPJ do Portador (sem formatação)

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/portador/{id}

HTTPcURLJavaScriptPython

GET /cadastrosgerais/v10/portador/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "codPortador": 1,
  "nome": "text",
  "endereco": "text",
  "cep": "text",
  "agencia": "text",
  "contaCorrente": "text",
  "fantasia": "text",
  "aceitaProrrogacao": 1,
  "codigoBACEN": 1,
  "cnpj": "text"
}

Atualizar um Portador

put

https://localhost/cadastrosgerais/v10http://localhost/cadastrosgerais/v10

/portador/{id}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Portador

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

application/json

Respostas

200

OK

application/json

codPortadorintegerObrigatório

Código do Portador

nomestringObrigatório

Nome do Portador

enderecostringOpcional

Endereço do Portador

cepstring · máx: 8Obrigatório

Código do CEP do Portador

agenciastringOpcional

Agência do Portador

contaCorrentestringOpcional

Código da Conta Corrente do Portador

fantasiastringObrigatório

Nome Fantasia do Portador

aceitaProrrogacaointegerObrigatório

Aceita Prorrogação? (0-Não,1-Sim)

codigoBACENinteger · máx: 999Opcional

Código BACEN do Portador

cnpjstringOpcional

Código do CNPJ do Portador (sem formatação)

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/portador/{id}

HTTPcURLJavaScriptPython

PUT /cadastrosgerais/v10/portador/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "data": [
    {
      "codPortador": 1,
      "nome": "text",
      "endereco": "text",
      "cep": "text",
      "agencia": "text",
      "contaCorrente": "text",
      "fantasia": "text",
      "aceitaProrrogacao": 1,
      "codigoBACEN": 1,
      "cnpj": "text"
    }
  ]
}

{
  "codPortador": 1,
  "nome": "text",
  "endereco": "text",
  "cep": "text",
  "agencia": "text",
  "contaCorrente": "text",
  "fantasia": "text",
  "aceitaProrrogacao": 1,
  "codigoBACEN": 1,
  "cnpj": "text"
}

Excluir um Portador

delete

https://localhost/cadastrosgerais/v10http://localhost/cadastrosgerais/v10

/portador/{id}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Portador

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

delete

/portador/{id}

HTTPcURLJavaScriptPython

DELETE /cadastrosgerais/v10/portador/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

Sem conteúdo