Objeto «parceiro» «partner» – RetailForce

Este artigo aborda o objeto «partner» no âmbito do objeto «Document».

Uma descrição completa do RetailForce DOM (Modelo de Objetos de Documento), bem como uma descrição dos elementos individuais, pode ser consultada na área de downloads do RetailForce website (Documentação do modelo de objetos.pdf) no respetivo diretório de versões.

O objeto «parter» contém informações sobre os respetivos parceiros (comerciais) da empresa emissora do documento. Estes podem ser, por exemplo, parceiros externos, tais como clientes ou fornecedores, mas também «clientes» internos, como uma determinada filial da empresa para a qual as mercadorias são enviadas.

objeto-parceiro

O objeto «parter» a seguir apresenta dados de exemplo.

"partner": {
  "id": "2241247",
  "caption": "Jane Doe",
  "isBusiness": true,
  "partnerType": "[0] = Customer",
  "partnerClassification": "Customer",
  "vatNumber": null,
  "taxNumber": null,
  "identificationType": "passport",
  "partnerIdentification": null,
  "additionalIdentifications": null,
  "addresses": [
    {
      "addressType": "[1] = BillingAddress,
      "street": "Hintere Zollamtsstraße",
      "streetNumber": "4",
      "postalCode": "1030",
      "city": "Wien",
      "community": null,
      "countryCode": "AUT"
    }
  ],
  "addressType": "[1] = BillingAddress,
  "street": "Hintere Zollamtsstraße",
  "streetNumber": "4",
  "postalCode": "1030",
  "city": "Wien",
  "community": null,
  "countryCode": "AUT"
},

O objeto «parter» contém as seguintes informações.

Informações na coluna «Tipo»:

M ... obrigatório / exigido
M* ... obrigatório / exigido em determinados países ou sob determinadas condições
R ... recomendado
O... opcional

Elementos		Tipo	Descrição
ID		M	ID do parceiro. Pode ser, por exemplo, o número de cliente / ID.
caption		O	Designação dos parceiros (por exemplo, nome, denominação da empresa).
IsBusiness		M*	Indica se a transação é uma transação B2B (true) ou uma transação B2C (falso). Detalhes do país: França: Informações obrigatórias Portugal: Informações obrigatórias Québec/Canadá: Informações obrigatórias
PartnerType		M*	Tipo/classe de parceiro (empresarial) (Enum). Atualmente: [0] = Cliente [1] = Fornecedor Detalhes do país: Portugal: Informações obrigatórias
PartnerClassification		O	Classificação do parceiro (não o PartnerType!).
VatNumber		M*	Número de ID fiscal do parceiro (necessário para transações B2B).
taxNumber		O	Número fiscal do parceiro, por exemplo, «número fiscal da empresa» (NÃO é o número de Vat!)
IdentificationType		M*	forma como a identidade do parceiro foi confirmada. Enumeração PartnerIdentificationType: OfficialDocument Outro Passport Certificado de Residência
PartnerIdentification		M*	Identificação do parceiro — se definida, a propriedade «IdentificationType» também deve ser definida.
AdditionalIdentifications		O	Características de ID adicionais para diversos fins.
	lotteryId	O	ID de lotaria pessoal de um cliente em Itália. É necessária para participar na chamada lotaria diferida («Lotteria Differita») da «Lotteria degli Scontrini» («Lotaria dos Recibos»). Detalhes do país: Itália: Se um cliente pretender participar na Lotteria Differita, o seu ID pessoal deve ser introduzido neste campo.
	additionalProp1	O	Características adicionais do ID para diversos fins.
	additionalProp2	O	Funcionalidades de ID adicionais para diversos fins.
	additionalProp3	O	Funcionalidades de ID adicionais para diversos fins.
