Bem vindo a API reference do gateway de credenciados da Funcional

Queries

Pharma_assessEligibility

Description

A partir de um CPF e EAN, avalia se o produto pertence à algum programa, e se o CPF precisa ser cadastrado no programa ou no produto específico

Response

Returns a Pharma_AssessEligibilityResponse!

Arguments
Name Description
origin - Pharma_AuthorizationOrigin! Origem da solicitação
storeCode - String! CNPJ da origem que deseja efetuar o cadastro
productCode - String! EAN (Código de barras de 13 dígitos) do produto
customerCode - String! CPF do beneficiário

Example

Query
query Pharma_assessEligibility(
  $origin: Pharma_AuthorizationOrigin!,
  $storeCode: String!,
  $productCode: String!,
  $customerCode: String!
) {
  Pharma_assessEligibility(
    origin: $origin,
    storeCode: $storeCode,
    productCode: $productCode,
    customerCode: $customerCode
  ) {
    validationResult {
      ...Pharma_ValidationResultFragment
    }
    eligibilityAssessment {
      ...Pharma_EligibilityAssessmentFragment
    }
    registrationPolicy {
      ...Pharma_RegistrationPolicyFragment
    }
    dependents {
      ...Pharma_DependentFragment
    }
  }
}
Variables
{
  "origin": "DTS",
  "storeCode": "xyz789",
  "productCode": "xyz789",
  "customerCode": "abc123"
}
Response
{
  "data": {
    "Pharma_assessEligibility": {
      "validationResult": Pharma_ValidationResult,
      "eligibilityAssessment": Pharma_EligibilityAssessment,
      "registrationPolicy": Pharma_RegistrationPolicy,
      "dependents": [Pharma_Dependent]
    }
  }
}
Queries

Pharma_checkPricesAndRules

Description

Consultar preço e regras

Response

Returns a Pharma_Authorization

Arguments
Name Description
origin - Pharma_AuthorizationOrigin! Origem da solicitação
storeCode - String! CNPJ do estabelecimento
customerCode - String! Identificação do consumidor (cartão Benefits ou CPF para Pharma)
products - [Pharma_ItemArgs!]! Produtos

Example

Query
query Pharma_checkPricesAndRules(
  $origin: Pharma_AuthorizationOrigin!,
  $storeCode: String!,
  $customerCode: String!,
  $products: [Pharma_ItemArgs!]!
) {
  Pharma_checkPricesAndRules(
    origin: $origin,
    storeCode: $storeCode,
    customerCode: $customerCode,
    products: $products
  ) {
    aproved
    createdAt
    totalValue
    moneyPaidValue
    cardPaidValue
    totalValueMaxConsumerPrice
    totalValueWithPrescription
    totalValueWithoutPrescription
    totalDiscountAmount
    products {
      ...Pharma_AuthorizationItemFragment
    }
    requiredUploadWithPrescription
  }
}
Variables
{
  "origin": "DTS",
  "storeCode": "xyz789",
  "customerCode": "xyz789",
  "products": [Pharma_ItemArgs]
}
Response
{
  "data": {
    "Pharma_checkPricesAndRules": {
      "aproved": false,
      "createdAt": "2007-12-03T10:15:30Z",
      "totalValue": 123.45,
      "moneyPaidValue": 123.45,
      "cardPaidValue": 123.45,
      "totalValueMaxConsumerPrice": 123.45,
      "totalValueWithPrescription": 123.45,
      "totalValueWithoutPrescription": 987.65,
      "totalDiscountAmount": 123.45,
      "products": [Pharma_AuthorizationItem],
      "requiredUploadWithPrescription": false
    }
  }
}
Queries

Pharma_discountPrograms

Description

Consultar a base de programas da indústria e seus produtos a partir de um CNPJ

Response

Returns [Pharma_PharmaProgram!]!

Arguments
Name Description
storeCode - String! CNPJ do estabelecimento
origin - Pharma_AuthorizationOrigin Origem da solicitação

Example

Query
query Pharma_discountPrograms(
  $storeCode: String!,
  $origin: Pharma_AuthorizationOrigin
) {
  Pharma_discountPrograms(
    storeCode: $storeCode,
    origin: $origin
  ) {
    id
    name
    url
    allowedOrigins
    rules {
      ...Pharma_PharmaProgramRuleFragment
    }
  }
}
Variables
{"storeCode": "xyz789", "origin": "DTS"}
Response
{
  "data": {
    "Pharma_discountPrograms": [
      {
        "id": "4",
        "name": "xyz789",
        "url": "abc123",
        "allowedOrigins": [123],
        "rules": [Pharma_PharmaProgramRule]
      }
    ]
  }
}
Queries

Pharma_displayProductDiscountRules

Description

Consulta informações sobre as regras de desconto de um produto para exibição em uma interface gráfica

Response

Returns [Pharma_DisplayProductDiscountRules!]

Arguments
Name Description
storeCode - String! CNPJ do estabelecimento
productEan - String! EAN do produto
customerCode - String CPF do paciente
origin - Pharma_AuthorizationOrigin Origem da solicitação
detailed - Boolean Consulta resumida

Example

Query
query Pharma_displayProductDiscountRules(
  $storeCode: String!,
  $productEan: String!,
  $customerCode: String,
  $origin: Pharma_AuthorizationOrigin,
  $detailed: Boolean
) {
  Pharma_displayProductDiscountRules(
    storeCode: $storeCode,
    productEan: $productEan,
    customerCode: $customerCode,
    origin: $origin,
    detailed: $detailed
  ) {
    status
    statusMessage
    products {
      ...Pharma_PharmaProductFragment
    }
    messages
    nameProgram
    priority
    discounts {
      ...Pharma_PurchaseDiscountFragment
    }
  }
}
Variables
{
  "storeCode": "xyz789",
  "productEan": "xyz789",
  "customerCode": "abc123",
  "origin": "DTS",
  "detailed": true
}
Response
{
  "data": {
    "Pharma_displayProductDiscountRules": [
      {
        "status": "xyz789",
        "statusMessage": "xyz789",
        "products": [Pharma_PharmaProduct],
        "messages": ["xyz789"],
        "nameProgram": "xyz789",
        "priority": 123.45,
        "discounts": [Pharma_PurchaseDiscount]
      }
    ]
  }
}
Queries

Pharma_prescriber

Description

Consulta um prescritor existe ativamente

Response

Returns a Pharma_ValidationResult!

Arguments
Name Description
data - Pharma_PrescriberRegisterInput! Dados do prescritor

Example

Query
query Pharma_prescriber($data: Pharma_PrescriberRegisterInput!) {
  Pharma_prescriber(data: $data) {
    status
    message
    errors {
      ...Pharma_ValidationErrorFragment
    }
  }
}
Variables
{"data": Pharma_PrescriberRegisterInput}
Response
{
  "data": {
    "Pharma_prescriber": {
      "status": "SUCCESS",
      "message": "abc123",
      "errors": [Pharma_ValidationError]
    }
  }
}
Queries

Pharma_retrieveTextTermsOptIn

Description

Consulta os termos de aceite de determinado programa, seu link e código de envio para o beneficiário informado.

Response

Returns a Pharma_TextoTermosOptInResponse!

Arguments
Name Description
origin - Pharma_AuthorizationOrigin! Origem da solicitação
input - Pharma_TextoTermosOptInRequest! Dados do produto e do beneficiário

Example

Query
query Pharma_retrieveTextTermsOptIn(
  $origin: Pharma_AuthorizationOrigin!,
  $input: Pharma_TextoTermosOptInRequest!
) {
  Pharma_retrieveTextTermsOptIn(
    origin: $origin,
    input: $input
  ) {
    CodigoEnvio
    TextoTermos
    LinkTermos
    Status
    Mensagem
  }
}
Variables
{"origin": "DTS", "input": Pharma_TextoTermosOptInRequest}
Response
{
  "data": {
    "Pharma_retrieveTextTermsOptIn": {
      "CodigoEnvio": "abc123",
      "TextoTermos": "abc123",
      "LinkTermos": "abc123",
      "Status": "abc123",
      "Mensagem": "abc123"
    }
  }
}
Queries

Pharma_verifyOptIn

Description

Consulta se um determinado beneficiário já aceitou os termos de um programa, e se esse aceite é obrigatório ou não.

Response

Returns a Pharma_OptInResponse!

Arguments
Name Description
origin - Pharma_AuthorizationOrigin! Origem da solicitação
input - Pharma_OptInRequest! Dados do produto e do beneficiário

Example

Query
query Pharma_verifyOptIn(
  $origin: Pharma_AuthorizationOrigin!,
  $input: Pharma_OptInRequest!
) {
  Pharma_verifyOptIn(
    origin: $origin,
    input: $input
  ) {
    OptInRealizado
    OptInObrigatorio
    Mensagem
  }
}
Variables
{"origin": "DTS", "input": Pharma_OptInRequest}
Response
{
  "data": {
    "Pharma_verifyOptIn": {
      "OptInRealizado": "abc123",
      "OptInObrigatorio": "xyz789",
      "Mensagem": "abc123"
    }
  }
}
Queries

Prescription_prescriber

Response

Returns a Prescription_Prescriber

Arguments
Name Description
enrollment - String! Número de registro
council - Prescription_CouncilTypeEnum! Conselho profissional
fu - String! Sigla do estado (unidade federativa)

Example

Query
query Prescription_prescriber(
  $enrollment: String!,
  $council: Prescription_CouncilTypeEnum!,
  $fu: String!
) {
  Prescription_prescriber(
    enrollment: $enrollment,
    council: $council,
    fu: $fu
  ) {
    name
    enrollment
    council
    fu
    active
  }
}
Variables
{
  "enrollment": "xyz789",
  "council": "CRM",
  "fu": "xyz789"
}
Response
{
  "data": {
    "Prescription_prescriber": {
      "name": "xyz789",
      "enrollment": 987.65,
      "council": "CRM",
      "fu": "abc123",
      "active": false
    }
  }
}
Queries

Prescription_prescriptionById

Response

Returns a Prescription_Prescription

Arguments
Name Description
id - ID!

Example

Query
query Prescription_prescriptionById($id: ID!) {
  Prescription_prescriptionById(id: $id) {
    id
    uploadedAt
    deletedAt
    expiresAt
    source
    file
    name
    cardNumber
    identity
    status
    storage
    originalName
    extension
    prescriptionName
    dateIssuance
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "Prescription_prescriptionById": {
      "id": "4",
      "uploadedAt": "2007-12-03T10:15:30Z",
      "deletedAt": "2007-12-03T10:15:30Z",
      "expiresAt": "2007-12-03T10:15:30Z",
      "source": "MOBILE_APP",
      "file": {},
      "name": "abc123",
      "cardNumber": "abc123",
      "identity": "xyz789",
      "status": "ACTIVE",
      "storage": "xyz789",
      "originalName": "xyz789",
      "extension": "xyz789",
      "prescriptionName": "abc123",
      "dateIssuance": "abc123"
    }
  }
}
Queries

Prescription_prescriptionsByCard

Response

Returns [Prescription_Prescription!]!

Arguments
Name Description
cardNumber - String!
pagination - Prescription_PaginationInput! Default = {page: 1, take: 25}

Example

