Download - Guia Rapido Webservice
-
GUIA RPIDO WEBSERVICE
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
2
RMS Software S.A. - Uma Empresa TOTVS Todos os direitos reservados.
A RMS Software a maior fornecedora nacional de software de
gesto corporativa para o mercado de comrcio e varejo.
Este documento contm informaes conceituais, tcnicas e telas
do produto que so confidenciais, podendo ser utilizadas somente
pelos clientes RMS no projeto de utilizao do RMS/Retail.
A reproduo deste material, por qualquer meio, em todo ou em
parte, sem a autorizao prvia e por escrito da RMS Software
S.A., ou envio do mesmo a outras empresas terceirizadas no
pertencentes ao grupo da RMS, sujeita o infrator aos termos da
Lei nmero 6895 de 17/10/80 e as penalidades previstas nos
artigos 184 e 185 do Cdigo Penal.
Para solicitar a autorizao de reproduo parcial ou total desde
documento, ou ainda necessitar envi-lo outra empresa,
necessrio enviar uma solicitao assinada e com firma
reconhecida para o departamento de controle de manuais da
RMS, que fica situado Al. Rio Negro, 1084 16 andar,
Alphaville, Barueri, So Paulo, ou se necessrio o cliente poder
entrar em contato pelo Telefone (0xx11) 2699-0008.
A RMS Software S.A. reserva-se o direito de alterar o contedo
deste manual, no todo ou em parte, sem prvio aviso.
O nome RMS e os logotipos RMS, RMS/Retail so marcas
registradas da RMS Software e suas empresas afiliadas no Brasil.
Todos os demais nomes mencionados podem ser marcas
registradas e comercializadas pelos seus proprietrios.
RMS Software S.A. - Uma empresa TOTVS.
11 2699-0008 www.rms.com.br
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
3
NDICE
Webservice .......................................................................................................................................................................................... 4
Objetivo .............................................................................................................................................................................................. 4
Parametrizao .................................................................................................................................................................................. 4
CRM-Crdito ..................................................................................................................................................................................... 4
Exportao de Cadastro ................................................................................................................................................................. 27
Importao de Movimentos ............................................................................................................................................................. 30
Anexo I ............................................................................................................................................................................................ 39
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
4
Webservice
Objetivo
Este manual contm o detalhe de cada um dos mtodos disponveis nos webservices de integrao com o RMS-Retail.
Parametrizao
CRM-Crdito
Para integrao do mdulo CRM-Crdito, dispomos dos mtodos listados abaixo:
1. GetCustomer: Mtodo responsvel por obter os dados completos do cliente.
a. Assinatura: CustomerDTO GetCustomer(int StoreCode, DocumentType DocumentType, string DocumentNumber)
b. Parmetros de envio:
i. StoreCode: Cdigo da loja onde est acontecendo a consulta. ii. DocumentType: Tipo de documento de identificao referente ao
parmetro pDocumentNumber. iii. DocumentNumber: Nmero do documento de identificao do cliente.
c. SOAP de envio:
1 FIN 01766688822
d. Parmetro de retorno: CustomerDTO i. Address: Endereo do cliente.
ii. Address2: Endereo complementar do cliente. iii. AddressNumber: Nmero do endereo. iv. AgreementCardPassword: Senha do carto convnio.
v. BalanceAgreementCard: Saldo em carto convnio. vi. BalanceCadernetaEletronica:Saldo em caderneta eletrnica.
vii. BalanceCheck: Saldo em cheque. viii. BalanceFoodCard: Saldo em carto alimentao. ix. BalancePoints: Saldo em carto de pontos.
x. BalanceSeasonalCard: Saldo em carto sazonal. xi. BalanceSporadicCard: Saldo em carto espordico.
xii. Birthday: Data de nascimento. xiii. CardNumber: Nmero do carto.
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
5
xiv. Category: Categoria do cliente. xv. City: Cidade. xvi. Company: Empresa onde trabalha.
xvii. DiscountCampaign: Valor de desconto em campanha. xviii. Email: E-mail do cliente.
xix. FIN: Nmero do CPF/CNPJ. xx. FINType: Tipo do FIN (CPF/CNPJ). xxi. FoodCardPassword: Senha do carto alimentao.
xxii. ID: Cdigo interno do cliente. xxiii. IdentifiedDocument: Tipo de documento identificado pelo cliente.
xxiv. Name: Nome do cliente. xxv. Neighborhood: Bairro.
xxvi. NewPassword: N/A xxvii. PointsPassword: Senha do carto de pontos. xxviii. PostalCode: CEP.
xxix. SeasonalCardPassword: Senha do carto sazonal. xxx. SporadicCardPassword: Senha do carto espordico.
xxxi. State: Estado. xxxii. Status: Status do cliente. xxxiii. Telephone: Telefone.
e. SOAP de retorno:
CASASSSS CASA
470
4000.00
0 0
0 0 0
0
1
+;+;+;+;+;+;+
00028430067833
CPF
FIN TESTE TESTE TESTE
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
6
CENTRO
Enabled
11;44443422
2. GetCheckAuthorization: Mtodo responsvel por requisitar uma autorizao para dbito em cheque.
a. Assinatura: AuthorizationDTO GetCheckAuthorization(int StoreCode, string DocumentNumber, decimal Amount)
b. Parmetros de envio: i. StoreCode: Cdigo da loja onde est sendo solicitada a autorizao.
ii. DocumentNumber: Nmero do documento de identificao do cliente (CPF/CNPJ).
iii. Amount: Valor da venda a ser feita em cheque.
c. SOAP de envio:
1
01766688822 8.50
d. Parmetros de retorno: AuthorizationDTO i. Status: Status da solicitao. ii. AuthorizationID: Cdigo de autorizao. iii. Amount: Saldo do cheque do cliente.
iv. Date: N/A v. ErrorMessage: Mensagem de erro, caso houver.
e. SOAP de retorno:
1 12345
100.50
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
7
3. GetPointsAuthorization: Mtodo responsvel por requisitar uma autorizao para dbito em pontos.
a. Assinatura: AuthorizationDTO GetPointsAuthorization(int StoreCode, DocumentType DocumentType, string DocumentNumber, decimal Amount)
b. Parmetros de envio: i. StoreCode: Cdigo da loja onde est sendo solicitada a autorizao.
ii. DocumentType: Tipo de documento de identificao referente ao parmetro pDocumentNumber.
iii. DocumentNumber: Nmero do documento de identificao do cliente. iv. Amount: Valor da venda a ser feita em pontos.
c. SOAP de envio:
1 1
01766688822 8.50
a. Parmetros de retorno: AuthorizationDTO i. Status: Status da solicitao. ii. AuthorizationID: Cdigo de autorizao. iii. Amount: Saldo do pontos do cliente.
iv. Date: N/A v. ErrorMessage: Mensagem de erro, caso houver.
b. SOAP de retorno:
1 12345
100.50
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
8
4. GetAgreementCardAuthorization: Mtodo responsvel por requisitar uma autorizao para dbito em convnio.
a. Assinatura: AuthorizationDTO GetAgreementCardAuthorization(int StoreCode, string DocumentNumber, decimal Amount)
b. Parmetros de envio: i. StoreCode: Cdigo da loja onde est sendo solicitada a autorizao.
ii. DocumentNumber: Nmero do carto convnio do cliente. iii. Amount: Valor da venda a ser feita em convnio.
c. SOAP de envio:
1
1234561926180033 10.00
a. Parmetros de retorno: AuthorizationDTO i. Status: Status da solicitao. ii. AuthorizationID: Cdigo de autorizao.
iii. Amount: Saldo do carto-convnio do cliente. iv. Date: N/A v. ErrorMessage: Mensagem de erro, caso houver.
b. SOAP de retorno:
1
12345 100.50
5. GetFoodCardAuthorization: Mtodo responsvel por requisitar uma autorizao para dbito em carto-alimentao.
a. Assinatura: AuthorizationDTO GetFoodCardAuthorization(int StoreCode, string DocumentNumber, decimal Amount)
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
9
b. Parmetros de envio: i. StoreCode: Cdigo da loja onde est sendo solicitada a autorizao. ii. DocumentNumber: Nmero do carto-alimentao do cliente.
iii. Amount: Valor da venda a ser feita em carto-alimentao. c. SOAP de envio:
1
1234561926180033
10.00
a. Parmetros de retorno: AuthorizationDTO i. Status: Status da solicitao.
ii. AuthorizationID: Cdigo de autorizao. iii. Amount: Saldo do carto-alimentao do cliente.
iv. Date: N/A v. ErrorMessage: Mensagem de erro, caso houver.
b. SOAP de retorno:
1 12345 100.50
6. GetSporadicCardAuthorization: Mtodo responsvel por requisitar uma autorizao para dbito em carto-espordico.
a. Assinatura: AuthorizationDTO GetSporadicCardAuthorization(int StoreCode, string DocumentNumber, decimal Amount)
b. Parmetros de envio:
i. StoreCode: Cdigo da loja onde est sendo solicitada a autorizao. ii. DocumentNumber: Nmero do carto-espordico do cliente. iii. Amount: Valor da venda a ser feita em carto-espordico.
c. SOAP de envio:
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
10
1
1234561926180033 10.00
a. Parmetros de retorno: AuthorizationDTO i. Status: Status da solicitao. ii. AuthorizationID: Cdigo de autorizao.
iii. Amount: Saldo do carto-espordico do cliente. iv. Date: N/A
v. ErrorMessage: Mensagem de erro, caso houver. b. SOAP de retorno:
1 12345 100.50
7. GetSeasonalCardAuthorization: Mtodo responsvel por requisitar uma autorizao para dbito em carto-sazonal.
a. Assinatura: AuthorizationDTO GetSeasonalCardAuthorization(int StoreCode, string DocumentNumber, decimal Amount)
b. Parmetros de envio:
i. StoreCode: Cdigo da loja onde est sendo solicitada a autorizao. ii. DocumentNumber: Nmero do carto-sazonal do cliente. iii. Amount: Valor da venda a ser feita em carto-sazonal.
c. SOAP de envio:
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
11
1
1234561926180033
10.00
a. Parmetros de retorno: AuthorizationDTO
i. Status: Status da solicitao. ii. AuthorizationID: Cdigo de autorizao. iii. Amount: Saldo do carto-sazonal do cliente.
iv. Date: N/A v. ErrorMessage: Mensagem de erro, caso houver.
b. SOAP de retorno:
1
12345 100.50
8. GetCadernetaEletronicaAuthorization: Mtodo responsvel por requisitar uma autorizao para
dbito em caderneta-eletrnica.
a. Assinatura: AuthorizationDTO GetCadernetaEletronicaAuthorization(int StoreCode, string DocumentNumber, decimal Amount)
b. Parmetros de envio: i. StoreCode: Cdigo da loja onde est sendo solicitada a autorizao.
ii. DocumentNumber: Nmero do documento de identificao do cliente (CPF/CNPJ).
iii. Amount: Valor da venda a ser feita em caderneta-eletrnica.
c. SOAP de envio:
1 01766688822
10.00
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
12
a. Parmetros de retorno: AuthorizationDTO i. Status: Status da solicitao. ii. AuthorizationID: Cdigo de autorizao.
iii. Amount: Saldo da caderneta-eletrnica do cliente. iv. Date: N/A
v. ErrorMessage: Mensagem de erro, caso houver. b. SOAP de retorno:
1 12345
100.50
9. GetPrivateLabelAuthorization: Mtodo responsvel por requisitar uma autorizao para dbito em
private-label.
a. Assinatura: AuthorizationDTO GetPrivateLabelAuthorization(int StoreCode, DocumentType DocumentType, string DocumentNumber, decimal Amount)
b. Parmetros de envio:
i. StoreCode: Cdigo da loja onde est sendo solicitada a autorizao. ii. DocumentType: Tipo de documento de identificao referente ao
parmetro pDocumentNumber. iii. DocumentNumber: Nmero do documento de identificao do cliente. iv. Amount: Valor da venda a ser feita em private-label.
c. SOAP de envio:
1 FIN
01766688822 10.00
d. Parmetros de retorno: AuthorizationDTO i. Status: Status da solicitao. ii. AuthorizationID: Cdigo de autorizao.
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
13
iii. Amount: Saldo do private-label do cliente. iv. Date: N/A v. ErrorMessage: Mensagem de erro, caso houver.
e. SOAP de retorno:
1 12345 100.50
10. GetReturnTicketAuthorization: Mtodo responsvel por requisitar uma autorizao para retorno de cupom.
a. Assinatura: AuthorizationDTO GetReturnTicketAuthorization(int StoreCode, DocumentType DocumentType, string DocumentNumber, string COO)
b. Parmetros de envio:
i. StoreCode: Cdigo da loja onde est sendo solicitada a autorizao. ii. DocumentType: Tipo de documento de identificao referente ao
parmetro pDocumentNumber.
iii. DocumentNumber: Nmero do documento de identificao do cliente. iv. COO: Nmero do cupom (COO) a ser devolvido.
c. SOAP de envio:
1 2
1234561626180033
1234567
a. Parmetros de retorno: AuthorizationDTO i. Status: Status da solicitao. ii. AuthorizationID: Cdigo de autorizao.
iii. Amount: N/A iv. Date: N/A
v. ErrorMessage: Mensagem de erro, caso houver.
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
14
b. SOAP de retorno:
1
12345
11. GetPrivateLabelTotal: Mtodo responsvel por requisitar a data e valor da ltima fatura em aberto na modalidade Private Label.
a. Assinatura: AuthorizationDTO GetPrivateLabelTotal(int StoreCode, DocumentType DocumentType, string DocumentNumber)
b. Parmetros de envio: i. StoreCode: Cdigo da loja onde est sendo solicitada a autorizao.
ii. DocumentType: Tipo de documento de identificao referente ao parmetro pDocumentNumber.
iii. DocumentNumber: Nmero do documento de identificao do cliente. c. SOAP de envio:
1
FIN 01766688822
d. Parmetros de retorno: AuthorizationDTO i. Status: Status da solicitao. ii. AuthorizationID: Cdigo de autorizao. iii. Amount: Valor referente ltima fatura.
iv. Date: Data da ltima fatura. v. ErrorMessage: Mensagem de erro, caso houver.
e. SOAP de retorno:
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
15
1
100.50 01/10/2014
12. SetCheckPayment: Mtodo responsvel por confirmar uma venda em cheque.
a. Assinatura: StatusCRMDTO SetCheckPayment(int StoreCode, int POSNumber, int COO, string OperatorId, string CheckDate, string BankNumber, string BankAg, string AccountNumber, string CheckNumber, int AuthorizationID, string DocumentNumber, decimal Amount, string CheckHolderFIN, string Supervisor)
b. Parmetros de envio:
i. StoreCode: Cdigo da loja onde est sendo confirmada a venda. ii. POSNumber: Nmero do PDV.
iii. COO: Nmero do cupom (COO). iv. OperatorId: Cdigo do operador. v. CheckDate: Data do cheque.
vi. BankNumber: Nmero do banco do cheque. vii. BankAg: Nmero da agncia do banco do cheque.
viii. AccountNumber: Nmero da conta do cheque. ix. CheckNumber: Nmero do cheque. x. AuthorizationID: Cdigo de autorizao concedida a partir da transao
GetCheckAuthorization. xi. DocumentNumber: Nmero do documento de identificao do cliente
(CPF/CNPJ). xii. Amount: Valor da venda a ser feita naquele cheque.
xiii. CheckHolderFIN: CPF/CNPJ do dono do cheque. xiv. Supervisor: Cdigo do supervisor necessrio para liberar vendas em que o
cliente no tem saldo suficiente. Se no for o caso, passar 0 (zero). c. SOAP de envio:
1 15
1234567 123
29/08/2014 0033 1720
111888 123456789
1234
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
16
01766688822 12.34 01766655544
0
a. Parmetros de retorno: StatusCRMDTO
i. Status: Status da solicitao. ii. AuthorizationID: Cdigo de autorizao. iii. ErrorMessage: Mensagem de erro, caso houver.
b. SOAP de retorno:
1 12345
13. SetPointsPayment: Mtodo responsvel por confirmar uma venda em pontos.
a. Assinatura: StatusCRMDTO SetPointsPayment(int StoreCode, int POSNumber, int COO, string OperatorId, int AuthorizationID, DocumentType DocumentType, string DocumentNumber, decimal Amount, string Supervisor)
b. Parmetros de envio: i. StoreCode: Cdigo da loja onde est sendo confirmada a venda.
ii. POSNumber: Nmero do PDV. iii. COO: Nmero do cupom (COO).
iv. OperatorId: Cdigo do operador. v. AuthorizationID: Cdigo de autorizao concedida a partir da transao
GetPointsAuthorization.
vi. DocumentType: Tipo de documento de identificao referente ao parmetro pDocumentNumber.
vii. DocumentNumber: Nmero do documento de identificao do cliente. viii. Amount: Valor da venda a ser feita em pontos. ix. Supervisor: Cdigo do supervisor necessrio para liberar vendas em que o
cliente no tem saldo suficiente. Se no for o caso, passar 0 (zero). c. SOAP de envio:
1 15
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
17
1234567 123 1234
1 01766688822
12.34 98
a. Parmetros de retorno: StatusCRMDTO i. Status: Status da solicitao. ii. AuthorizationID: Cdigo de autorizao.
iii. ErrorMessage: Mensagem de erro, caso houver. b. SOAP de retorno:
1
12345
14. SetAgreementCardPayment: Mtodo responsvel por confirmar uma venda em convnio.
a. Assinatura: StatusCRMDTO SetAgreementCardPayment(int StoreCode, int POSNumber, int COO, string OperatorId, int AuthorizationID, string DocumentNumber, decimal Amount, string Supervisor)
b. Parmetros de envio:
i. StoreCode: Cdigo da loja onde est sendo confirmada a venda. ii. POSNumber: Nmero do PDV. iii. COO: Nmero do cupom (COO).
iv. OperatorId: Cdigo do operador. v. AuthorizationID: Cdigo de autorizao concedida a partir da transao
GetAgreementCardAuthorization. vi. DocumentNumber: Nmero do carto-convnio do cliente. vii. Amount: Valor da venda a ser feita em convnio.
viii. Supervisor: Cdigo do supervisor necessrio para liberar vendas em que o cliente no tem saldo suficiente. Se no for o caso, passar 0 (zero).
c. SOAP de envio:
1
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
18
15 1234567 123
1234
1234561626180033 12.34 98
a. Parmetros de retorno: StatusCRMDTO i. Status: Status da solicitao.
ii. AuthorizationID: Cdigo de autorizao. iii. ErrorMessage: Mensagem de erro, caso houver.
b. SOAP de retorno:
1 12345
15. SetFoodCardPayment: Mtodo responsvel por confirmar uma venda em carto-alimentao.
a. Assinatura: StatusCRMDTO SetFoodCardPayment(int StoreCode, int POSNumber, int COO, string OperatorId, int AuthorizationID, string DocumentNumber, decimal Amount, string Supervisor)
b. Parmetros de envio: i. StoreCode: Cdigo da loja onde est sendo confirmada a venda. ii. POSNumber: Nmero do PDV.
iii. COO: Nmero do cupom (COO). iv. OperatorId: Cdigo do operador.
v. AuthorizationID: Cdigo de autorizao concedida a partir da transao GetFoodCardAuthorization.
vi. DocumentNumber: Nmero do carto-alimentao do cliente.
vii. Amount: Valor da venda a ser feita em carto-alimentao. viii. Supervisor: Cdigo do supervisor necessrio para liberar vendas em que o
cliente no tem saldo suficiente. Se no for o caso, passar 0 (zero). c. SOAP de envio:
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
19
1 15 1234567
123 1234
1234561626180033 12.34
0
a. Parmetros de retorno: StatusCRMDTO i. Status: Status da solicitao. ii. AuthorizationID: Cdigo de autorizao. iii. ErrorMessage: Mensagem de erro, caso houver.
b. SOAP de retorno:
1 12345
16. SetSporadicCardPayment: Mtodo responsvel por confirmar uma venda em carto-espordico.
a. Assinatura: StatusCRMDTO SetSporadicCardPayment(int StoreCode, int POSNumber, int COO, string OperatorId, int AuthorizationID, string DocumentNumber, decimal Amount, string Supervisor)
b. Parmetros de envio: i. StoreCode: Cdigo da loja onde est sendo confirmada a venda.
ii. POSNumber: Nmero do PDV. iii. COO: Nmero do cupom (COO).
iv. OperatorId: Cdigo do operador. v. AuthorizationID: Cdigo de autorizao concedida a partir da transao
GetSporadicCardAuthorization.
vi. DocumentNumber: Nmero do carto-espordico do cliente. vii. Amount: Valor da venda a ser feita em carto-espordico.
viii. Supervisor: Cdigo do supervisor necessrio para liberar vendas em que o cliente no tem saldo suficiente. Se no for o caso, passar 0 (zero).
c. SOAP de envio:
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
20
1 15
1234567 123
1234 1234561626180033
12.34 0
a. Parmetros de retorno: StatusCRMDTO i. Status: Status da solicitao. ii. AuthorizationID: Cdigo de autorizao.
iii. ErrorMessage: Mensagem de erro, caso houver. b. SOAP de retorno:
1
12345
17. SetSeasonalCardPayment: Mtodo responsvel por confirmar uma venda em carto-sazonal.
a. Assinatura: StatusCRMDTO SetSeasonalCardPayment(int StoreCode, int POSNumber, int COO, string OperatorId, int AuthorizationID, string DocumentNumber, decimal Amount, string Supervisor)
b. Parmetros de envio:
i. StoreCode: Cdigo da loja onde est sendo confirmada a venda. ii. POSNumber: Nmero do PDV.
iii. COO: Nmero do cupom (COO). iv. OperatorId: Cdigo do operador. v. AuthorizationID: Cdigo de autorizao concedida a partir da transao
GetSeasonalCardAuthorization. vi. DocumentNumber: Nmero do carto-sazonal do cliente.
vii. Amount: Valor da venda a ser feita em carto-sazonal. viii. Supervisor: Cdigo do supervisor necessrio para liberar vendas em que o
cliente no tem saldo suficiente. Se no for o caso, passar 0 (zero). c. SOAP de envio:
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
21
1
15 1234567
123 1234
1234561626180033 12.34
0
a. Parmetros de retorno: StatusCRMDTO i. Status: Status da solicitao.
ii. AuthorizationID: Cdigo de autorizao. iii. ErrorMessage: Mensagem de erro, caso houver.
b. SOAP de retorno:
1 12345
18. SetCadernetaEletronicaPayment: Mtodo responsvel por confirmar uma venda em caderneta
eletrnica.
a. Assinatura: StatusCRMDTO SetCadernetaEletronicaPayment(int StoreCode, int POSNumber, int COO, string OperatorId, int AuthorizationID, string DocumentNumber, decimal Amount, string Supervisor)
b. Parmetros de envio:
i. StoreCode: Cdigo da loja onde est sendo confirmada a venda. ii. POSNumber: Nmero do PDV. iii. COO: Nmero do cupom (COO).
iv. OperatorId: Cdigo do operador. v. AuthorizationID: Cdigo de autorizao concedida a partir da transao
GetCadernetaEletronicaAuthorization. vi. DocumentNumber: Nmero do documento de identificao do cliente
(CPF/CNPJ). vii. Amount: Valor da venda a ser feita em caderneta eletrnica. viii. Supervisor: Cdigo do supervisor necessrio para liberar vendas em que o
cliente no tem saldo suficiente. Se no for o caso, passar 0 (zero). c. SOAP de envio:
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
22
1 15
1234567 123
1234
1234561626180033 12.34 0
a. Parmetros de retorno: StatusCRMDTO i. Status: Status da solicitao. ii. AuthorizationID: Cdigo de autorizao.
iii. ErrorMessage: Mensagem de erro, caso houver. b. SOAP de retorno:
1 12345
19. SetPrivateLabelPayment: Mtodo responsvel por confirmar uma venda em private-label.
a. Assinatura: StatusCRMDTO SetPrivateLabelPayment(int StoreCode, int POSNumber, int COO, string OperatorId, int AuthorizationID, DocumentType DocumentType, string DocumentNumber, decimal Amount, string Supervisor)
b. Parmetros de envio: i. StoreCode: Cdigo da loja onde est sendo confirmada a venda.
ii. POSNumber: Nmero do PDV. iii. COO: Nmero do cupom (COO).
iv. OperatorId: Cdigo do operador. v. AuthorizationID: Cdigo de autorizao concedida a partir da transao
GetPrivateLabelAuthorization.
vi. DocumentType: Tipo de documento de identificao referente ao parmetro pDocumentNumber.
vii. DocumentNumber: Nmero do documento de identificao do cliente. viii. Amount: Valor da venda a ser feita em private-label.
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
23
ix. Supervisor: Cdigo do supervisor necessrio para liberar vendas em que o cliente no tem saldo suficiente. Se no for o caso, passar 0 (zero).
c. SOAP de envio:
1 15
1234567 123 1234
FIN 01766688822
12.34 0
d. Parmetros de retorno: StatusCRMDTO i. Status: Status da solicitao. ii. AuthorizationID: Cdigo de autorizao. iii. ErrorMessage: Mensagem de erro, caso houver.
e. SOAP de retorno:
1 12345
20. SetPrivateLabelTotal: Mtodo responsvel efetuar o pagamento total ou parcial de uma fatura do
private-label.
a. Assinatura: StatusCRMDTO SetPrivateLabelTotal(int StoreCode, int POSNumber, int COO, string OperatorId, DocumentType DocumentType, string DocumentNumber, decimal Amount)
b. Parmetros de envio: i. StoreCode: Cdigo da loja onde est sendo confirmada a venda.
ii. POSNumber: Nmero do PDV. iii. COO: Nmero do cupom (COO). iv. OperatorId: Cdigo do operador.
v. DocumentType: Tipo de documento de identificao referente ao parmetro pDocumentNumber.
vi. DocumentNumber: Nmero do documento de identificao do cliente.
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
24
vii. Amount: Valor da venda a ser feita em private-label. c. SOAP de envio:
1
15 1234567
123 FIN 01766688822
12.34
d. Parmetros de retorno: StatusCRMDTO i. Status: Status da solicitao.
ii. AuthorizationID: N/A iii. Amount: N/A
iv. Date: N/A v. ErrorMessage: Mensagem de erro, caso houver.
e. SOAP de retorno:
1
21. SetReturnTicket: Mtodo responsvel por confirmar uma devoluo de cupom.
a. Assinatura: StatusCRMDTO SetReturnTicket(ModalType Modalidade, int StoreCode, int POSNumber, int COO, string OperatorId, int AuthorizationID, DocumentType DocumentType, string DocumentNumber, decimal Amount, string Supervisor)
b. Parmetros de envio: i. Modalidade: Tipo da forma de pagamento a ser devolvida. ii. StoreCode: Cdigo da loja onde est sendo confirmada a devoluo.
iii. POSNumber: Nmero do PDV. iv. COO: Nmero do cupom (COO).
v. OperatorId: Cdigo do operador.
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
25
vi. AuthorizationID: Cdigo de autorizao concedida a partir da transao GetReturnTicketAuthorization.
vii. DocumentType: Tipo de documento de identificao referente ao
parmetro pDocumentNumber. viii. DocumentNumber: Nmero do documento de identificao do cliente.
ix. Amount: Valor da venda a ser devolvida. x. Supervisor: Cdigo do supervisor necessrio para liberar vendas em que o
cliente no tem saldo suficiente. Se no for o caso, passar 0 (zero). c. SOAP de envio:
3
1 15 1234567
123 1234
2 1234561626180033
12.34 0
d. Parmetros de retorno: StatusCRMDTO i. Status: Status da solicitao. ii. AuthorizationID: Cdigo de autorizao.
iii. ErrorMessage: Mensagem de erro, caso houver. e. SOAP de retorno:
1
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
26
22. SetNotifySaleToEarnPoints: Mtodo responsvel por enviar uma notificao de venda em formas de pagamento no CRM para que estas possam tambm pontuar.
a. Assinatura: StatusCRMDTO SetNotifySaleToEarnPoints(ModalType Modalidade, int StoreCode, int POSNumber, int COO, string OperatorId, DocumentType DocumentType, string DocumentNumber, decimal Amount)
b. Parmetros de envio i. Modalidade: Tipo da forma de pagamento no CRM.
ii. StoreCode: Cdigo da loja. iii. POSNumber: Nmero do PDV. iv. COO: Nmero do cupom (COO).
v. OperatorId: Cdigo do operador. vi. DocumentType: Tipo de documento de identificao referente ao
parmetro pDocumentNumber. vii. DocumentNumber: Nmero do documento de identificao do cliente.
viii. Amount: Valor da venda feita numa forma de pagamento no CRM. c. SOAP de envio:
Cash
1 15 1234567
123 FIN
01766688822 12.34
d. Parmetros de retorno: StatusCRMDTO i. Status: Status da solicitao. ii. AuthorizationID: Cdigo de autorizao. iii. Amount: N/A
iv. Date: N/A v. ErrorMessage: Mensagem de erro, caso houver.
e. SOAP de retorno:
1
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
27
23. ChangeCardPassword: Mtodo responsvel por alterar a senha de um carto.
a. Assinatura: StatusCRMDTO ChangeCardPassword(string DocumentNumber, string NewPassword)
b. Parmetros de envio:
i. DocumentNumber: Nmero do documento de identificao do cliente. ii. NewPassword: Nova senha digitada pelo cliente.
c. SOAP de envio:
1234561626180033
1234
d. Parmetros de retorno: StatusCRMDTO i. Status: Status da solicitao.
ii. AuthorizationID: Cdigo de autorizao. iii. ErrorMessage: Mensagem de erro, caso houver.
e. SOAP de retorno:
0
Exportao de Cadastro
Para integrao do mdulo Exportao de Cadastro, dispomos dos mtodos listados abaixo:
1. GetProducts: Mtodo responsvel por exportar os dados completos dos produtos alterados.
a. Assinatura: List GetProducts(int StoreCode, ExportType ExportType) b. Parmetros de envio:
i. StoreCode: Cdigo da loja da exportao.
ii. ExportType: Tipo da exportao a ser realizada. c. SOAP de envio:
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
28
1
All
d. Parmetros de retorno: List i. Code: Cdigo interno. ii. EANCode: EAN. iii. Description: Descrio.
iv. Price: Preo. v. Quantity: Quantidade.
vi. TaxCode: Alquota. vii. SalePackType: Unidade de medida.
e. SOAP de retorno:
13656 7897144907943
Pasta Catlogo 50Fls Grosso - PlastPark
8,95 1 12,00
UN
13658 7897144901866
Pasta Portiflio A3 - c/10 plsticos - R
0 5,68
15,00 UN
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
29
2. GetSalesmen: Mtodo responsvel por obter os dados completos dos vendedores (vendas assistidas).
a. Assinatura: List GetSalesmen(int StoreCode) b. Parmetros de envio:
i. StoreCode: Cdigo da loja da exportao. c. SOAP de envio:
1
d. Parmetros de retorno: List i. Code: Cdigo interno.
ii. CommissionSales: Percentual de comisso. iii. Name: Nome. iv. PercentageDiscountSales: Percentual de desconto permitido nas vendas.
e. SOAP de retorno:
2065
1 CAMILA MARIA BATISTA SILVA
2070
1 EVELIN RODRIGUES MARTINI
2012 1 Elisabeth Suhr de Jesus
7744 1 RICARDO FORMENTO PS
2002 0.05 VENDAS COLETIVAS LOJA1 PS
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
30
3. GetCashier: Mtodo responsvel por obter exportar os dados referentes aos operadores de caixa
(PDV).
a. Assinatura: List GetCashier(int StoreCode) b. Parmetros de envio:
i. StoreCode: Cdigo da loja da exportao.
c. SOAP de envio:
1
d. Parmetros de retorno: List i. Code: Cdigo interno. ii. Name: Nome do operador.
e. SOAP de retorno:
13656 ANDERSON PELUCIA
13658 LUIS PAULO
Importao de Movimentos
Para integrao do mdulo Importao de Movimentos, dispomos dos mtodos listados abaixo:
1. SetInvoice: Mtodo responsvel por importar os dados de um cupom.
a. Assinatura: StatusDTO SetInvoice(InvoiceDTO InvoiceDTO) b. Parmetros de envio:
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
31
i. AdditionAmount: Valor de acrscimo concedido ao cupom. ii. AdditionProductsAmount: Valor total de acrscimos concedidos aos
produtos do cupom.
iii. AdditionType: Tipo do acrscimo dado no total do cupom. iv. CCF: CCF
v. COO: COO vi. CancelledFlag: Flag que determina se o cupom foi ou no cancelado. vii. CancelledProductsAmount: Valor total de produtos cancelados do cupom.
viii. Change: Valor de troco. ix. CustomerAddress: Endereo do cliente CRM.
x. CustomerCRMID: Cdigo interno do cliente CRM. xi. CustomerID: Nmero de identificao do cliente CRM.
xii. CustomerName: Nome do cliente CRM. xiii. Date: Data de registro. xiv. DiscountAmount: Valor total de descontos concedidos no total do cupom
(no vinculado aos produtos). xv. DiscountProductsAmount: Valor total de descontos concedidos aos
produtos do cupom. xvi. DiscountType: Tipo do desconto dado no total do cupom. xvii. EndIssuanceDate: Data de registro final do cupom.
xviii. EndTime: Hora de registro final do cupom. xix. ExportedFlag: N/A.
xx. GrossAmount: Valor bruto. xxi. InitialIssuanceDate: Data de registro inicial do cupom. xxii. MovDate: Data de movimento.
xxiii. NetAmount: Valor lquido. xxiv. OperatorID: Cdigo do operador.
xxv. POSNumber: Nmero do PDV. xxvi. SalesmanID: Cdigo do vendedor. xxvii. StartTime: Hora de registro inicial do cupom.
xxviii. StoreCode: Cdigo da loja. xxix. Items: Lista de produtos do cupom (tipo InvoiceItemDTO)
1. AdditionAmount: Valor de acrscimo concedido ao produto. 2. EAN: EAN do produto 3. CancelledAmount: Valor de produtos cancelados.
4. CancelledFlag: Flag que determina se o produto inteiro foi ou no cancelado.
5. CancelledQuantity: Quantidade de produtos cancelados. 6. Description: Descrio do produto. 7. DigitID: Dgito interno do produto.
8. DiscountAmount: Valor do desconto concedido ao produto. 9. ID: Cdigo interno do produto.
10.MeasureUnit: Unidade de medida. 11.PackQuantity: Quantidade na embalagem. 12.Quantity: Quantidade do produto.
13.Seq: Sequencial do produto. 14.TaxAmount: Valor de imposto sobre o produto.
15.TaxCode: Cdigo do imposto. 16.TaxPerc: Percentual do imposto.
17.TaxType: Tipo do imposto. 18.TotalAmount: Valor total do produto. 19.UnitPrice: Preo unitrio.
20.ValueTaxLaw: Valor de imposto (IBPT) referente impresso no cupom.
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
32
xxx. Tender: Lista de formas de pagamento do cupom. 1. Amount: Valor pago nessa forma de pagamento. 2. BINCode: Cdigo do BIN do carto.
3. BandeiraCode: Cdigo da bandeira SITEF. 4. CancelledFlag: Flag que determina se a forma de pagamento foi ou
no cancelado. 5. CardType: 1-Dbito / 2-Crdito 6. Change: Valor do troco nessa forma de pagamento.
7. CompanyCode: Cdigo do estabelecimento SITEF. 8. Description: Descrio da forma de pagamento
9. GNF: GNF 10.ID: Cdigo da forma de pagamento.
11.NSUCode: Cdigo NSU SITEF. 12.NetworkCode: Cdigo da rede SITEF. 13.Seq: Sequencial da forma de pagamento.
c. SOAP de envio:
0
0 $
123456 1990
false 0
0
2014-05-05 0
0 $
2014-05-04 15:30:01
1.00 2014-05-
04 2014-05-04 1.00
1010 69
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
33
8479 15:32:05 1
1 7891025103219
0 false
0 CINQUENTA TONS DE
CI 8 0
0005 UN
0 1 01
7 3
12 T 1.00
1.00 1
1.00 0 0
false 0
0 0 Dinheiro
987456 60
0 0 1
d. Parmetros de retorno: StatusImportDTO i. Status: Status da finalizao.
ii. AuthorizationID: Cdigo da autorizao.
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
34
e. SOAP de retorno:
1
2. SetLift: Mtodo responsvel por importar os dados de uma sangria.
a. Assinatura: StatusImportDTO SetLift(LiftDTO LiftDTO) b. Parmetros de envio:
i. Amount: Valor. ii. COO: COO.
iii. Date: Data de registro. iv. GNF: GNF.
v. MovDate: Data de movimento. vi. OperatorId: Cdigo do operador. vii. POSNumber: Nmero do PDV.
viii. StoreCode: Cdigo da loja da exportao. ix. TenderCode: Cdigo da forma de pagamento.
x. TenderDescription: Descrio da forma de pagamento impressa na sangria.
c. SOAP de envio:
1 1010
2014-05-03 10
2014-05-03 1010 69
1 40
Dinheiro
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
35
d. Parmetros de retorno: StatusImportDTO e. SOAP de retorno:
1
3. SetService: Mtodo responsvel por importar os dados de um servio (recarga e correspondente bancrio).
a. Assinatura: StatusImportDTO SetService(ServiceDTO ServiceDTO) b. Parmetros de envio:
i. COO: COO. ii. CPFCNPJCustomer: CPJ/CNPJ do cliente.
iii. Change: Troco. iv. CustomerAddress: Endereo do cliente. v. CustomerName: Nome do cliente.
vi. Date: Data de registro. vii. MovDate: Data do movimento.
viii. DiscountAmount: Valor de desconto concedido. ix. CancelledFlag: Flag que determina se o servio foi ou no cancelado. x. OperatorId: Cdigo do operador.
xi. POSNumber: Nmero do PDV. xii. Type: Tipo do servio (1-Recarga; 2-Correspondente Bancrio).
xiii. Amount: Valor. xiv. StoreCode: Cdigo da loja da exportao.
c. SOAP de envio:
4545
0
Paulo 2014-06-03 15:13:00 2014-06-03
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
36
0 false 1010
1 2
10 1
d. Parmetros de retorno: StatusImportDTO e. SOAP de retorno:
1
4. SetSupply: Mtodo responsvel por importar os dados de um suprimento.
a. Assinatura: StatusImportDTO SetSupply(SupplyDTO SupplyDTO) b. Parmetros de envio:
i. Amout: Valor do suprimento.
ii. COO: COO. iii. Date: Data de registro.
iv. MovDate: Data do movimento. v. OperatorId: Cdigo do operador. vi. POSNumber: Nmero do PDV.
vii. StoreCode: Cdigo da loja da exportao. viii. SupervisorCode: Cdigo do supervisor.
ix. TenderCode: Cdigo da finalizadora. c. SOAP de envio:
1.99 4545 2014-06-03 12:34:45
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
37
2014-06-03 1010 69
1 20
1
d. Parmetros de retorno: StatusImportDTO e. SOAP de retorno:
1
5. SetZRead: Mtodo responsvel por importar os dados de uma leitura Z.
a. Assinatura: StatusImportDTO SetZRead(ZReadDTO ZReadDTO) b. Parmetros de envio:
i. COO: COO. ii. CRO: CRO.
iii. CRZ: CRZ. iv. CancelledAmount: Valor total de cancelamentos.
v. Date: Data de registro. vi. DiscountAmount: Valor total de descontos. vii. FinalGT: GT final.
viii. GrossAmount: Valor bruto. ix. InitialGT: GT inicial.
x. MovDate: Data do movimento. xi. POSNumber: Nmero do PDV.
xii. StoreCode: Cdigo da loja da exportao. xiii. Taxes: Taxas de imposto.
1. Amount: Valor.
2. BaseCalc: Base de clculo. 3. ID: Cdigo.
4. Percentage: Percentual da alquota. 5. Type: Tipo da alquota.
c. SOAP de envio:
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
38
xmlns:rms="http://schemas.datacontract.org/2004/07/RMS.WS.Import.DataTypes">
1978 212
987 10.99
2014-06-04 0
318092.60 1.00 715245.48
2014-06-04 69
1
0.17
2.46 1 7
SF
d. Parmetros de retorno: StatusImportDTO e. SOAP de retorno:
1
-
GUIA RPIDO WEBSERVICE VERSO 1.1 - RMS Software S.A. - Uma empresa TOTVS. Todos Direitos Reservados.
39
Anexo I
1. DocumentType (Enumerador) Tipo de documento de identificao.
Campo Contedo Tipo Tamanho
Int Dec
ID Cdigo Interno 0 Int
FIN CPF/CNPJ 1 Int
CardNumber Nmero de carto 2 Int
2. FINType (Enumerador) Tipo de documentao fiscal.
Campo Contedo Tipo Tamanho
Int Dec
CPF CPF 0 Int
CNPJ CNPJ 1 Int
3. ModalType (Enumerador) Tipo de modalidade.
Campo Contedo Tipo Tamanho
Int Dec
Check Cheque 1 Int
CadernetaEletronica Caderneta Eletrnica 2 Int
AgreementCard Convnio 3 Int
PrivateLabel Private Label 4 Int
FoodCard Carto-Alimentao 8 Int
SporadicCard Carto-Espordico 9 Int
SeasonalCard Carto-Sazonal 10 Int
Points Pontos 98 Int
4. CustomerStatus (Enumerador) Status do cliente.
Campo Contedo Tipo Tamanho
Int Dec
Enabled Habilitado 0 Int
Disabled Desabilitado 1 Int
5. ExportType (Enumerador) Tipo de exportao.
Campo Contedo Tipo Tamanho
Int Dec
All Exportao Geral 0 Int
Changed Exportao de produtos alterados 1 Int
OBSERVAES
1. O nmero de autorizao criado em um GetCheckAuthorization, por exemplo, deve ser enviado na notificao de venda (SetCheckPayment).
2. Cada transao SetCheckPayment equivalente a uma parcela de cheque. Por exemplo, em uma compra em trs parcelas em cheque, o PDV dever enviar uma transao GetCheckAuthorization com o valor total da compra e trs transaes SetCheckPayment com os dados de cada parcela.