endereços		O/M*	Permite a introdução de vários endereços ou de endereços adicionais. Caso pretenda indicar apenas um endereço, utilize o campo geral «Document.Partner». Nota: Regra geral, os endereços devem ser sempre incluídos nas faturas B2B («documentType»: «[1] = Fatura»).
	addressType	O/M*	A propriedade «addressType» definida neste nível especifica o tipo de endereço introduzido em «Document.Partner.Addresses». Estão disponíveis os seguintes tipos de endereço: [1] = BillingAddress, [2] = Endereço de Entrega, [3] = EndereçoResidencial, [4] = Localização da Empresa, [5] = ServiçoPrestado Informações sobre o país: Portugal: Especificação dos tipos de endereço para faturas B2B em Portugal: [1] = BillingAddress - Obrigatório, [2] = EndereçoDeEntrega - Opcional
	rua	O/M*	Rua Dados do país: Portugal: Campo obrigatório Québec: Campo obrigatório se for especificado um «parceiro» (cliente). Revenu Québec apenas aceita informações sobre clientes canadianos.
	streetNumber	O/M*	Número da rua Detalhes do país: Portugal: Campo obrigatório Québec: Campo obrigatório se for especificado um «parceiro» (cliente). Revenu Québec apenas aceita informações sobre clientes canadianos.
	PostalCode	O/M*	Código postal Detalhes do país: Portugal: Campo obrigatório Québec: Campo obrigatório se for especificado um «parceiro» (cliente). Revenu Québec apenas aceita informações sobre clientes canadianos. O código postal deve estar no formato canadiano: A9A9A9 6 caracteres 1 carácter (letra), 1 número, 1 carácter (letra), 1 número, 1 carácter (letra), 1 número.
	cidade	O/M*	Cidade / Localidade Detalhes do país: Portugal: Campo obrigatório Québec: Campo obrigatório se for especificado um «parceiro» (cliente). Revenu Québec apenas aceita informações sobre clientes canadianos.
	comunidade	O	Em alguns países (por exemplo, a Eslovénia), a chamada «comunidade» faz parte da morada.
	CountryCode	O/M*	Código do país de acordo com a norma ISO 3166 alfa-3 (3 dígitos). Detalhes do país: Portugal: Campo obrigatório
addressType		O/M*	A propriedade «addressType» definida neste nível determina o tipo de endereço introduzido em «Document.Partner». Caso necessite de especificar vários endereços diferentes com tipos de endereço distintos, pode fazê-lo em «Document.Partner.Addresses». Estão disponíveis os seguintes tipos de endereço: [1] = BillingAddress, [2] = Endereço de Entrega, [3] = EndereçoResidencial, [4] = Localização da Empresa, [5] = ServiçoPrestado Detalhes do país: Portugal: Especificação dos tipos de endereço nas faturas B2B em Portugal: [1] = BillingAddress - Obrigatório, [2] = EndereçoDeEntrega - Opcional
rua		O/M*	Rua Dados do país: Portugal: Campo obrigatório Québec: Campo obrigatório caso seja especificado um «parceiro» (cliente). Revenu Québec apenas aceita informações relativas a clientes canadianos.
streetNumber		O/M*	Número da rua Detalhes do país: Portugal: Campo obrigatório Québec: Campo obrigatório se for especificado um «parceiro» (cliente). Revenu Québec apenas aceita informações sobre clientes canadianos.
PostalCode		O/M*	Código postal Detalhes do país: Portugal: Campo obrigatório Québec: Campo obrigatório se for especificado um «parceiro» (cliente). Revenu Québec apenas aceita informações sobre clientes canadianos. O código postal deve estar no formato canadiano: A9A9A9 6 caracteres 1 carácter (letra), 1 número, 1 carácter (letra), 1 número, 1 carácter (letra), 1 número.
cidade		O/M*	Cidade / Localidade Detalhes do país: Portugal: Campo obrigatório Québec: Campo obrigatório se for especificado um «parceiro» (cliente). Revenu Québec apenas aceita informações sobre clientes canadianos.
comunidade		O	Em alguns países (por exemplo, a Eslovénia), a chamada «comunidade» faz parte da morada.
CountryCode		O/M*	Código do país de acordo com a norma ISO 3166 alfa-3 (3 dígitos). Detalhes do país: Portugal: Campo obrigatório

Este artigo foi traduzido automaticamente.

objeto-parceiro

Artigos relacionados