Query
query Prescription_prescriptionsByCard(
  $cardNumber: String!,
  $pagination: Prescription_PaginationInput!
) {
  Prescription_prescriptionsByCard(
    cardNumber: $cardNumber,
    pagination: $pagination
  ) {
    id
    uploadedAt
    deletedAt
    expiresAt
    source
    file
    name
    cardNumber
    identity
    status
    storage
    originalName
    extension
    prescriptionName
    dateIssuance
  }
}
Variables
{
  "cardNumber": "xyz789",
  "pagination": {"page": 1, "take": 25}
}
Response
{
  "data": {
    "Prescription_prescriptionsByCard": [
      {
        "id": 4,
        "uploadedAt": "2007-12-03T10:15:30Z",
        "deletedAt": "2007-12-03T10:15:30Z",
        "expiresAt": "2007-12-03T10:15:30Z",
        "source": "MOBILE_APP",
        "file": {},
        "name": "abc123",
        "cardNumber": "xyz789",
        "identity": "xyz789",
        "status": "ACTIVE",
        "storage": "abc123",
        "originalName": "xyz789",
        "extension": "abc123",
        "prescriptionName": "abc123",
        "dateIssuance": "xyz789"
      }
    ]
  }
}
Queries

Prescription_prescriptionsByCardBetween

Response

Returns [Prescription_Prescription!]!

Arguments
Name Description
cardNumber - String!
filter - Prescription_TimeRangeFilterInput!

Example

Query
query Prescription_prescriptionsByCardBetween(
  $cardNumber: String!,
  $filter: Prescription_TimeRangeFilterInput!
) {
  Prescription_prescriptionsByCardBetween(
    cardNumber: $cardNumber,
    filter: $filter
  ) {
    id
    uploadedAt
    deletedAt
    expiresAt
    source
    file
    name
    cardNumber
    identity
    status
    storage
    originalName
    extension
    prescriptionName
    dateIssuance
  }
}
Variables
{
  "cardNumber": "xyz789",
  "filter": Prescription_TimeRangeFilterInput
}
Response
{
  "data": {
    "Prescription_prescriptionsByCardBetween": [
      {
        "id": 4,
        "uploadedAt": "2007-12-03T10:15:30Z",
        "deletedAt": "2007-12-03T10:15:30Z",
        "expiresAt": "2007-12-03T10:15:30Z",
        "source": "MOBILE_APP",
        "file": {},
        "name": "xyz789",
        "cardNumber": "xyz789",
        "identity": "abc123",
        "status": "ACTIVE",
        "storage": "xyz789",
        "originalName": "abc123",
        "extension": "xyz789",
        "prescriptionName": "abc123",
        "dateIssuance": "xyz789"
      }
    ]
  }
}
Queries

Prescription_prescriptionsByCardHolderAndDependent

Response

Returns a Prescription_Holder

Arguments
Name Description
cardNumber - String!
dependentCardNumber - [String!] Default = []
pagination - Prescription_PaginationInput! Default = {page: 1, take: 25}
filter - Prescription_TimeRangeFilterInput!

Example

Query
query Prescription_prescriptionsByCardHolderAndDependent(
  $cardNumber: String!,
  $dependentCardNumber: [String!],
  $pagination: Prescription_PaginationInput!,
  $filter: Prescription_TimeRangeFilterInput!
) {
  Prescription_prescriptionsByCardHolderAndDependent(
    cardNumber: $cardNumber,
    dependentCardNumber: $dependentCardNumber,
    pagination: $pagination,
    filter: $filter
  ) {
    cardNumber
    prescriptions {
      ...Prescription_PrescriptionFragment
    }
    dependent {
      ...Prescription_DependentFragment
    }
  }
}
Variables
{
  "cardNumber": "abc123",
  "dependentCardNumber": [""],
  "pagination": {"page": 1, "take": 25},
  "filter": Prescription_TimeRangeFilterInput
}
Response
{
  "data": {
    "Prescription_prescriptionsByCardHolderAndDependent": {
      "cardNumber": "xyz789",
      "prescriptions": [Prescription_Prescription],
      "dependent": [Prescription_Dependent]
    }
  }
}
Queries

Prescription_prescriptionsOfTransaction

Response

Returns [Prescription_Prescription!]

Arguments
Name Description
cardNumber - String!
transaction - Prescription_TransactionInput!

Example

Query
query Prescription_prescriptionsOfTransaction(
  $cardNumber: String!,
  $transaction: Prescription_TransactionInput!
) {
  Prescription_prescriptionsOfTransaction(
    cardNumber: $cardNumber,
    transaction: $transaction
  ) {
    id
    uploadedAt
    deletedAt
    expiresAt
    source
    file
    name
    cardNumber
    identity
    status
    storage
    originalName
    extension
    prescriptionName
    dateIssuance
  }
}
Variables
{
  "cardNumber": "abc123",
  "transaction": Prescription_TransactionInput
}
Response
{
  "data": {
    "Prescription_prescriptionsOfTransaction": [
      {
        "id": 4,
        "uploadedAt": "2007-12-03T10:15:30Z",
        "deletedAt": "2007-12-03T10:15:30Z",
        "expiresAt": "2007-12-03T10:15:30Z",
        "source": "MOBILE_APP",
        "file": {},
        "name": "xyz789",
        "cardNumber": "abc123",
        "identity": "xyz789",
        "status": "ACTIVE",
        "storage": "abc123",
        "originalName": "xyz789",
        "extension": "abc123",
        "prescriptionName": "xyz789",
        "dateIssuance": "xyz789"
      }
    ]
  }
}
Queries

Sales_customerMemberships

Description

Consulta um beneficiário

Response

Returns a Sales_CustomerMembershipInfo

Arguments
Name Description
channel - Sales_TransactionTypeEnum Canal Benefits ou Pharma
customerCode - String! Identificação do consumidor (cartão Benefits ou CPF para Pharma)

Example

Query
query Sales_customerMemberships(
  $channel: Sales_TransactionTypeEnum,
  $customerCode: String!
) {
  Sales_customerMemberships(
    channel: $channel,
    customerCode: $customerCode
  ) {
    customer {
      ...Sales_CustomerFragment
    }
    memberships {
      ...Sales_MembershipFragment
    }
  }
}
Variables
{
  "channel": "BENEFITS",
  "customerCode": "abc123"
}
Response
{
  "data": {
    "Sales_customerMemberships": {
      "customer": Sales_Customer,
      "memberships": [Sales_Membership]
    }
  }
}
Queries

Sales_transaction

Description

Consulta uma pré-autorização

Response

Returns a Sales_Transaction

Arguments
Name Description
channel - Sales_TransactionTypeEnum Canal Benefits ou Pharma
storeCode - String! CNPJ do estabelecimento
customerCode - String Identificação do consumidor: cartão ou CPF. Campo necessário para consulta da transação no PBM2.0
authorizationID - ID! Numero da autorização da pré-autorização
createdAt - DateTime Data da transação (só precisa ser informado por finalizações de pré-autorizações que não foram feitas no mesmo dia)

Example

Query
query Sales_transaction(
  $channel: Sales_TransactionTypeEnum,
  $storeCode: String!,
  $customerCode: String,
  $authorizationID: ID!,
  $createdAt: DateTime
) {
  Sales_transaction(
    channel: $channel,
    storeCode: $storeCode,
    customerCode: $customerCode,
    authorizationID: $authorizationID,
    createdAt: $createdAt
  ) {
    createdAt
    authorizationID
    sequenceID
    totalValue
    moneyPaidValue
    cardPaidValue
    products {
      ...Sales_ProductFragment
    }
    status
    statusCode
    statusMessage
  }
}
Variables
{
  "channel": "BENEFITS",
  "storeCode": "abc123",
  "customerCode": "abc123",
  "authorizationID": 4,
  "createdAt": "2007-12-03T10:15:30Z"
}
Response
{
  "data": {
    "Sales_transaction": {
      "createdAt": "2007-12-03T10:15:30Z",
      "authorizationID": 4,
      "sequenceID": 4,
      "totalValue": 123.45,
      "moneyPaidValue": 123.45,
      "cardPaidValue": 987.65,
      "products": [Sales_Product],
      "status": "SUCCESS",
      "statusCode": 123,
      "statusMessage": "abc123"
    }
  }
}

Mutations

Pharma_addProgramBeneficiaryToProduct

Description

Inclui um produto no cadastro de um beneficiário, também poderá associar a um paciente dependente (caso o programa exija os dados do paciente dependente).

Response

Returns a Pharma_ValidationResult!

Arguments
Name Description
input - Pharma_RegisterProductRequest! Dados do produto e do beneficiário

Example

Query
mutation Pharma_addProgramBeneficiaryToProduct($input: Pharma_RegisterProductRequest!) {
  Pharma_addProgramBeneficiaryToProduct(input: $input) {
    status
    message
    errors {
      ...Pharma_ValidationErrorFragment
    }
  }
}
Variables
{"input": Pharma_RegisterProductRequest}
Response
{
  "data": {
    "Pharma_addProgramBeneficiaryToProduct": {
      "status": "SUCCESS",
      "message": "abc123",
      "errors": [Pharma_ValidationError]
    }
  }
}
Mutations

Pharma_deleteCacheKey

Description

Remove um único registro do cache

Response

Returns a Boolean!

Arguments
Name Description
key - String! Chave do cache a ser expirada

Example

Query
mutation Pharma_deleteCacheKey($key: String!) {
  Pharma_deleteCacheKey(key: $key)
}
Variables
{"key": "abc123"}
Response
{"data": {"Pharma_deleteCacheKey": false}}
Mutations

Pharma_insertOptIn

Description

Insere o optin de um beneficiário para os termos de um programa, com base em um código de envio.

Response

Returns a Pharma_InserirOptInResponse!

Arguments
Name Description
origin - Pharma_AuthorizationOrigin! Origem da solicitação
input - Pharma_InserirOptInRequest! Dados do produto e do beneficiário

Example

Query
mutation Pharma_insertOptIn(
  $origin: Pharma_AuthorizationOrigin!,
  $input: Pharma_InserirOptInRequest!
) {
  Pharma_insertOptIn(
    origin: $origin,
    input: $input
  ) {
    Status
    Mensagem
  }
}
Variables
{"origin": "DTS", "input": Pharma_InserirOptInRequest}
Response
{
  "data": {
    "Pharma_insertOptIn": {
      "Status": "abc123",
      "Mensagem": "abc123"
    }
  }
}
Mutations

Pharma_resetEntireCache

Description

Limpa completamente o cache da aplicação

Response

Returns a Boolean!

Example

Query
mutation Pharma_resetEntireCache {
  Pharma_resetEntireCache
}
Response
{"data": {"Pharma_resetEntireCache": true}}
Mutations

Pharma_sendOptInTerms

Description

Envia os termos de aceite do programa para o beneficiário, via SMS e/ou Email.

Response

Returns a Pharma_EnvioTermosOptInResponse!

Arguments
Name Description
origin - Pharma_AuthorizationOrigin! Origem da solicitação
input - Pharma_EnvioTermosOptInRequest! Dados do produto e do beneficiário

Example

