Pular para o conteúdo principal

kobana banking edi

EDI (caixas EDI)

Comandos de kobana banking edi. Toda opção global (Opções globais) vale aqui.

ComandoHTTPDescrição
edi boxes listGET /v2/edi/edi_boxesListar Caixas Postais
edi boxes createPOST /v2/edi/edi_boxesCriar Caixa Postal
edi boxes getGET /v2/edi/edi_boxes/{uid}Visualizar Caixa Postal
edi boxes updatePUT /v2/edi/edi_boxes/{uid}Atualizar Caixa Postal

edi boxes list​

Listar Caixas Postais

kobana banking edi boxes list [OPÇÕES]

GET /v2/edi/edi_boxes

Lista Caixas Postais.

Parâmetros de consulta

NomeTipoObrigatórioDescrição
resource_typestringnãoFiltro por Tipo de Recurso. Carteira de Cobrança (charge.bank_billet_account) ou Conta Financeira (financial.account).
per_pageintegernãoQuantidade de registros por página. Máximo de 50.
pageintegernãoNúmero da página.

Respostas

HTTPDescrição
200Caixas Postais encontradas.

edi boxes create​

Criar Caixa Postal

kobana banking edi boxes create [OPÇÕES]

POST /v2/edi/edi_boxes

Cria uma nova Caixa Postal.

Corpo da requisição

O corpo não é um objeto simples (ou tem variantes). Veja kobana schema banking.edi.boxes.create.

Respostas

HTTPDescrição
201Caixa Postal criada
422Falha na validação

edi boxes get​

Visualizar Caixa Postal

kobana banking edi boxes get [UID] [OPÇÕES]

GET /v2/edi/edi_boxes/{uid}

Consulta informações de uma Caixa Postal específica.

Argumentos do caminho: uid

Respostas

HTTPDescrição
200Caixa Postal encontrada
404Caixa Postal não encontrada

edi boxes update​

Atualizar Caixa Postal

kobana banking edi boxes update [UID] [OPÇÕES]

PUT /v2/edi/edi_boxes/{uid}

Atualiza uma Caixa Postal específica.

Argumentos do caminho: uid

Corpo da requisição

O corpo não é um objeto simples (ou tem variantes). Veja kobana schema banking.edi.boxes.update.

Respostas

HTTPDescrição
200Caixa Postal atualizada
404Caixa Postal não encontrada
422operation/resource não podem ser alterados sem editable: true