O objeto Parcela da fatura (snap_mall__Parcela_fatura__c) contém todas as informações de cadastro da fatura.
Para criação de uma Parcela de fatura se faz necessário previamente possuir cadastrado na base: Fatura
...
| Rótulo do campo | Nome de API | Tipo de dados | Obrigatório | Descrição |
|---|---|---|---|---|
| Comissão | snap_mall__Comissao__c | Pesquisa(Comissão) | ID da comissão que foi calculado pela parcela da fatura | |
| Criado por | CreatedById | Pesquisa(Usuário) | X | Preenchimento automático com o usuário de sistema que realizou a criação do cadastro ou usuário da integração |
| Código do pagamento | snap_mall__Codigo_pagamento__c | Texto(50) (Não-diferenciação exclusiva de maiúsculas e minúsculas) | Informação o código do pagamento da fatura | |
| Data de pagamento | snap_mall__Data_pagamento__c | Data | Informação data de pagamento da parcela da fatura | |
| Data de vencimento | snap_mall__Data_vencimento__c | Data | X | Informação da data de vencimento da parcela da fatura |
| Data do estorno da parcela | snap_mall__Data_estorno__c | Data | Informação da data de estorno da parcela da fatura | |
| Data do estorno do pagamento | snap_mall__Data_estorno_pagamento__c | Data | Informação da data de estorno da data de pagamento da parcela da fatura | |
| Descrição da parcela | snap_mall__Descricao__c | Área de texto(255) | Informação da descrição da parcela da fatura | |
| Descrição do pagamento | snap_mall__Descricao_pagamento__c | Texto(100) | Informação da descrição do pagamento da parcela | |
| Fatura | snap_mall__Fatura__c | Detalhes do mestre(Fatura) | X | ID da fatura cadastrada no objeto fatura |
| ID Externo | snap_mall__Id_externo__c | Texto(100) (ID externo) (Não-diferenciação exclusiva de maiúsculas e minúsculas) | ID do sistema ERP, que poderá ser informado no momento da inserção da conta, para futuras atualizações, através deste ID | |
| Motivo do estorno | snap_mall__Motivo_estorno__c | Texto(100) | Informação do motivo de estorno da parcela da fatura | |
| Número do boleto | snap_mall__Numero_boleto__c | Texto(50) | Informação do numero de boleto da parcela da fatura | |
| Parcela | Name | Numeração automática | X | Número da parcela da fatura |
| Situação | snap_mall__Situacao__c | Lista de opções | X | Lista de situações da parcela da fatura Opções disponíveis
|
| Valor da multa | snap_mall__Valor_multa__c | Moeda(12, 2) | Informação do valor da multa da parcela da fatura | |
| Valor da parcela | snap_mall__Valor_parcela__c | Moeda(12, 2) | X | Informação do valor da parcela da fatura |
| Valor do desconto | snap_mall__Valor_desconto__c | Moeda(12, 2) | Informação do valor do desconto da parcela da fatura | |
| Valor do juro | snap_mall__Valor_juro__c | Moeda(12, 2) | Informação do valor de juros da parcela da fatura | |
| Valor pago | snap_mall__Valor_pago__c | Moeda(12, 2) | Informação do valor pago da parcela da fatura | |
| Última modificação feita por | LastModifiedById | Pesquisa(Usuário) | X | Informação do usuário de sistema que realizou a ultima modificação ou usuário da integração |
Criar Parcela da Fatura:
Método : POST
URI: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__Parcela_fatura__c/
Descrição: Método de criação de uma Parcela de Fatura(snap_mall__Parcela_fatura__c) , informando todos os campos utilizados para uma parcela.
Request |
|---|
| { "snap_mall__Fatura__c":"a0fo0000008QrCH", "snap_mall__Situacao__c":"Pendente", "snap_mall__Descricao__c":"Parcelado", "snap_mall__Data_vencimento__c":"2018-05-07", "snap_mall__Valor_desconto__c":"0", "snap_mall__Valor_parcela__c":"12000.00", "snap_mall__Data_estorno__c":"2018-05-07", "snap_mall__Motivo_estorno__c":"Não se aplica", "snap_mall__Valor_juro__c":"0", "snap_mall__Valor_multa__c":"0", "snap_mall__Numero_boleto__c":"3", "snap_mall__Descricao_pagamento__c":"Pagamento curto prazo", "snap_mall__Codigo_pagamento__c":"312", "snap_mall__Data_estorno_pagamento__c":"2018-05-07", "snap_mall__Tipo_de_movimento__c":"a0r1J000006980WQAQ", "snap_mall__Data_pagamento__c":"2018-05-07", "snap_mall__Valor_pago__c":"12000.00", "snap_mall__Id_externo__c":"123456789", "snap_mall__Comissao__c":"a081J00001ZFmPDQA1" } |
Response |
|---|
{ |
Atualizar Parcela da Fatura:
Método : PATCH
URI com ID salesforce: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__Parcela_fatura__c/ (Id do registro salesforce)
URI com ID externo: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__Parcela_fatura__c/snap_mall__Id_externo__c/ (Id externo)
Descrição:
Método de atualização de uma Parcela da fatura(snap_mall__Parcela_fatura__c) de qualquer tipo, informando no body apenas os campos que se deseja atualizar.
Existem duas possibilidades de atualização da Parcela da Fatura: Um com Id Salesforce o outro com o Id Externo, a diferenciação desta chamada vai ser na URI.
O método PATCH pode ser utilizado par Upsert, em caso do Id externo informado não existir na base e contiver todos os campos obrigatórios no body.
Request |
|---|
{ } |
Response |
|---|
Response em caso de sucesso da atualização retornará vazio.
Deletar ContaParcela da Fatura:
Método : DELETE
URI com ID salesforce: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__Parcela_fatura__c/ (Id do registro salesforce)
...
Descrição: Método de deleção de uma Parcela da Fatura(snap_mall__Parcela_fatura__c) . Existem duas possibilidades de deleção da Parcela da Fatura : Um com Id Salesforce o outro com o Id Externo, a diferenciação desta chamada vai ser na URI.
Request |
|---|
Body de deleção é vazio.
Response |
|---|
Response de deleção retorna vazio.
...