Query
mutation Pharma_sendOptInTerms(
  $origin: Pharma_AuthorizationOrigin!,
  $input: Pharma_EnvioTermosOptInRequest!
) {
  Pharma_sendOptInTerms(
    origin: $origin,
    input: $input
  ) {
    Status
    Mensagem
  }
}
Variables
{"origin": "DTS", "input": Pharma_EnvioTermosOptInRequest}
Response
{
  "data": {
    "Pharma_sendOptInTerms": {
      "Status": "xyz789",
      "Mensagem": "abc123"
    }
  }
}
Mutations

Pharma_signUpProgramBeneficiary

Description

Este é um método agregado (para atender a necessidade de fazer o cadastro em um único passo) de cadastro no programa e produto, pode haver cadastro de paciente dependente se requisitado pelo programa.

Response

Returns a Pharma_ValidationResult!

Arguments
Name Description
input - Pharma_RegisterBeneficiaryRequest! Dados do beneficiário

Example

Query
mutation Pharma_signUpProgramBeneficiary($input: Pharma_RegisterBeneficiaryRequest!) {
  Pharma_signUpProgramBeneficiary(input: $input) {
    status
    message
    errors {
      ...Pharma_ValidationErrorFragment
    }
  }
}
Variables
{"input": Pharma_RegisterBeneficiaryRequest}
Response
{
  "data": {
    "Pharma_signUpProgramBeneficiary": {
      "status": "SUCCESS",
      "message": "xyz789",
      "errors": [Pharma_ValidationError]
    }
  }
}
Mutations

Pharma_signUpProgramBeneficiaryDependent

Description

Este é um método agregado (para atender a necessidade de fazer o cadastro em um único passo) de cadastro de paciente dependente e cadastro de produto, deve ser utilizado apenas quando o retorno informa: • O beneficiário já está cadastrado no programa • Requisitado cadastro do produto

Response

Returns a Pharma_ValidationResult!

Arguments
Name Description
input - Pharma_RegisterDependentRequest! Dados do produto e do beneficiário

Example

Query
mutation Pharma_signUpProgramBeneficiaryDependent($input: Pharma_RegisterDependentRequest!) {
  Pharma_signUpProgramBeneficiaryDependent(input: $input) {
    status
    message
    errors {
      ...Pharma_ValidationErrorFragment
    }
  }
}
Variables
{"input": Pharma_RegisterDependentRequest}
Response
{
  "data": {
    "Pharma_signUpProgramBeneficiaryDependent": {
      "status": "SUCCESS",
      "message": "abc123",
      "errors": [Pharma_ValidationError]
    }
  }
}
Mutations

Prescription_addPrescription

Response

Returns a Prescription_Prescription

Arguments
Name Description
source - Prescription_PrescriptionSourceInput!
uploadInfo - Prescription_UploadInfo!

Example

Query
mutation Prescription_addPrescription(
  $source: Prescription_PrescriptionSourceInput!,
  $uploadInfo: Prescription_UploadInfo!
) {
  Prescription_addPrescription(
    source: $source,
    uploadInfo: $uploadInfo
  ) {
    id
    uploadedAt
    deletedAt
    expiresAt
    source
    file
    name
    cardNumber
    identity
    status
    storage
    originalName
    extension
    prescriptionName
    dateIssuance
  }
}
Variables
{
  "source": Prescription_PrescriptionSourceInput,
  "uploadInfo": Prescription_UploadInfo
}
Response
{
  "data": {
    "Prescription_addPrescription": {
      "id": "4",
      "uploadedAt": "2007-12-03T10:15:30Z",
      "deletedAt": "2007-12-03T10:15:30Z",
      "expiresAt": "2007-12-03T10:15:30Z",
      "source": "MOBILE_APP",
      "file": {},
      "name": "abc123",
      "cardNumber": "abc123",
      "identity": "abc123",
      "status": "ACTIVE",
      "storage": "abc123",
      "originalName": "abc123",
      "extension": "xyz789",
      "prescriptionName": "xyz789",
      "dateIssuance": "abc123"
    }
  }
}
Mutations

Prescription_bindPrescription

Response

Returns a Boolean!

Arguments
Name Description
prescriptionIDs - [ID!]!
transaction - Prescription_TransactionInput!

Example

Query
mutation Prescription_bindPrescription(
  $prescriptionIDs: [ID!]!,
  $transaction: Prescription_TransactionInput!
) {
  Prescription_bindPrescription(
    prescriptionIDs: $prescriptionIDs,
    transaction: $transaction
  )
}
Variables
{
  "prescriptionIDs": [4],
  "transaction": Prescription_TransactionInput
}
Response
{"data": {"Prescription_bindPrescription": true}}
Mutations

Prescription_removePrescription

Response

Returns a Boolean!

Arguments
Name Description
id - ID!

Example

Query
mutation Prescription_removePrescription($id: ID!) {
  Prescription_removePrescription(id: $id)
}
Variables
{"id": "4"}
Response
{"data": {"Prescription_removePrescription": false}}
Mutations

Prescription_unbindPrescription

Response

Returns a Boolean!

Arguments
Name Description
prescriptionIDs - [ID!]!
transaction - Prescription_TransactionInput!

Example

Query
mutation Prescription_unbindPrescription(
  $prescriptionIDs: [ID!]!,
  $transaction: Prescription_TransactionInput!
) {
  Prescription_unbindPrescription(
    prescriptionIDs: $prescriptionIDs,
    transaction: $transaction
  )
}
Variables
{
  "prescriptionIDs": [4],
  "transaction": Prescription_TransactionInput
}
Response
{"data": {"Prescription_unbindPrescription": true}}
Mutations

Prescription_uploadPrescription

Response

Returns a Prescription_Prescription

Arguments
Name Description
file - Prescription_Upload!
uploadInfo - Prescription_UploadInfo!

Example

Query
mutation Prescription_uploadPrescription(
  $file: Prescription_Upload!,
  $uploadInfo: Prescription_UploadInfo!
) {
  Prescription_uploadPrescription(
    file: $file,
    uploadInfo: $uploadInfo
  ) {
    id
    uploadedAt
    deletedAt
    expiresAt
    source
    file
    name
    cardNumber
    identity
    status
    storage
    originalName
    extension
    prescriptionName
    dateIssuance
  }
}
Variables
{
  "file": Prescription_Upload,
  "uploadInfo": Prescription_UploadInfo
}
Response
{
  "data": {
    "Prescription_uploadPrescription": {
      "id": "4",
      "uploadedAt": "2007-12-03T10:15:30Z",
      "deletedAt": "2007-12-03T10:15:30Z",
      "expiresAt": "2007-12-03T10:15:30Z",
      "source": "MOBILE_APP",
      "file": {},
      "name": "xyz789",
      "cardNumber": "xyz789",
      "identity": "xyz789",
      "status": "ACTIVE",
      "storage": "abc123",
      "originalName": "abc123",
      "extension": "xyz789",
      "prescriptionName": "xyz789",
      "dateIssuance": "xyz789"
    }
  }
}
Mutations

Sales_cancel

Description

Cancela uma venda

Response

Returns a Sales_CanceledTransaction

Arguments
Name Description
origin - Sales_AuthorizationOriginEnum Origem da solicitação
channel - Sales_TransactionTypeEnum Canal Benefits ou Pharma
storeCode - String! CNPJ do estabelecimento
customerCode - String Identificação do consumidor (cartão Benefits ou CPF para Pharma)
authorizationID - ID Número da autorização referente à venda
preAuthorizationID - ID Número da autorização referente à pré-autorização
createdAt - DateTime Data e hora local da Transação (só precisa ser informado para autorizações que não foram feitas no mesmo dia)

Example

Query
mutation Sales_cancel(
  $origin: Sales_AuthorizationOriginEnum,
  $channel: Sales_TransactionTypeEnum,
  $storeCode: String!,
  $customerCode: String,
  $authorizationID: ID,
  $preAuthorizationID: ID,
  $createdAt: DateTime
) {
  Sales_cancel(
    origin: $origin,
    channel: $channel,
    storeCode: $storeCode,
    customerCode: $customerCode,
    authorizationID: $authorizationID,
    preAuthorizationID: $preAuthorizationID,
    createdAt: $createdAt
  ) {
    createdAt
    authorizationID
    status
    statusCode
    statusMessage
    receipt
  }
}
Variables
{
  "origin": "DTS",
  "channel": "BENEFITS",
  "storeCode": "xyz789",
  "customerCode": "abc123",
  "authorizationID": 4,
  "preAuthorizationID": "4",
  "createdAt": "2007-12-03T10:15:30Z"
}
Response
{
  "data": {
    "Sales_cancel": {
      "createdAt": "2007-12-03T10:15:30Z",
      "authorizationID": "4",
      "status": "SUCCESS",
      "statusCode": 987,
      "statusMessage": "xyz789",
      "receipt": "abc123"
    }
  }
}
Mutations

Sales_confirmPreAuthorizedSale

Description

Efetua uma venda recuperando as regras de uma pré-autorização válida

Response

Returns a Sales_Authorization

Arguments
Name Description
origin - Sales_AuthorizationOriginEnum Origem da solicitação
channel - Sales_TransactionTypeEnum Canal Benefits ou Pharma
authorizationID - ID! Número da autorização referente à pré-autorização
storeCode - String! CNPJ do estabelecimento
customerCode - String Deprecado, não é necessário. Identificação do consumidor (cartão Benefits ou CPF para Pharma)
invoiceCode - String Chave da Nota Fiscal Eletrônica
invoiceAuthProtocol - String Protocolo de autenticação da NF-e
products - [Sales_ProductInput!]! Produtos
preAuthorizationDate - DateTime Data e hora local da Pré-Autorização

Example

Query
mutation Sales_confirmPreAuthorizedSale(
  $origin: Sales_AuthorizationOriginEnum,
  $channel: Sales_TransactionTypeEnum,
  $authorizationID: ID!,
  $storeCode: String!,
  $customerCode: String,
  $invoiceCode: String,
  $invoiceAuthProtocol: String,
  $products: [Sales_ProductInput!]!,
  $preAuthorizationDate: DateTime
) {
  Sales_confirmPreAuthorizedSale(
    origin: $origin,
    channel: $channel,
    authorizationID: $authorizationID,
    storeCode: $storeCode,
    customerCode: $customerCode,
    invoiceCode: $invoiceCode,
    invoiceAuthProtocol: $invoiceAuthProtocol,
    products: $products,
    preAuthorizationDate: $preAuthorizationDate
  ) {
    createdAt
    authorizationID
    sequenceID
    totalValue
    moneyPaidValue
    cardPaidValue
    cardBalance
    products {
      ...Sales_ProductFragment
    }
    status
    statusCode
    statusMessage
    receipt
    secondFactorAuthentication
    reimbursementValue
    origin
  }
}
Variables
{
  "origin": "DTS",
  "channel": "BENEFITS",
  "authorizationID": "4",
  "storeCode": "xyz789",
  "customerCode": "abc123",
  "invoiceCode": "abc123",
  "invoiceAuthProtocol": "abc123",
  "products": [Sales_ProductInput],
  "preAuthorizationDate": "2007-12-03T10:15:30Z"
}
Response
{
  "data": {
    "Sales_confirmPreAuthorizedSale": {
      "createdAt": "2007-12-03T10:15:30Z",
      "authorizationID": "4",
      "sequenceID": "4",
      "totalValue": 987.65,
      "moneyPaidValue": 123.45,
      "cardPaidValue": 123.45,
      "cardBalance": 987.65,
      "products": [Sales_Product],
      "status": "SUCCESS",
      "statusCode": 987,
      "statusMessage": "xyz789",
      "receipt": "xyz789",
      "secondFactorAuthentication": "NONE",
      "reimbursementValue": 987.65,
      "origin": "DTS"
    }
  }
}
Mutations

