O objeto Fatura (snap_mall__Fatura__c) contém todas as informações de cadastro da fatura.
Para criação de uma Fatura se faz necessário previamente possuir cadastrado na base : Shopping, Contrato, Conta e Unidade.
Campos de Fatura
| Rótulo do campo | Nome de API | Tipo de dados | Obrigatório | Descrição |
|---|---|---|---|---|
| Contrato | snap_mall__Contrato__c | Pesquisa(Contrato) | X | ID do contrato cadastrado no objeto contrato |
| 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 |
| Data da fatura | snap_mall__Data_fatura__c | Data | X | Informação da data de emissão da fatura |
| Data de pagamento | snap_mall__Data_pagamento__c | Data | Informação da data de pagamento da fatura | |
| Data de vencimento | snap_mall__Data_vencimento__c | Data | X | Informação da data de vencimento da fatura |
| Fatura | Name | Numeração automática | X | Preenchimento automático no momento da geração da fatura |
| ID externo | snap_mall__ID_externo__c | Texto(50) (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. | |
| Locatário | snap_mall__Locatario__c | Pesquisa(Conta) | X | ID locatário cadastrado no objeto Conta |
| Marca | snap_mall__Marca__c | Pesquisa(Conta) | ID marca cadastrada no objeto Conta | |
| Proprietário | OwnerId | Pesquisa(Usuário,Grupo) | ID usuário de sistema salesforce | |
| Shopping | snap_mall__Shopping__c | Pesquisa(Shopping) | X | ID shopping cadastrado no objeto shopping |
| Situação | snap_mall__Situacao__c | Lista de opções | X | Lista de opções com a situação do fatura Opções disponíveis
|
| Unidade | snap_mall__Produto__c | Pesquisa(Unidade) | X | ID unidade locaticia cadastrado no objeto unidade |
| Valor da fatura | snap_mall__Valor_fatura__c | Moeda(14, 2) | X | Informação do valor da fatura |
| Valor da multa | snap_mall__Valor_multa__c | Moeda(14, 2) | Informação do valor da multa | |
| Valor de juros | snap_mall__Valor_juros__c | Moeda(14, 2) | Informação do valor de juros | |
| Valor do desconto | snap_mall__Valor_desconto__c | Moeda(14, 2) | Informação do valor do desconto | |
| Valor pago | snap_mall__Valor_pago__c | Moeda(14, 2) | Informação do valor pago | |
| Ú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 Fatura:
Método : POST
URI: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__Fatura__c/
Descrição: Método de criação de uma Fatura(snap_mall__Fatura__c), informando todos os campos utilizados para criar uma Fatura.
Request |
|---|
| { "OwnerId":"0051J000004ppUV", "snap_mall__Locatario__c":"001o0000005y8pP", "snap_mall__Shopping__c":"a00o0000002HuOr", "snap_mall__Contrato__c":"a07o00000024EPz", "snap_mall__Produto__c":"a04o000000LQUXS", "snap_mall__Situacao__c":"Pendente", "snap_mall__Marca__c":"001o0000005y8pP", "snap_mall__ID_externo__c":"123456789", "snap_mall__Tipo_unidade_planejamento__c":"a0q1J000004xLUV", "snap_mall__Data_fatura__c":"2017-09-04", "snap_mall__Data_vencimento__c":"2017-09-04", "snap_mall__Data_pagamento__c":"2017-09-04" } |
Response |
|---|
{ |
Atualizar Fatura:
Método :PATCH
URI com ID salesforce:https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__Fatura__c/ (Id do registro salesforce)
URI com ID externo: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__Fatura__c/snap_mall__ID_externo__c/ (Id externo)
Descrição:
Método de atualização de uma Fatura(snap_mall__Fatura__c) de qualquer tipo, informando no body apenas os campos que se deseja atualizar.
Existem duas possibilidades de atualização da Fatua: 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 de atualização em caso de sucesso retorna vazio.
Deletar Fatura:
Método : DELETE
URI com ID salesforce: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__Fatura__c/ (Id do registro salesforce)
URI com ID externo: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__Fatura__c/ (Id externo)
Descrição: Método de deleção de uma Fatura(snap_mall__Fatura__c) de qualquer tipo. Existem duas possibilidades de deleção 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.