Pular para o conteúdo principal
GET
Recuperar contrato

Supported products

Parâmetros de caminho

contractId
string
obrigatório

O identificador exclusivo do contrato a ser recuperado.

Resposta

successful operation

addressTypesToCollect
enum<string>[]
obrigatório

Uma matriz que indica os tipos de endereços a serem coletados. Os valores válidos incluem "BILLING_ADDRESS" e "SHIPPING_ADDRESS".

Opções disponíveis:
BILLING_ADDRESS,
SHIPPING_ADDRESS
allowedPaymentMethods
enum<string>[]
obrigatório

Uma matriz de métodos de pagamento permitidos. Os valores válidos incluem "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS", "PADS", "AFFIRM" e "KLARNA".

Opções disponíveis:
CREDIT_OR_DEBIT_CARD,
ACH,
SEPA,
BACS,
PADS,
AFFIRM,
KLARNA
automatedTaxesEnabled
boolean
obrigatório

Indica se os impostos automatizados estão ativados para o contrato.

customProperties
object
obrigatório

Um mapa de nomes de propriedades personalizadas para seus valores.

hubspotBillingEnabled
boolean
obrigatório

Indica se a cobrança da HubSpot está ativada para o contrato.

id
string
obrigatório

O identificador exclusivo do contrato.

lineItems
object[]
obrigatório

Uma lista de itens de linha incluídos no contrato.

paymentEnabled
boolean
obrigatório

Indica se o pagamento está habilitado para o contrato.

status
enum<string>
obrigatório

O status atual do contrato. Os valores válidos incluem "DRAFT", "ACTIVE", "PAUSED", "COMPLETED" e "TERMINATED".

Opções disponíveis:
ACTIVE,
COMPLETED,
DRAFT,
PAUSED,
TERMINATED
storePaymentMethodAtCheckout
boolean
obrigatório

Indica se o método de pagamento deve ser armazenado no checkout.

allTransactionsFeeName
string

Nome da taxa aplicada a todas as transações.

allTransactionsFeePercentage
number

A porcentagem da taxa aplicada a todas as transações.

annualContractValue
number

O valor anual do contrato.

billingAddress
object
billingCompanyId
string

O identificador exclusivo da empresa de cobrança associada ao contrato.

billingContactId
string

Identificador exclusivo do contato de cobrança associado ao contrato.

billingStartDateOverride
string<date>

A data para substituir a data de início da cobrança, no formato ISO 8601.

businessUnitId
string

O identificador exclusivo da unidade de negócio associada ao contrato.

cardFeeName
string

O nome da taxa aplicada às transações com cartão.

cardFeePercentage
number

A porcentagem da taxa aplicada a transações com cartão.

collectionProcess
enum<string>

O processo de cobrança de pagamentos. Os valores válidos incluem "MANUAL_PAYMENTS" e "AUTOMATIC_PAYMENTS".

Opções disponíveis:
AUTOMATIC_PAYMENTS,
MANUAL_PAYMENTS
contractEffectiveDate
string<date>

A data em que o contrato entra em vigor, no formato ISO 8601.

contractSourceId
string

O identificador exclusivo da origem do contrato.

createdAt
string<date-time>

A data e a hora em que o contrato foi criado, no formato ISO 8601.

currencyCode
string

O código da moeda associado ao contrato, representado como uma string.

currentAnnualRecurringRevenue
number

A receita recorrente anual atual do contrato.

currentMonthlyRecurringRevenue
number

A receita mensal recorrente atual do contrato.

dealId
string

O identificador exclusivo do negócio associado ao contrato.

directDebitFeeName
string

O nome da taxa aplicada a transações de débito direto.

directDebitFeePercentage
number

A porcentagem da taxa aplicada a transações de débito direto.

discountCode
string

O código de desconto aplicado ao contrato.

endDate
string<date>

A data de término do contrato, no formato ISO 8601.

externalPaymentMethodReferenceId
string

O ID de referência externa para o método de pagamento.

language
string

O idioma associado ao contrato.

locale
string

O local associado ao contrato.

name
string

O nome do contrato.

netPaymentTerms
integer<int32>

Os termos de pagamento líquidos do contrato, representados como um número inteiro.

paymentMethod
string

O método de pagamento usado no contrato.

poNumber
string

O número do pedido de compra associado ao contrato.

preTerminationContractValue
number

O valor do contrato antes da rescisão.

renewalContractId
string

O identificador exclusivo do contrato de renovação.

renewalDate
string<date>

A data em que o contrato será renovado, no formato ISO 8601.

sellerCompanyAddress
object
sellerCompanyName
string

O nome da empresa do vendedor.

sellerEmail
string

O endereço de e-mail do vendedor.

sellerFirstName
string

O nome do vendedor.

sellerLastName
string

O sobrenome do vendedor.

sellerPhoneNumber
string

O número de telefone do vendedor.

startDate
string<date>

A data de início do contrato, no formato ISO 8601.

terminationDate
string<date>

A data de rescisão do contrato, no formato ISO 8601.

totalBilledAmount
number

O valor total faturado no contrato.

totalBilledAmountPreTax
number

O valor total faturado no contrato antes dos impostos.

totalCollectedFees
number

O valor total das taxas cobradas sob o contrato.

totalCollectedTaxes
number

O valor total dos impostos recolhidos sob o contrato.

totalContractValue
number

O valor total do contrato.

totalPaidAmount
number

O valor total pago no contrato.

updatedAt
string<date-time>

A data e a hora da última atualização do contrato, no formato ISO 8601.

Última modificação em 6 de outubro de 2026