Sales_preAuthorizeSale

Description

Avalia todas as regras do programa e emite a autorização de compra

Response

Returns a Sales_Authorization

Arguments
Name Description
origin - Sales_AuthorizationOriginEnum Origem da solicitação
channel - Sales_TransactionTypeEnum Canal Benefits ou Pharma
storeCode - String! CNPJ do estabelecimento
customerCode - String! Identificação do consumidor (cartão Benefits ou CPF para Pharma)
products - [Sales_ProductInput!]! Produtos

Example

Query
mutation Sales_preAuthorizeSale(
  $origin: Sales_AuthorizationOriginEnum,
  $channel: Sales_TransactionTypeEnum,
  $storeCode: String!,
  $customerCode: String!,
  $products: [Sales_ProductInput!]!
) {
  Sales_preAuthorizeSale(
    origin: $origin,
    channel: $channel,
    storeCode: $storeCode,
    customerCode: $customerCode,
    products: $products
  ) {
    createdAt
    authorizationID
    sequenceID
    totalValue
    moneyPaidValue
    cardPaidValue
    cardBalance
    products {
      ...Sales_ProductFragment
    }
    status
    statusCode
    statusMessage
    receipt
    secondFactorAuthentication
    reimbursementValue
    origin
  }
}
Variables
{
  "origin": "DTS",
  "channel": "BENEFITS",
  "storeCode": "abc123",
  "customerCode": "xyz789",
  "products": [Sales_ProductInput]
}
Response
{
  "data": {
    "Sales_preAuthorizeSale": {
      "createdAt": "2007-12-03T10:15:30Z",
      "authorizationID": "4",
      "sequenceID": 4,
      "totalValue": 987.65,
      "moneyPaidValue": 987.65,
      "cardPaidValue": 123.45,
      "cardBalance": 987.65,
      "products": [Sales_Product],
      "status": "SUCCESS",
      "statusCode": 123,
      "statusMessage": "xyz789",
      "receipt": "xyz789",
      "secondFactorAuthentication": "NONE",
      "reimbursementValue": 123.45,
      "origin": "DTS"
    }
  }
}
Mutations

Sales_sell

Description

Efetua uma venda direta avaliando todas as regras do programa, sem pré-autorizar.

Response

Returns a Sales_Authorization

Arguments
Name Description
origin - Sales_AuthorizationOriginEnum Origem da solicitação
channel - Sales_TransactionTypeEnum Canal Benefits ou Pharma
storeCode - String! CNPJ do estabelecimento
customerCode - String! Identificação do consumidor (cartão Benefits ou CPF para Pharma)
products - [Sales_ProductInput!]! Produtos

Example

Query
mutation Sales_sell(
  $origin: Sales_AuthorizationOriginEnum,
  $channel: Sales_TransactionTypeEnum,
  $storeCode: String!,
  $customerCode: String!,
  $products: [Sales_ProductInput!]!
) {
  Sales_sell(
    origin: $origin,
    channel: $channel,
    storeCode: $storeCode,
    customerCode: $customerCode,
    products: $products
  ) {
    createdAt
    authorizationID
    sequenceID
    totalValue
    moneyPaidValue
    cardPaidValue
    cardBalance
    products {
      ...Sales_ProductFragment
    }
    status
    statusCode
    statusMessage
    receipt
    secondFactorAuthentication
    reimbursementValue
    origin
  }
}
Variables
{
  "origin": "DTS",
  "channel": "BENEFITS",
  "storeCode": "abc123",
  "customerCode": "abc123",
  "products": [Sales_ProductInput]
}
Response
{
  "data": {
    "Sales_sell": {
      "createdAt": "2007-12-03T10:15:30Z",
      "authorizationID": "4",
      "sequenceID": 4,
      "totalValue": 123.45,
      "moneyPaidValue": 987.65,
      "cardPaidValue": 987.65,
      "cardBalance": 987.65,
      "products": [Sales_Product],
      "status": "SUCCESS",
      "statusCode": 123,
      "statusMessage": "xyz789",
      "receipt": "abc123",
      "secondFactorAuthentication": "NONE",
      "reimbursementValue": 123.45,
      "origin": "DTS"
    }
  }
}
Mutations

Sales_updateInvoiceCode

Description

Salvar código da Nota Fiscal Eletrônica da venda

Response

Returns a Sales_UpdatedInvoiceCode

Arguments
Name Description
origin - Sales_AuthorizationOriginEnum Origem da solicitação
storeCode - String! CNPJ do estabelecimento
invoiceCode - String Chave da Nota Fiscal Eletrônica
invoiceAuthProtocol - String Protocolo de autenticação da NF-e
authorizationID - ID! Número sequencial único gerado pelo autorizador referente à pré-autorização
saleDate - DateTime! Data da Venda

Example

Query
mutation Sales_updateInvoiceCode(
  $origin: Sales_AuthorizationOriginEnum,
  $storeCode: String!,
  $invoiceCode: String,
  $invoiceAuthProtocol: String,
  $authorizationID: ID!,
  $saleDate: DateTime!
) {
  Sales_updateInvoiceCode(
    origin: $origin,
    storeCode: $storeCode,
    invoiceCode: $invoiceCode,
    invoiceAuthProtocol: $invoiceAuthProtocol,
    authorizationID: $authorizationID,
    saleDate: $saleDate
  ) {
    status
    statusCode
    statusMessage
  }
}
Variables
{
  "origin": "DTS",
  "storeCode": "abc123",
  "invoiceCode": "abc123",
  "invoiceAuthProtocol": "abc123",
  "authorizationID": "4",
  "saleDate": "2007-12-03T10:15:30Z"
}
Response
{
  "data": {
    "Sales_updateInvoiceCode": {
      "status": "SUCCESS",
      "statusCode": 123,
      "statusMessage": "abc123"
    }
  }
}
Mutations

Sales_validatePreAuthorizedSaleSecondFactor

Description

Valida uma pré-autorização que está pendente aguardando um token

Response

Returns a Sales_PreAuthorizedSaleSecondFactorValidationResult

Arguments
Name Description
origin - Sales_AuthorizationOriginEnum Origem da solicitação
channel - Sales_TransactionTypeEnum Canal Benefits ou Pharma
storeCode - String! CNPJ do estabelecimento
customerCode - String! Identificação do consumidor (cartão Benefits ou CPF para Pharma)
authorizationID - ID! Número da autorização referente à pré-autorização
token - String! Token do segundo fator de autenticação

Example

Query
mutation Sales_validatePreAuthorizedSaleSecondFactor(
  $origin: Sales_AuthorizationOriginEnum,
  $channel: Sales_TransactionTypeEnum,
  $storeCode: String!,
  $customerCode: String!,
  $authorizationID: ID!,
  $token: String!
) {
  Sales_validatePreAuthorizedSaleSecondFactor(
    origin: $origin,
    channel: $channel,
    storeCode: $storeCode,
    customerCode: $customerCode,
    authorizationID: $authorizationID,
    token: $token
  ) {
    status
    statusMessage
  }
}
Variables
{
  "origin": "DTS",
  "channel": "BENEFITS",
  "storeCode": "abc123",
  "customerCode": "xyz789",
  "authorizationID": 4,
  "token": "xyz789"
}
Response
{
  "data": {
    "Sales_validatePreAuthorizedSaleSecondFactor": {
      "status": "VALID",
      "statusMessage": "abc123"
    }
  }
}
Mutations

createToken

Description

Create a token for user

Response

Returns a Token

Arguments
Name Description
login - String! User Login
password - String! User Password
source - String Origem da requisição
app_version - String Versão do aplicativo
isApi - Boolean Define se o token será criado para alguma API
mfa_code - String MFA code
verify_mfa - Boolean Define if mfa verification needs to be done

Example

Query
mutation createToken(
  $login: String!,
  $password: String!,
  $source: String,
  $app_version: String,
  $isApi: Boolean,
  $mfa_code: String,
  $verify_mfa: Boolean
) {
  createToken(
    login: $login,
    password: $password,
    source: $source,
    app_version: $app_version,
    isApi: $isApi,
    mfa_code: $mfa_code,
    verify_mfa: $verify_mfa
  ) {
    token
    allowedServices
    user {
      ...UserFragment
    }
  }
}
Variables
{
  "login": "abc123",
  "password": "xyz789",
  "source": "xyz789",
  "app_version": "xyz789",
  "isApi": true,
  "mfa_code": "abc123",
  "verify_mfa": false
}
Response
{
  "data": {
    "createToken": {
      "token": "abc123",
      "allowedServices": ["abc123"],
      "user": User
    }
  }
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

Date

Description

A date string, such as 2007-12-03, compliant with the full-date format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

Example
"2007-12-03"
Types

DateTime

Description

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

Example
"2007-12-03T10:15:30Z"
Types

Datetime

Description

The datetime scalar type represents date and time information. The datetime type uses Y-m-d H:i:s format.

Example
Datetime
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
123.45
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
"4"
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987
Types

JSON

Description

The JSON scalar type represents JSON values as specified by ECMA-404.

Example
{}
Types

Permission

Description

A user permission

Fields
Field Name Description
service - ServiceCodeEnum Service code
industries - [String] Industries codes
Example
{"service": "CA", "industries": ["xyz789"]}
Types

Pharma_AssessEligibilityResponse

Fields
Field Name Description
validationResult - Pharma_ValidationResult! Informa se a requisição atende as regras
eligibilityAssessment - Pharma_EligibilityAssessment! Dados da avaliação de elegibilidade
registrationPolicy - Pharma_RegistrationPolicy! Dados de politicas cadastrais e campos
dependents - [Pharma_Dependent!]! Lista do tipo Pacientes, caso possua pacientes dependentes e o programa trabalhe com pacientes dependentes
Example
{
  "validationResult": Pharma_ValidationResult,
  "eligibilityAssessment": Pharma_EligibilityAssessment,
  "registrationPolicy": Pharma_RegistrationPolicy,
  "dependents": [Pharma_Dependent]
}
Types

Pharma_Authorization

Fields
Field Name Description
aproved - Boolean!
createdAt - DateTime! Data e hora local da Transação
totalValue - Float! Valor total da Transação
moneyPaidValue - Float! Valor a pagar no PDV
cardPaidValue - Float! Valor do debito no cartão Funcional
totalValueMaxConsumerPrice - Float!
totalValueWithPrescription - Float!
totalValueWithoutPrescription - Float!
totalDiscountAmount - Float!
products - [Pharma_AuthorizationItem!]!
requiredUploadWithPrescription - Boolean!
Example
{
  "aproved": false,
  "createdAt": "2007-12-03T10:15:30Z",
  "totalValue": 123.45,
  "moneyPaidValue": 987.65,
  "cardPaidValue": 123.45,
  "totalValueMaxConsumerPrice": 123.45,
  "totalValueWithPrescription": 123.45,
  "totalValueWithoutPrescription": 987.65,
  "totalDiscountAmount": 987.65,
  "products": [Pharma_AuthorizationItem],
  "requiredUploadWithPrescription": false
}
Types

Pharma_AuthorizationItem

Fields
Field Name Description
transactionType - Pharma_TransactionType! Tipo de programa
ean - String! EAN do produto
description - String Nome do produto
maximumConsumerPrice - Float! Prexo Máximo para Consumidor
priceReceived - Float! Preço recebido
funcionalPrice - Float! Preço da Funcional
salePrice - Float! Preço utilizado na venda
saleAmount - Int! Quantidade vendida
medicalPrescription - Pharma_Prescription! Receita médica
status - Pharma_StatusItem! Status da venda deste item
Example
{
  "transactionType": "BENEFITS",
  "ean": "abc123",
  "description": "abc123",
  "maximumConsumerPrice": 123.45,
  "priceReceived": 987.65,
  "funcionalPrice": 123.45,
  "salePrice": 987.65,
  "saleAmount": 987,
  "medicalPrescription": Pharma_Prescription,
  "status": Pharma_StatusItem
}
Types

Pharma_AuthorizationOrigin

Description

Origem da autorização

Values
Enum Value Description

DTS

 Carga de base histórica

MOBILE_APP

 Aplicativo Mobile

POINT_OF_SALES

 Ponto de venda

CALL_CENTER

 Atendimento via call center

INDUSTRY_PROGRAM_WEBSITE

 Site de programa da indústria

INTERACTIVE_VOICE_RESPONSE

 Unidade de Resposta Audível (URA)

VACCINES_INDUSTRY_PROGRAM_WEBSITE

 Site de programa da indústria (versão vacinas)

PURCHASE

 Cadastro via compra de produto

AZIMUTE

 Azimute (parceiro)

PARTNERS_ECOMMERCE

 E-commerce de Parceiros

MANAGER_SYSTEM

 Sistema Gestor

FACEBOOK

 Facebook

ELECTRONIC_PRESCRIPTION

 Prescrição Eletrônica

CCUCO

 Ccuco (parceiro)

BCARE

 BCare (parceiro)

NEXODATA

 Marketplace

CONSULTA_REMEDIO

 Marketplace

MEMED

 Marketplace

FARMACIAS_APP

 Marketplace

PEDBOT

 Marketplace

IFOOD

 Ifood
Example
"DTS"
Types

Pharma_Councils

Description

Tipo de conselho

Values
Enum Value Description

CRM

 Conselho Regional Médico

CRO

 Conselho Regional de Odontologia

CRF

 Conselho Regional Farmacêutico
Example
"CRM"
Types

Pharma_Dependent

Fields
Field Name Description
id - ID! Código do paciente dependente na Funcional, é utilizado para incluir um medicamento em um paciente dependente.
name - String! Nome do Paciente
birth - DateTime! Data de nascimento do Paciente
gender - String! Sexo do paciente dependente
holder - Boolean! Informa se o paciente dependente é o próprio beneficiário do CPF
Example
{
  "id": "4",
  "name": "xyz789",
  "birth": "2007-12-03T10:15:30Z",
  "gender": "abc123",
  "holder": false
}
Types

Pharma_DisplayField

Description

Exibição do campo

Values
Enum Value Description

HIDDEN

 Não é necessária a exibição

OPTIONAL

 Campo deve ser exibido como opcional

REQUIRED

 Campo deve ser exibido como obrigatório
Example
"HIDDEN"
Types

Pharma_DisplayProductDiscountRules

Fields
Field Name Description
status - String! Status da solicitação
statusMessage - String Descrição do status
products - [Pharma_PharmaProduct!]! Dados dos produtos
messages - [String!]! Mensagens para a interface
nameProgram - String Mensagens para a interface
priority - Float Prioridade do programa
discounts - [Pharma_PurchaseDiscount!]! Regras de descontos
Example
{
  "status": "abc123",
  "statusMessage": "xyz789",
  "products": [Pharma_PharmaProduct],
  "messages": ["xyz789"],
  "nameProgram": "xyz789",
  "priority": 123.45,
  "discounts": [Pharma_PurchaseDiscount]
}
Types

Pharma_EligibilityAssessment

Fields
Field Name Description
belongsToIndustryProgram - Boolean! Informa se o produto percente a algum programa
programDescription - String Descrição do programa
programCode - ID ID do programa
productDescription - String Descrição do produto
Example
{
  "belongsToIndustryProgram": false,
  "programDescription": "abc123",
  "programCode": 4,
  "productDescription": "xyz789"
}
Types

Pharma_EntityRegister

Description

A quem o campo pertence

Values
Enum Value Description

BENEFICIARIO

PACIENTE

PRODUTO

EXTRA
Example
"BENEFICIARIO"
Types

Pharma_EnvioTermosOptInRequest

Fields
Input Field Description
Ean - String!

EAN do produto
CPF - String!

CPF do beneficiário
TelefoneCelular - String!

Telefone Celular do beneficiário
Email - String!

Email do beneficiário
Origem - Float!

Origem da solicitação
Example
{
  "Ean": "xyz789",
  "CPF": "abc123",
  "TelefoneCelular": "xyz789",
  "Email": "abc123",
  "Origem": 123.45
}
Types

Pharma_EnvioTermosOptInResponse

Fields
Field Name Description
Status - String Status do envio
Mensagem - String Mensagem adicional
Example
{
  "Status": "abc123",
  "Mensagem": "abc123"
}
Types

Pharma_FormExtraField

Fields
Input Field Description
QuestionCode - Float!
AnswerCode - Float!
QuestionTypeFlag - Float!
TypedValue - String!
Example
{
  "QuestionCode": 987.65,
  "AnswerCode": 987.65,
  "QuestionTypeFlag": 123.45,
  "TypedValue": "abc123"
}
Types

Pharma_FormField

Fields
Input Field Description
text - String!
value - String!
Example
{
  "text": "abc123",
  "value": "abc123"
}
Types

Pharma_InserirOptInRequest

Fields
Input Field Description
CodigoEnvioTermos - String!

Código de envio dos termos vinculado ao CPF do beneficiário
Origem - Float!

Origem da solicitação
Example
{
  "CodigoEnvioTermos": "abc123",
  "Origem": 123.45
}
Types

Pharma_InserirOptInResponse

Fields
Field Name Description
Status - String Status do envio
Mensagem - String Mensagem adicional
Example
{
  "Status": "abc123",
  "Mensagem": "xyz789"
}
Types

Pharma_ItemArgs

Fields
Input Field Description
ean - String!
price - Float!
saleAmount - Int!
medicalPrescription - Pharma_PrescriptionInput
Example
{
  "ean": "abc123",
  "price": 123.45,
  "saleAmount": 987,
  "medicalPrescription": Pharma_PrescriptionInput
}
Types

Pharma_OptInRequest

Fields
Input Field Description
EAN - String!

EAN do produto
CPF - String!

CPF do beneficiário
CNPJ - String!

CNPJ do estabelecimento
Origem - Float!

Origem da solicitação
CodCre - Float!

Código de credenciado do estabelecimento
Example
{
  "EAN": "xyz789",
  "CPF": "abc123",
  "CNPJ": "abc123",
  "Origem": 123.45,
  "CodCre": 987.65
}
Types

Pharma_OptInResponse

Fields
Field Name Description
OptInRealizado - String Indica se o beneficiário já deu aceite nos termos, caso existam
OptInObrigatorio - String Indica se o aceite do beneficiário nos termos é obrigatório
Mensagem - String Mensagem adicional de validação
Example
{
  "OptInRealizado": "abc123",
  "OptInObrigatorio": "abc123",
  "Mensagem": "xyz789"
}
Types

Pharma_PharmaProduct

Fields
Field Name Description
name - String! Nome do produto
package - String! Apresentação do produto
eans - [String!]! EANs do produto
Example
{
  "name": "xyz789",
  "package": "xyz789",
  "eans": ["abc123"]
}
Types

Pharma_PharmaProgram

Fields
Field Name Description
id - ID! Código do programa
name - String! Nome do programa
url - String URL do site do programa
allowedOrigins - [Int!]! Código das origens permitidas
rules - [Pharma_PharmaProgramRule!]! Regras de produtos
Example
{
  "id": 4,
  "name": "xyz789",
  "url": "xyz789",
  "allowedOrigins": [123],
  "rules": [Pharma_PharmaProgramRule]
}
Types

Pharma_PharmaProgramRule

Fields
Field Name Description
id - ID! Código da regra do produto
description - ID Código da regra do produto
product - Pharma_PharmaProduct! Dados do produto
maximumConsumerPrice - Float! Prexo Máximo para Consumidor
saleBaseDiscountPercentage - Float! Desconto base para a venda
repositionBaseDiscountPercentage - Float! Desconto base para a reposição
blocked - Boolean! Bloqueado para o PDV?
requiresMedicalPrescription - Boolean! Medicamento controlado?
witholdsMedicalPrescription - Boolean! Retém a receita médica?
Example
{
  "id": 4,
  "description": 4,
  "product": Pharma_PharmaProduct,
  "maximumConsumerPrice": 123.45,
  "saleBaseDiscountPercentage": 987.65,
  "repositionBaseDiscountPercentage": 123.45,
  "blocked": true,
  "requiresMedicalPrescription": false,
  "witholdsMedicalPrescription": true
}
Types

Pharma_PrescriberRegister

Fields
Field Name Description
council - Pharma_Councils Órgão emissor do registro
stateAbbr - String Sigla do estado emissor do registro
registerNumber - Int Número do registro
Example
{
  "council": "CRM",
  "stateAbbr": "abc123",
  "registerNumber": 987
}
Types

Pharma_PrescriberRegisterInput

Fields
Input Field Description
council - Pharma_Councils

Órgão emissor do registro
stateAbbr - String

Sigla do estado emissor do registro
registerNumber - Int

Número do registro
Example
{
  "council": "CRM",
  "stateAbbr": "abc123",
  "registerNumber": 123
}
Types

Pharma_Prescription

Fields
Field Name Description
quantity - Int Quantidade receitada do produto
date - DateTime Data da receita
prescriber - Pharma_PrescriberRegister Dados do registro profissional prescritor da receita (Médico, Dentista)
requiredInformDailyDose - Boolean Indica se o beneficiário informa dose diária
dailyDose - Float Dose diária do produto
Example
{
  "quantity": 123,
  "date": "2007-12-03T10:15:30Z",
  "prescriber": Pharma_PrescriberRegister,
  "requiredInformDailyDose": true,
  "dailyDose": 123.45
}
Types

Pharma_PrescriptionInput

Fields
Input Field Description
quantity - Int

Quantidade receitada do produto
date - DateTime

Data da receita
prescriber - Pharma_PrescriberRegisterInput

Dados do registro profissional prescritor da receita (Médico, Dentista)
dailyDose - Float

Dose diária do produto
Example
{
  "quantity": 123,
  "date": "2007-12-03T10:15:30Z",
  "prescriber": Pharma_PrescriberRegisterInput,
  "dailyDose": 987.65
}
Types

Pharma_PurchaseDiscount

Description

Desconto de compra para exibição

Fields
Field Name Description
type - String! Tipo
category - String Categoria
quantity - String Quantidade
originalAmount - String Valor sem desconto
discountPercentage - String Desconto
savedAmount - String Economia total
amount - String Total com desconto
tiedCondition - String Condição (compra conjunta)
tiedEans - String Eans condição (compra conjunta)
tiedProductName - String Nome do produto com desconto (compra conjunta)
subsidizedBoughtProduct - String Compre este produto (compra bonificada)
subsidizedAcquiredProduct - String Ganhe este produto (compra bonificada)
Example
{
  "type": "xyz789",
  "category": "abc123",
  "quantity": "abc123",
  "originalAmount": "abc123",
  "discountPercentage": "xyz789",
  "savedAmount": "xyz789",
  "amount": "abc123",
  "tiedCondition": "xyz789",
  "tiedEans": "abc123",
  "tiedProductName": "xyz789",
  "subsidizedBoughtProduct": "xyz789",
  "subsidizedAcquiredProduct": "xyz789"
}
Types

Pharma_RegisterBeneficiaryRequest

Fields
Input Field Description
origin - Pharma_AuthorizationOrigin!

Origem da solicitação
storeCode - String!

CNPJ da origem do cadastro Beneficiário
customerCode - String!

CPF do beneficiário
productCode - String!

EAN do Produto
programCode - ID!

Código do programa
beneficiaryFields - [Pharma_FormField!]!

Campos cadastrais do beneficiário
medicalPrescriptionFields - [Pharma_FormField!]!

Campos cadastrais do produto
dependentFields - [Pharma_FormField!]

Campos cadastrais do paciente dependente
extraFields - [Pharma_FormField!]

Campos cadastrais extras que não pertencem as demais entidades
extraFormFields - [Pharma_FormExtraField!]

Campos cadastrais extras que não pertencem as demais entidades
Example
{
  "origin": "DTS",
  "storeCode": "abc123",
  "customerCode": "abc123",
  "productCode": "xyz789",
  "programCode": "4",
  "beneficiaryFields": [Pharma_FormField],
  "medicalPrescriptionFields": [Pharma_FormField],
  "dependentFields": [Pharma_FormField],
  "extraFields": [Pharma_FormField],
  "extraFormFields": [Pharma_FormExtraField]
}
Types

Pharma_RegisterDependentRequest

Fields
Input Field Description
origin - Pharma_AuthorizationOrigin!

Origem da solicitação
programCode - ID!

Código do programa
storeCode - String!

CNPJ da origem do cadastro do dependente
customerCode - String!

CPF do beneficiário titular (não dependente)
productCode - String!

EAN do produto
medicalPrescriptionFields - [Pharma_FormField!]!

Campos cadastrais do produto
dependentFields - [Pharma_FormField!]

Campos cadastrais do paciente dependente
extraFields - [Pharma_FormField!]

Campos cadastrais extras que não pertencem as demais entidades
extraFormFields - [Pharma_FormExtraField!]

Campos cadastrais extras que não pertencem as demais entidades
Example
{
  "origin": "DTS",
  "programCode": "4",
  "storeCode": "abc123",
  "customerCode": "abc123",
  "productCode": "xyz789",
  "medicalPrescriptionFields": [Pharma_FormField],
  "dependentFields": [Pharma_FormField],
  "extraFields": [Pharma_FormField],
  "extraFormFields": [Pharma_FormExtraField]
}
Types

Pharma_RegisterProductRequest

Fields
Input Field Description
origin - Pharma_AuthorizationOrigin!

Origem da solicitação
programCode - ID!

Código do programa
storeCode - String!

CNPJ da origem do cadastro do beneficiário no produto
customerCode - String!

CPF do beneficiário
productCode - String!

EAN do produto
dependentID - String

ID do paciente dependente se exigido pelo programa
medicalPrescriptionFields - [Pharma_FormField!]!

Campos cadastrais do produto
extraFormFields - [Pharma_FormExtraField!]

Campos extras do produto
Example
{
  "origin": "DTS",
  "programCode": "4",
  "storeCode": "abc123",
  "customerCode": "xyz789",
  "productCode": "xyz789",
  "dependentID": "abc123",
  "medicalPrescriptionFields": [Pharma_FormField],
  "extraFormFields": [Pharma_FormExtraField]
}
Types

Pharma_RegistrationPolicy

Fields
Field Name Description
allowDependents - Boolean! Informa se o programa utiliza pacientes dependentes
dependentsLimit - Int Informa o limite de pacientes dependentes dependentes que podem ser cadastrados no programa, o paciente dependente titular não é contabilizado, regra validada internamente
requiresBeneficiaryRegistration - Boolean! Informa se é necessário se cadastrar no programa
requiresMedicalPrescriptionRegistration - Boolean! Informa se é necessário se cadastrar no produto específico, além do programa
requiresAtLeastOneContactMedium - Boolean! Informa se o service irá validar se há ao menos um telefone de contato preenchido, este flag é uma validação independente feita após a validação de campos. Serve para programas aonde normalmente os telefones serão opcionais, porém, ao menos um seja preenchido para contato posterior.
requiresMedicalPrescriber - Boolean! Informa se o prescritor é obrigatório ou opcional para aquele programa
beneficiaryFields - [Pharma_RegistrationPolicyField!]! Lista do tipo PoliticaCadastralCampo de campos que devem ser exibidos para o beneficiário
dependentFields - [Pharma_RegistrationPolicyField!]! Lista do tipo PoliticaCadastralCampo de campos que devem ser exibidos para o cadastro do paciente dependente (caso o programa trabalhe com o conceito de pacientes dependentes)
medicalPrescriptionFields - [Pharma_RegistrationPolicyField!]! Lista do tipo PoliticaCadastralCampo de campos que devem ser exibidos para o produto
extraFields - [Pharma_RegistrationPolicyField!]! Lista do tipo PoliticaCadastralCampo de campos que devem ser exibidos no final do formulário, com informações extras cadastrais requisitadas pelo programa (se houverem)
extraFormFields - [Pharma_RegistrationPolicyExtraField!] Lista do tipo PoliticaCadastralCampoExtras de campos que devem ser exibidos no final do formulário, com informações extras cadastrais requisitadas pelo programa (se houverem)
allowedOrigins - [Pharma_AuthorizationOrigin!] Informa as origens permitidas para o programa
isRegistered - Boolean Se o paciente está cadastrado no programa
originPermitedRegister - Boolean Indica se a origem pode registrar este produto
urlRegisterSite - String URL do site para registro do programa, se aplicável
Example
{
  "allowDependents": true,
  "dependentsLimit": 987,
  "requiresBeneficiaryRegistration": false,
  "requiresMedicalPrescriptionRegistration": true,
  "requiresAtLeastOneContactMedium": false,
  "requiresMedicalPrescriber": true,
  "beneficiaryFields": [Pharma_RegistrationPolicyField],
  "dependentFields": [Pharma_RegistrationPolicyField],
  "medicalPrescriptionFields": [
    Pharma_RegistrationPolicyField
  ],
  "extraFields": [Pharma_RegistrationPolicyField],
  "extraFormFields": [
    Pharma_RegistrationPolicyExtraField
  ],
  "allowedOrigins": ["DTS"],
  "isRegistered": true,
  "originPermitedRegister": false,
  "urlRegisterSite": "xyz789"
}
Types

Pharma_RegistrationPolicyExtraField

Fields
Field Name Description
QuestionCode - Float Código da questão. Será utilizado para idenficiar a questão respondida no envio do cadastro
ParentQuestionCode - Float Código da questão relacionada, se houver - questão pai
ProgramCode - Float Código do Programa
ProductName - String Nome do produto - família
DisplayTitle - String Texto de exibição - label
MultipleChoice - Boolean Flag que indica se a questão é de múltipla escolha
Mandatory - Boolean Flag que indica se o preenchimento da questão é obrigatória
DisplayOrder - Float Número indicador da ordem de exibição na tela
QuestionHint - String Descrição da dica explicativa para preenchimento da questão
ControlType - String Tipo de controle
QuestionTypeFlag - Float Tipo da questão - 1 formulário do paciente e 2 questões relacionadas ao medicamento
Answers - [Pharma_RegistrationPolicyExtraFieldOption!] Lista das respostas para a questão
Example
{
  "QuestionCode": 123.45,
  "ParentQuestionCode": 987.65,
  "ProgramCode": 123.45,
  "ProductName": "xyz789",
  "DisplayTitle": "abc123",
  "MultipleChoice": true,
  "Mandatory": true,
  "DisplayOrder": 987.65,
  "QuestionHint": "xyz789",
  "ControlType": "abc123",
  "QuestionTypeFlag": 123.45,
  "Answers": [Pharma_RegistrationPolicyExtraFieldOption]
}
Types

Pharma_RegistrationPolicyExtraFieldOption

Fields
Field Name Description
AnswerCode - Float Código da resposta
DisplayTitle - String Text de exibição - label
AllowsTypedValue - Boolean Flag que indica se permite que o usuário digite a resposta
MaxTypedValueSize - Float Tamanho máximo da resposta, quando permitido a digitação
TypedValue - String Valor digitado, quando permitido
DisplayOrder - String Número indicador da ordem de exibição na tela
RelatedQuestions - [Pharma_RegistrationPolicyExtraField!] Questão relacionada. É utilizado quando uma resposta requer que novas questões sejam respondidas
Example
{
  "AnswerCode": 987.65,
  "DisplayTitle": "xyz789",
  "AllowsTypedValue": false,
  "MaxTypedValueSize": 987.65,
  "TypedValue": "xyz789",
  "DisplayOrder": "xyz789",
  "RelatedQuestions": [
    Pharma_RegistrationPolicyExtraField
  ]
}
Types

Pharma_RegistrationPolicyField

Fields
Field Name Description
field - String! Nome do campo (ID), utilizado para trafegar no serviço
label - String! Nome do campo a ser exibido na tela
type - Pharma_TypeField! Tipo do campo
description - String Descricao da utilidade do campo
display - Pharma_DisplayField! Regra para exibição
entity - Pharma_EntityRegister! Informa a entidade para qual é aplicada a política cadastral do campo em questão
defaultValue - String Valor inicial para o preenchimento do campo (valor default)
options - [Pharma_RegistrationPolicyFieldOption!]! Objeto do tipo Lista de PoliticaCadastralCampoOpcoes, apenas vira preenchido quando o tipo do campo for "Select"
Example
{
  "field": "xyz789",
  "label": "xyz789",
  "type": "STRING",
  "description": "xyz789",
  "display": "HIDDEN",
  "entity": "BENEFICIARIO",
  "defaultValue": "abc123",
  "options": [Pharma_RegistrationPolicyFieldOption]
}
Types

Pharma_RegistrationPolicyFieldOption

Fields
Field Name Description
text - String! Nome do texto a ser exibido para aquela opção
value - String! Nome do valor da opção (que deve ser retornada no campo)
Example
{
  "text": "abc123",
  "value": "abc123"
}
Types

Pharma_RequestStatus

Description

Status da solicitação

Values
Enum Value Description

SUCCESS

ERROR
Example
"SUCCESS"
Types

Pharma_StatusItem

Fields
Field Name Description
aproved - Boolean!
message - String!
Example
{"aproved": false, "message": "abc123"}
Types

Pharma_TextoTermosOptInRequest

Fields
Input Field Description
Ean - String!

EAN do produto
CPF - String!

CPF do beneficiário
Origem - Float!

Origem da solicitação
Example
{
  "Ean": "xyz789",
  "CPF": "abc123",
  "Origem": 987.65
}
Types

Pharma_TextoTermosOptInResponse

Fields
Field Name Description
CodigoEnvio - String Código de envio dos termos vinculado ao CPF do beneficiário
TextoTermos - String Texto dos Termos de Aceite do programa
LinkTermos - String URL para a página de aceite dos termos do programa
Status - String Status do envio
Mensagem - String Mensagem adicional
Example
{
  "CodigoEnvio": "xyz789",
  "TextoTermos": "abc123",
  "LinkTermos": "xyz789",
  "Status": "xyz789",
  "Mensagem": "xyz789"
}
Types

Pharma_TransactionType

Values
Enum Value Description

BENEFITS

PHARMA
Example
"BENEFITS"
Types

Pharma_TypeField

Description

Tipo do campo

Values
Enum Value Description

STRING

 Campo do tipo texto livre

INTEGER

 Campo do tipo numérico inteiro, de -2147483648 até 2147483647

DECIMAL

 Campo do tipo numérico real, de -2147483648.12 até 2147483647.12

BOOLEAN

 Campo do tipo booleano: true ou false

DATETIME

 Campo do tipo data hora, no formato yyyy-MM-dd HH:ii:ss. Exemplo: 2017-05-18 15:58:12

SELECT

 Campo para seleção de valor em lista. Os valores possíveis estão em "options".

CHECKBOX

 Campo tipo flag ou multiseleção. Os valores possíveis estão em "options".

RADIO_BUTTON

 Campo do tipo radio. Os valores possíveis estão em "options".

ROLE

 Regras para validação de formulário. Campo livre.
Example
"STRING"
Types

Pharma_ValidationError

Fields
Field Name Description
message - String Mensagem descrevendo o erro
Example
{"message": "abc123"}
Types

Pharma_ValidationResult

Fields
Field Name Description
status - Pharma_RequestStatus! Informa se o resultado da operação é válido ou não
message - String Mensagem informativa, normalmente resultante de uma ação com resultado positivo. Não é relevante sistemicamente, apenas para leitura do contente trafegado.
errors - [Pharma_ValidationError!]! Será preenchida caso o resultado não seja válido
Example
{
  "status": "SUCCESS",
  "message": "xyz789",
  "errors": [Pharma_ValidationError]
}
Types

Prescription_CouncilTypeEnum

Description

Tipo de conselho profissional

Values
Enum Value Description

CRM

 Conselho Regional de Medicina (CRM)

CRO

 Conselho Regional de Odontologia (CRO)

CRN

 Conselho Regional de Nutrição (CRN)
Example
"CRM"
Types

Prescription_Dependent

Fields
Field Name Description
dependentCardNumber - String!
prescriptions - [Prescription_Prescription!]!
Example
{
  "dependentCardNumber": "xyz789",
  "prescriptions": [Prescription_Prescription]
}
Types

Prescription_Holder

Fields
Field Name Description
cardNumber - String!
prescriptions - [Prescription_Prescription!]!
dependent - [Prescription_Dependent!]!
Example
{
  "cardNumber": "abc123",
  "prescriptions": [Prescription_Prescription],
  "dependent": [Prescription_Dependent]
}
Types

Prescription_PaginationInput

Fields
Input Field Description
page - Int!
take - Int!
Example
{"page": 123, "take": 987}
Types

Prescription_Prescriber

Fields
Field Name Description
name - String! Nome do profissional
enrollment - Float! Número de inscrição
council - Prescription_CouncilTypeEnum! Conselho
fu - String! Unidade federativa (estado) do conselho
active - Boolean! Indica se a inscrição no conselho está ativa
Example
{
  "name": "abc123",
  "enrollment": 987.65,
  "council": "CRM",
  "fu": "abc123",
  "active": true
}
Types

Prescription_Prescription

Fields
Field Name Description
id - ID!
uploadedAt - DateTime!
deletedAt - DateTime
expiresAt - DateTime
source - Prescription_Source!
file - JSON
name - String
cardNumber - String
identity - String
status - Prescription_Status
storage - String
originalName - String
extension - String
prescriptionName - String
dateIssuance - String
Example
{
  "id": "4",
  "uploadedAt": "2007-12-03T10:15:30Z",
  "deletedAt": "2007-12-03T10:15:30Z",
  "expiresAt": "2007-12-03T10:15:30Z",
  "source": "MOBILE_APP",
  "file": {},
  "name": "abc123",
  "cardNumber": "xyz789",
  "identity": "abc123",
  "status": "ACTIVE",
  "storage": "xyz789",
  "originalName": "xyz789",
  "extension": "abc123",
  "prescriptionName": "xyz789",
  "dateIssuance": "xyz789"
}
Types

Prescription_PrescriptionSourceInput

Description

A source of a prescription file, it can be uploaded into file with GraphQL Form Data specs or using an url. Either one or another must be specified. If both are specified, the file field has precedence.

Fields
Input Field Description
file - Prescription_Upload
url - URL
Example
{
  "file": Prescription_Upload,
  "url": "http://www.test.com/"
}
Types

Prescription_Source

Description

Source of file

Values
Enum Value Description

MOBILE_APP

WEB_APP

PORTAL_GESTOR

PLANT

DTS

POINT_OF_SALES

CALL_CENTER

INDUSTRY_PROGRAM_WEBSITE

INTERACTIVE_VOICE_RESPONSE

VACCINES_INDUSTRY_PROGRAM_WEBSITE

PURCHASE

AZIMUTE

PARTNERS_ECOMMERCE

MANAGER_SYSTEM

FACEBOOK

ELECTRONIC_PRESCRIPTION

CCUCO

BCARE

CONSULTA_REMEDIO

MEMED

FARMACIAS_APP

PEDBOT

DELIVERY

UNKNOWN
Example
"MOBILE_APP"
Types

Prescription_Status

Description

Status of a prescription

Values
Enum Value Description

ACTIVE

INACTIVE

REMOVED

UNKNOWN
Example
"ACTIVE"
Types

Prescription_TimeRangeFilterInput

Fields
Input Field Description
since - DateTime!
until - DateTime!
Example
{
  "since": "2007-12-03T10:15:30Z",
  "until": "2007-12-03T10:15:30Z"
}
Types

Prescription_TransactionInput

Fields
Input Field Description
authorization - Int!
sequence - Int!
timestamp - DateTime!
Example
{
  "authorization": 123,
  "sequence": 987,
  "timestamp": "2007-12-03T10:15:30Z"
}
Types

Prescription_Upload

Example
Prescription_Upload
Types

Prescription_UploadInfo

Fields
Input Field Description
cardNumber - String!
cpf - String
source - Prescription_Source!
mime - String
prescriptionName - String
dateIssuance - DateTime

Date of issue of medical prescription.
Example
{
  "cardNumber": "abc123",
  "cpf": "xyz789",
  "source": "MOBILE_APP",
  "mime": "abc123",
  "prescriptionName": "abc123",
  "dateIssuance": "2007-12-03T10:15:30Z"
}
Types

Profile

Description

An user profile

Fields
Field Name Description
role - UserTypeEnum! Type of the user.
identity - String User identity.
Example
{"role": "MASTER", "identity": "xyz789"}
Types

Sales_Authorization

Fields
Field Name Description
createdAt - DateTime Data e hora local da Transação
authorizationID - ID Número da autorização
sequenceID - ID Sequencial da autorização
totalValue - Float Valor total da Transação
moneyPaidValue - Float Valor a pagar no PDV
cardPaidValue - Float Valor do debito no cartão Funcional
cardBalance - Float Saldo disponível no cartão
products - [Sales_Product] Produtos
status - Sales_TransactionStatusEnum Status da transação
statusCode - Int Código do status de retorno
statusMessage - String Mensagem do status que será apresentada no autorizador
receipt - String Comprovante para impressão
secondFactorAuthentication - Sales_SecondFactorAuthenticationType Autenticação em 2 fatores (padrão: NONE)
reimbursementValue - Float Valor de ressarcimento
origin - Sales_AuthorizationOriginEnum Origem da solicitação
Example
{
  "createdAt": "2007-12-03T10:15:30Z",
  "authorizationID": 4,
  "sequenceID": 4,
  "totalValue": 987.65,
  "moneyPaidValue": 123.45,
  "cardPaidValue": 123.45,
  "cardBalance": 987.65,
  "products": [Sales_Product],
  "status": "SUCCESS",
  "statusCode": 123,
  "statusMessage": "abc123",
  "receipt": "xyz789",
  "secondFactorAuthentication": "NONE",
  "reimbursementValue": 123.45,
  "origin": "DTS"
}
Types

Sales_AuthorizationOriginEnum

Description

Origem da autorização

Values
Enum Value Description

DTS

 Carga de base histórica

MOBILE_APP

 Aplicativo Mobile

POINT_OF_SALES

 Ponto de venda

CALL_CENTER

 Atendimento via call center

INDUSTRY_PROGRAM_WEBSITE

 Site de programa da indústria

INTERACTIVE_VOICE_RESPONSE

 Unidade Resposta Audível (URA)

VACCINES_INDUSTRY_PROGRAM_WEBSITE

 Site Prog Indústria (vacinas)

PURCHASE

 Cadastro via compra de produto

AZIMUTE

 Azimute (parceiro)

PARTNERS_ECOMMERCE

 E-commerce de Parceiros

MANAGER_SYSTEM

 Sistema Gestor

FACEBOOK

 Facebook

ELECTRONIC_PRESCRIPTION

 Prescrição Eletrônica

CCUCO

 Ccuco (parceiro)

BCARE

 BCare (parceiro)

CONSULTA_REMEDIO

 Marketplace

MEMED

 Marketplace

FARMACIAS_APP

 Marketplace

PEDBOT

 Marketplace

DELIVERY

 Serviço de delivery

IFOOD

 Ifood

BF
Example
"DTS"
Types

Sales_CanceledTransaction

Fields
Field Name Description
createdAt - DateTime Data e hora local da Transação
authorizationID - ID Número da autorização
status - Sales_TransactionStatusEnum Status da transação
statusCode - Int Código do status de retorno
statusMessage - String Mensagem do status que será apresentada no autorizador
receipt - String Comprovante para impressão
Example
{
  "createdAt": "2007-12-03T10:15:30Z",
  "authorizationID": "4",
  "status": "SUCCESS",
  "statusCode": 123,
  "statusMessage": "abc123",
  "receipt": "abc123"
}
Types

Sales_CouncilEnum

Values
Enum Value Description

CRM

CRO
Example
"CRM"
Types

Sales_Customer

Fields
Field Name Description
code - String Identificação do consumidor (cartão Benefits ou CPF para Pharma)
name - String Nome do Beneficiario
Example
{
  "code": "abc123",
  "name": "abc123"
}
Types

Sales_CustomerMembershipInfo

Fields
Field Name Description
customer - Sales_Customer Dados do consumidor
memberships - [Sales_Membership] Programas que esse cartao possui
Example
{
  "customer": Sales_Customer,
  "memberships": [Sales_Membership]
}
Types

Sales_MedicalPrescription

Fields
Field Name Description
date - Date Data da receita
quantity - Int Quantidade receitada do produto
dailyDose - Int Dose diária do medicamento
prescriber - Sales_PrescriberRegister Dados do registro profissional prescritor da receita (Médico, Dentista)
Example
{
  "date": "2007-12-03",
  "quantity": 987,
  "dailyDose": 123,
  "prescriber": Sales_PrescriberRegister
}
Types

Sales_MedicalPrescriptionInput

Fields
Input Field Description
date - Date!

Data da receita
quantity - Int!

Quantidade receitada do produto
informaDoseDiaria - Boolean

Deprecado, este campo está obsoleto e será removido no futuro. Indica se o beneficiário informa dose diária
dailydose - Float

Dose diária do produto
prescriber - Sales_PrescriberRegisterInput!

Dados do registro profissional prescritor da receita (Médico, Dentista)
usage - Sales_UsageEnum

Indica se o produto foi prescrito para uso contínuo
Example
{
  "date": "2007-12-03",
  "quantity": 123,
  "informaDoseDiaria": false,
  "dailydose": 987.65,
  "prescriber": Sales_PrescriberRegisterInput,
  "usage": "OCCASIONAL"
}
Types

Sales_Membership

Fields
Field Name Description
id - ID Código do programa
name - String Nome do programa
type - Sales_ProgramTypeEnum Tipo de programa
description - String Descrição do programa
salingMessage - String Mensagem para a venda
Example
{
  "id": 4,
  "name": "xyz789",
  "type": "BENEFITS",
  "description": "xyz789",
  "salingMessage": "abc123"
}
Types

Sales_PreAuthorizedSaleSecondFactorStatus

Values
Enum Value Description

VALID

INVALID
Example
"VALID"
Types

Sales_PreAuthorizedSaleSecondFactorValidationResult

Fields
Field Name Description
status - Sales_PreAuthorizedSaleSecondFactorStatus Status da validação
statusMessage - String Mensagem do status que será apresentada no autorizador
Example
{
  "status": "VALID",
  "statusMessage": "xyz789"
}
Types

Sales_PrescriberRegister

Fields
Field Name Description
council - Sales_CouncilEnum Órgão emissor do registro
registerNumber - Int Número do registro
stateAbbr - String Sigla do estado emissor do registro
Example
{
  "council": "CRM",
  "registerNumber": 987,
  "stateAbbr": "abc123"
}
Types

Sales_PrescriberRegisterInput

Fields
Input Field Description
council - Sales_CouncilEnum!

Órgão emissor do registro
registerNumber - Int!

Número do registro
stateAbbr - String!

Sigla do estado emissor do registro
Example
{
  "council": "CRM",
  "registerNumber": 987,
  "stateAbbr": "abc123"
}
Types

Sales_Product

Fields
Field Name Description
ean - String Código EAN13 do produto
description - String Descrição do produto
maxConsumerPrice - Float Preço máximo do produto para o consumidor
unitPrice - Float Valor unitário do produto
quantity - Int Quantidade solicitada do produto
medicalPrescription - Sales_MedicalPrescription Receita médica
status - Sales_TransactionStatusEnum Status da transação
statusCode - Int Codigo de retorno do processamento do item
statusMessage - String Mensagem do status que será apresentada no autorizador
reimbursementValue - Float Valor de ressarcimento
storePlan - String Plano do estabelecimento
clientCode - String CNPJ do cliente
totalValue - Float Valor total
moneyPaidValue - Float Valor à pagar à vista
cardPaidValue - Float Valor à pagar no cartão
Example
{
  "ean": "abc123",
  "description": "abc123",
  "maxConsumerPrice": 987.65,
  "unitPrice": 123.45,
  "quantity": 123,
  "medicalPrescription": Sales_MedicalPrescription,
  "status": "SUCCESS",
  "statusCode": 123,
  "statusMessage": "xyz789",
  "reimbursementValue": 987.65,
  "storePlan": "xyz789",
  "clientCode": "xyz789",
  "totalValue": 987.65,
  "moneyPaidValue": 123.45,
  "cardPaidValue": 987.65
}
Types

Sales_ProductInput

Fields
Input Field Description
ean - String!

Código EAN13 do produto
unitPrice - Float!

Valor unitário do produto
maxConsumerPrice - Float

Valor unitário do produto
quantity - Int!

Quantidade solicitada do produto
medicalPrescription - Sales_MedicalPrescriptionInput

Receita médica
Example
{
  "ean": "abc123",
  "unitPrice": 123.45,
  "maxConsumerPrice": 987.65,
  "quantity": 987,
  "medicalPrescription": Sales_MedicalPrescriptionInput
}
Types

Sales_ProgramTypeEnum

Values
Enum Value Description

BENEFITS

 Benefício Farmácia

PHARMA

 PBM
Example
"BENEFITS"
Types

Sales_SecondFactorAuthenticationType

Values
Enum Value Description

NONE

TOKEN
Example
"NONE"
Types

Sales_Transaction

Fields
Field Name Description
createdAt - DateTime Data e hora local da Transação
authorizationID - ID Número da autorização
sequenceID - ID Sequencial da autorização
totalValue - Float Valor total da Transação
moneyPaidValue - Float Valor a pagar no PDV
cardPaidValue - Float Valor do debito no cartão Funcional
products - [Sales_Product] Produtos
status - Sales_TransactionStatusEnum Status da transação
statusCode - Int Código do status de retorno
statusMessage - String Mensagem do status que será apresentada no autorizador
Example
{
  "createdAt": "2007-12-03T10:15:30Z",
  "authorizationID": "4",
  "sequenceID": 4,
  "totalValue": 123.45,
  "moneyPaidValue": 123.45,
  "cardPaidValue": 987.65,
  "products": [Sales_Product],
  "status": "SUCCESS",
  "statusCode": 987,
  "statusMessage": "xyz789"
}
Types

Sales_TransactionStatusEnum

Values
Enum Value Description

SUCCESS

ERROR
Example
"SUCCESS"
Types

Sales_TransactionTypeEnum

Values
Enum Value Description

BENEFITS

 Benefício Farmácia

PHARMA

 PBM
Example
"BENEFITS"
Types

Sales_UpdatedInvoiceCode

Fields
Field Name Description
status - Sales_TransactionStatusEnum Status
statusCode - Int Código do status de retorno
statusMessage - String Mensagem do status que será apresentada no autorizador
Example
{
  "status": "SUCCESS",
  "statusCode": 123,
  "statusMessage": "abc123"
}
Types

Sales_UsageEnum

Values
Enum Value Description

OCCASIONAL

CONTINUAL
Example
"OCCASIONAL"
Types

ServiceCodeEnum

Description

Service codes

Values
Enum Value Description

CA

WE

RE

MSR

RA

FNB

TT

AMF

SST

ECF

CP

AUT
Example
"CA"
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"xyz789"
Types

Token

Description

A Token type

Fields
Field Name Description
token - String! The generated token
allowedServices - [String] List of services this user is allowed to use. Now each application sets its own rules.
user - User Authenticated user.
Example
{
  "token": "abc123",
  "allowedServices": ["xyz789"],
  "user": User
}
Types

URL

Description

Must be a valid, complete URL with schema.

Example
"http://www.test.com/"
Types

User

Description

A User Type

Fields
Field Name Description
id - ID User id.
uuid - ID User UUID.
email - String User e-mail.
kind - UserKindEnum User kind.
status - UserStatusEnum User status.
type - String Type of the user. Moved to the role field from the list of profiles.
name - String Name of the user.
identity - String User identity.
professionalLicense - String User professional license. Now get the identity from the pharmaceutical profile.
permissions - [Permission] Industries allowed in each service Now each application sets its own rules.
customersCodes - [String!]! Customers codes associated with the user Get the codes from the token payload itself.
socialMediaAvatarUrl - String If connected via social media, get the avatar URL
funcionalAcessoIdCredenciado - String If connected to Funcional Acesso, return the ID Credenciado No longer supported.
mobileNumber - String User mobile number.
bornOn - Date User birth date.
receiveOffers - Boolean If user accepts receiving offers by email/sms
passwordChangedAt - Datetime The last time the password was changed. It may be null if it was never changed.
profiles - [Profile!]! User profiles and roles
revokedUuids - [ID!]! User UUID.
socialIntegrations - [ID!]! User integration with social media.
createdAt - Datetime User Created At
lastLoginAt - Datetime The last time the user signed in. Please note that a user session may last for a long time, depending on the target service.
pendingEmail - String User unconfirmed e-mail address.
afterConfirmationRedirectUrl - String URL to redirect when confirmation.
authorized_app - String Origin of the request.
enrollment - String Matrícula.
facematch - Int Reconhecimento facial
mfa_code - String MFA code
mfa_expires_at - Datetime MFA expiration date and time
mfa_enabled - Boolean MFA enable flag
mfa_activated_at - Datetime MFA enable timestamp
Example
{
  "id": "4",
  "uuid": "4",
  "email": "abc123",
  "kind": "SYSTEM",
  "status": "UNCONFIRMED",
  "type": "abc123",
  "name": "xyz789",
  "identity": "xyz789",
  "professionalLicense": "abc123",
  "permissions": [Permission],
  "customersCodes": ["abc123"],
  "socialMediaAvatarUrl": "xyz789",
  "funcionalAcessoIdCredenciado": "abc123",
  "mobileNumber": "abc123",
  "bornOn": "2007-12-03",
  "receiveOffers": false,
  "passwordChangedAt": Datetime,
  "profiles": [Profile],
  "revokedUuids": ["4"],
  "socialIntegrations": [4],
  "createdAt": Datetime,
  "lastLoginAt": Datetime,
  "pendingEmail": "abc123",
  "afterConfirmationRedirectUrl": "abc123",
  "authorized_app": "abc123",
  "enrollment": "abc123",
  "facematch": 987,
  "mfa_code": "abc123",
  "mfa_expires_at": Datetime,
  "mfa_enabled": false,
  "mfa_activated_at": Datetime
}
Types

UserKindEnum

Description

User kind

Values
Enum Value Description

SYSTEM

PERSON

COMPANY
Example
"SYSTEM"
Types

UserStatusEnum

Description

Allowed user status

Values
Enum Value Description

UNCONFIRMED

ACTIVE

BLOCKED
Example
"UNCONFIRMED"
Types

UserTypeEnum

Description

Allowed user types

Values
Enum Value Description

MASTER

INDUSTRY

WHOLESALER

WHOLESALER_BRANCH

POINT_OF_SALES

RETAILER

SHOP_ASSISTANT

SHOP_MANAGER

PHARMACEUTICAL

BENEFITS_COMPANY

PHARMA_INDUSTRY

SUPPORT

PHARMA_BENEFIT_MANAGER

RETAIL_PHARMA_BENEFIT_MANAGER

POINT_OF_SALES_BUYER

BENEFICIARY_CARD

INDUSTRY_EMPLOYEE

PHARMA_COMPANY

TRADE_MANAGER

AUDIT_BF_ADMIN

AUDIT_BF_ANALYST

SYSTEM_FUNCIONAL_ACESSO_ACCREDITED_ID

FIDELIZACAO
Example
"MASTER"
Documentation by Anvil SpectaQL