Partilhar via


Blackbaud FENXT Pagável (Pré-visualização)

O Blackbaud Financial Edge NXT é uma solução abrangente de software de contabilidade baseada na nuvem criada especificamente para organizações sem fins lucrativos. Use o conector de Contas a Pagar para gerenciar faturas, fornecedores, ordens de compra e entidades relacionadas encontradas no The Financial Edge NXT.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte Blackbaud
URL https://www.blackbaud.com/support
Email skyapi@blackbaud.com
Metadados do conector
Editora Blackbaud, Inc.
Sítio Web https://www.blackbaud.com/products/blackbaud-financial-edge-nxt
Política de privacidade https://www.blackbaud.com/privacy-shield
Categorias Vendas e CRM; Produtividade

O Financial Edge NXT é uma solução abrangente de software de contabilidade baseada na nuvem criada especificamente para organizações sem fins lucrativos.

Este conector é construído sobre a API SKY da Blackbaud e fornece operações para ajudar a gerenciar faturas, fornecedores, ordens de compra e entidades relacionadas encontradas no The Financial Edge NXT.

Para mais informações, consulte a documentação.

Pré-requisitos

Para usar esse conector, você deve ter uma conta Blackbaud ID com acesso a um ou mais ambientes Blackbaud.

Além disso, o administrador da sua organização também deve executar uma ação de nível de administrador dentro do sistema para permitir que esse conector acesse seu ambiente Blackbaud. Mais informações sobre esses pré-requisitos podem ser encontradas na documentação de configuração inicial .

Como obter credenciais?

O administrador da sua organização enviará um convite para o ambiente NXT do Financial Edge da organização e configurará as permissões da sua conta de utilizador no ambiente. Não são necessárias credenciais adicionais para usar esse conector.

Problemas conhecidos e limitações

O conector funcionará no contexto da sua conta de usuário e, portanto, estará sujeito às suas permissões de usuário dentro do ambiente.

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Atualizar um endereço de fornecedor

Atualiza um endereço de fornecedor.

Atualizar um fornecedor

Atualiza um fornecedor.

Atualizar uma fatura

Atualiza uma fatura.

Criar um anexo de fatura

Cria um novo anexo de fatura.

Criar um anexo de fornecedor

Cria um novo anexo de fornecedor.

Criar um endereço de fornecedor

Cria um novo endereço de fornecedor.

Criar um fornecedor

Cria um novo fornecedor.

Criar um item de linha da ordem de compra

Cria um novo item de linha de ordem de compra.

Criar um método de contato de endereço de fornecedor

Cria um novo método de contato para um endereço de fornecedor.

Criar uma ação de fornecedor

Cria uma nova ação de fornecedor.

Criar uma fatura

Cria uma nova fatura usando as distribuições padrão do fornecedor especificado.

Criar uma fatura (distribuição única)

Cria uma nova fatura com uma única distribuição.

Criar uma nota de encomenda

Cria uma nova ordem de compra.

Criar uma nota de fornecedor

Cria uma nova nota de fornecedor.

Excluir um ajuste de fatura

Exclui um ajuste de fatura.

Excluir um anexo de fornecedor

Exclui um anexo de fornecedor.

Excluir um endereço de fornecedor

Exclui um endereço de fornecedor.

Excluir uma nota de crédito

Exclui uma nota de crédito.

Listar ajustes de fatura

Lista os ajustes de uma fatura.

Listar anexos de fornecedor

Lista os anexos de um fornecedor.

Listar contatos do fornecedor

Lista os contatos de um fornecedor.

Listar distribuições padrão do fornecedor

Lista as distribuições padrão para um fornecedor.

Listar endereços de fornecedores

Lista os endereços de um fornecedor.

Listar faturas

Lista as faturas disponíveis.

Listar fornecedores

Lista os fornecedores disponíveis.

Listar itens de linha da ordem de compra

Lista os itens de linha de uma ordem de compra.

Listar métodos de contato de endereço do fornecedor

Lista os métodos de contato para um endereço de fornecedor.

Listar notas e ações do fornecedor

Lista as anotações e ações de um fornecedor.

Listar números de caixa da fatura 1099

Lista os números de caixa 1099 de uma fatura.

Listar ordens de compra

Lista as ordens de compra disponíveis.

Listar recibos

Lista os recibos disponíveis.

Obter informações da fatura 1099

Devolve as informações 1099 de uma fatura.

Obter informações do fornecedor 1099

Obtenha as informações 1099 para um fornecedor.

Obter um ajuste de fatura

Retorna informações sobre um ajuste de fatura.

Obter um fornecedor

Retorna informações sobre um fornecedor.

Obter um item de linha de ordem de compra

Retorna informações sobre um item de linha de ordem de compra.

Obter um recibo

Retorna informações sobre um recibo.

Obter uma fatura

Retorna informações sobre uma fatura.

Obter uma ordem de compra

Retorna informações sobre uma ordem de compra.

Atualizar um endereço de fornecedor

Atualiza um endereço de fornecedor.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
vendor_id True integer

O ID de registro do sistema do fornecedor.

ID do endereço
address_id True integer

O ID de registro do sistema do endereço do fornecedor a ser atualizado.

Description
description string

A descrição do endereço.

Country
country string

O país do endereço.

Linhas de endereço
address_line string

As linhas de rua/endereço para o endereço. Limite de caracteres: 150.

City
city string

A cidade do endereço.

Estado
state string

O estado ou província (ou subúrbio na Nova Zelândia) para o endereço.

Código postal
postal string

O código postal ou CEP do endereço. Limite de caracteres: 12.

Condado
county string

O município do endereço.

É primário?
is_primary boolean

Este é o endereço principal do fornecedor?

Enviar faturas?
is_invoices boolean

Enviar faturas para este endereço?

Enviar OPs?
is_pos boolean

Enviar ordens de compra para este endereço?

Enviar 1099s?
issue_1099s boolean

Enviar 1099s para este endereço?

Título do contacto
title string

O título do contato principal.

Nome próprio do contacto
first_name string

O primeiro nome do contato principal.

Nome do meio de contato
middle_name string

A inicial do meio ou o nome do contato principal.

Sobrenome do contato
last_name string

O sobrenome do contato principal.

Sufixo de contato
suffix string

O sufixo do contato primário.

Posição de contacto
position string

A posição do contato principal.

Devoluções

Endereço do fornecedor criado

Atualizar um fornecedor

Atualiza um fornecedor.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
vendor_id True integer

O ID de registro do sistema do fornecedor a ser atualizado.

Nome
vendor_name string

O nome do fornecedor. Limite de caracteres: 60.

Tipo
vendor_type string

O tipo de fornecedor.

Número de cliente
customer_number string

O número de cliente do fornecedor.

Situação
vendor_status string

O status do fornecedor.

Emitir 1099 declaração?
issue_1099s boolean

Emitir uma declaração 1099 para o fornecedor?

Limite de crédito?
has_credit_limit boolean

A inadimplência tem limite de crédito?

Valor do limite de crédito
credit_limit decimal

O limite de crédito padrão de pagamento.

Termos de pagamento
payment_terms string

As condições de pagamento (NET).

Conta de pagamento
account_name string

A conta a partir da qual pagar faturas.

Método de pagamento
payment_method string

O método de pagamento.

Opção de pagamento
payment_option string

A opção de pagamento.

Devoluções

Fornecedor criado

Atualizar uma fatura

Atualiza uma fatura.

Parâmetros

Name Chave Necessário Tipo Description
ID da fatura
invoice_id True integer

O ID de registro do sistema da fatura a ser atualizada.

Número da fatura
invoice_number string

O número da fatura.

Data da fatura
invoice_date date

A data da fatura (ex: «2005-09-18»).

Data de vencimento
due_date date

A data de vencimento da fatura (ex: '2005-09-18').

Estado da publicação
post_status string

O status de postagem da fatura.

Data de publicação
post_date date

A data de publicação da fatura (ex: '2005-09-18').

Montante
amount decimal

O valor da fatura.

Description
description string

A descrição da fatura.

Estado de aprovação
status string

O status de aprovação da fatura.

Distribuir descontos?
distribute_discounts boolean

Distribuir descontos para faturar contas de despesas?

Método de pagamento
payment_method string

O método de pagamento da fatura.

Missão para
address_id integer

O mandato a endereçar para a fatura.

Pago a partir de
paid_from string

O banco do qual a fatura é paga.

ID da conta do cartão
credit_card_account_id integer

O ID de registo do sistema da conta de cartão de crédito a partir da qual a fatura é paga.

Identificação do cartão
credit_card_id integer

O ID de registro do sistema do cartão de crédito a partir do qual a fatura é paga.

Atrasar o pagamento?
hold_payment boolean

Atrasar o pagamento nesta fatura?

Pagamento separado?
create_separate_payment boolean

Criar sempre um pagamento separado para esta fatura?

Devoluções

Fatura criada

Criar um anexo de fatura

Cria um novo anexo de fatura.

Parâmetros

Name Chave Necessário Tipo Description
ID da fatura
parent_id True integer

O ID de registro do sistema da fatura.

Tipo
type True string

O tipo de anexo.

Nome
name True string

O nome do anexo. Limite de caracteres: 150.

Tipo de anexo
media_type True string

Categoria deste anexo definida pelo utilizador. Os valores disponíveis são as entradas na tabela Tipo de mídia para o registro pai. Use os tipos de valor definidos em /mediaTypes

URL
url string

O URL do anexo. Isso é necessário para anexos de link e ignorado para anexos físicos.

Conteúdo do ficheiro
file binary

O conteúdo binário do anexo do arquivo. Isso é necessário para anexos físicos e ignorado para anexos de link.

Nome do ficheiro
file_name string

O nome do arquivo para o anexo. Isso é necessário para anexos físicos e ignorado para anexos de link.

Devoluções

Anexo de fatura criado

Criar um anexo de fornecedor

Cria um novo anexo de fornecedor.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
parent_id True integer

O ID de registro do sistema do fornecedor.

Tipo
type True string

O tipo de anexo.

Nome
name True string

O nome do anexo. Limite de caracteres: 150.

Tipo de anexo
media_type True string

Categoria deste anexo definida pelo utilizador. Os valores disponíveis são as entradas na tabela Tipo de mídia para o registro pai. Use os tipos de valor definidos em /mediaTypes

URL
url string

O URL do anexo. Isso é necessário para anexos de link e ignorado para anexos físicos.

Conteúdo do ficheiro
file binary

O conteúdo binário do anexo do arquivo. Isso é necessário para anexos físicos e ignorado para anexos de link.

Nome do ficheiro
file_name string

O nome do arquivo para o anexo. Isso é necessário para anexos físicos e ignorado para anexos de link.

Devoluções

Anexo de fornecedor criado

Criar um endereço de fornecedor

Cria um novo endereço de fornecedor.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
vendor_id True integer

O ID de registro do sistema do fornecedor.

Description
description True string

A descrição do endereço.

Country
country string

O país do endereço.

Linhas de endereço
address_line string

As linhas de rua/endereço para o endereço. Limite de caracteres: 150.

City
city string

A cidade do endereço.

Estado
state string

O estado ou província (ou subúrbio na Nova Zelândia) para o endereço.

Código postal
postal string

O código postal ou CEP do endereço. Limite de caracteres: 12.

Condado
county string

O município do endereço.

É primário?
is_primary boolean

Este é o endereço principal do fornecedor?

Enviar faturas?
is_invoices boolean

Enviar faturas para este endereço?

Enviar OPs?
is_pos boolean

Enviar ordens de compra para este endereço?

Enviar 1099s?
issue_1099s boolean

Enviar 1099s para este endereço?

Título do contacto
title string

O título do contato principal.

Nome próprio do contacto
first_name string

O primeiro nome do contato principal.

Nome do meio de contato
middle_name string

A inicial do meio ou o nome do contato principal.

Sobrenome do contato
last_name string

O sobrenome do contato principal.

Sufixo de contato
suffix string

O sufixo do contato primário.

Posição de contacto
position string

A posição do contato principal.

Devoluções

Endereço do fornecedor criado

Criar um fornecedor

Cria um novo fornecedor.

Parâmetros

Name Chave Necessário Tipo Description
Nome
vendor_name True string

O nome do fornecedor. Limite de caracteres: 60.

Tipo
vendor_type string

O tipo de fornecedor.

ID do fornecedor
ui_defined_id string

O identificador definido pelo usuário para o fornecedor.

Número de identificação fiscal
tax_id_number string

O número de identificação fiscal do fornecedor.

Número de cliente
customer_number string

O número de cliente do fornecedor.

Situação
vendor_status string

O status do fornecedor.

Emitir 1099 declaração?
issue_1099s boolean

Emitir uma declaração 1099 para o fornecedor?

Descrição do endereço
description True string

A descrição do endereço.

País de endereço
country string

O país do endereço.

Linhas de endereço
address_line string

As linhas de rua/endereço para o endereço. Limite de caracteres: 150.

Cidade do endereço
city string

A cidade do endereço.

Estado do endereço
state string

O estado ou província (ou subúrbio na Nova Zelândia) para o endereço.

Endereço código postal
postal string

O código postal ou CEP do endereço. Limite de caracteres: 12.

Endereço county
county string

O município do endereço.

O endereço é principal?
is_primary boolean

Este é o endereço principal do fornecedor?

Enviar faturas?
is_invoices boolean

Enviar faturas para este endereço?

Enviar OPs?
is_pos boolean

Enviar ordens de compra para este endereço?

Enviar 1099s?
is_1099 boolean

Enviar 1099s para este endereço?

Título do contacto
title string

O título do contato principal.

Nome próprio do contacto
first_name string

O primeiro nome do contato principal.

Nome do meio de contato
middle_name string

A inicial do meio ou o nome do contato principal.

Sobrenome do contato
last_name string

O sobrenome do contato principal.

Sufixo de contato
suffix string

O sufixo do contato primário.

Posição de contacto
position string

A posição do contato principal.

Limite de crédito?
has_credit_limit boolean

A inadimplência tem limite de crédito?

Valor do limite de crédito
credit_limit decimal

O limite de crédito padrão de pagamento.

Termos de pagamento
payment_terms string

As condições de pagamento (NET).

Conta de pagamento
account_name string

A conta a partir da qual pagar faturas.

Método de pagamento
payment_method string

O método de pagamento.

Opção de pagamento
payment_option string

A opção de pagamento.

Sucursal do ICMS
gst_branch string

O identificador de ramificação GST para este fornecedor (aplicável apenas para versões AU).

ID do tipo de imposto GST
gst_tax_type_id integer

O identificador de tipo de imposto GST para o fornecedor (aplicável apenas para versões CA e AU).

ID do código de atividade PSB
psb_activity_code_id integer

O identificador de código de atividade PSB para o fornecedor (aplicável apenas para versões de autoridade de certificação).

Devoluções

Fornecedor criado

Criar um item de linha da ordem de compra

Cria um novo item de linha de ordem de compra.

Parâmetros

Name Chave Necessário Tipo Description
ID da ordem de compra
purchase_order_id True integer

O ID de registro do sistema da ordem de compra.

Tipo
type True string

O tipo do item de linha. Atualmente, apenas itens de linha Regular são suportados.

Description
description string

A descrição do item de linha.

Unidade de medida
unit_of_measure string

A unidade de medida.

Quantidade
quantity_ordered True decimal

A quantidade encomendada.

Custo unitário
unit_cost True decimal

O custo unitário do item de linha.

Custo alargado
extended_cost True decimal

O custo estendido do item de linha.

Número de peça do fornecedor
vendor_part_number string

O número de peça do fornecedor do item de linha.

ID do produto
product_id True integer

O identificador do produto para o item de linha.

Departamento
department string

O departamento para o item de linha.

Solicitado por
requested_by string

O membro da equipe que solicitou o item de linha.

Entregue em
deliver_to string

O membro da equipe para entregar para o item de linha.

Estado da publicação
post_status True string

O status da postagem para o item de linha.

Data de publicação
post_date date

A data de publicação do item de linha (ex: '2005-09-18').

Notas internas
notes string

Notas internas do item de linha.

Notas externas
comments string

Notas externas para o item de linha.

Criar um método de contato de endereço de fornecedor

Cria um novo método de contato para um endereço de fornecedor.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
vendor_id True integer

O ID de registro do sistema do fornecedor.

ID do endereço
address_id True integer

O ID de registro do sistema do endereço do fornecedor.

Tipo de contacto
contact_type string

O tipo de método de contato.

Informações de contacto
contact_info True string

As informações de contato (endereço de e-mail, número de telefone, etc.) para este método.

Devoluções

Método de contato de endereço do fornecedor criado

Criar uma ação de fornecedor

Cria uma nova ação de fornecedor.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
vendor_id True integer

O ID de registro do sistema do fornecedor.

Tipo
type True string

O tipo de ação.

Date
date True date

Data da ação (ex: «2005-09-18»).

Description
description string

A descrição da ação. Limite de caracteres: 255.

Atribuído a
assign_to True string

O usuário ao qual a ação será atribuída.

Está completo?
is_complete boolean

A ação está concluída?

Concluído a
completed_date date

Data de conclusão da ação (ex: «2005-09-18»).

Devoluções

Ação do fornecedor criada

Criar uma fatura

Cria uma nova fatura usando as distribuições padrão do fornecedor especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
vendor_id True integer

O ID de registro do sistema do fornecedor.

Número da fatura
invoice_number True string

O número da fatura.

Data da fatura
invoice_date True date

A data da fatura (ex: «2005-09-18»).

Data de vencimento
due_date True date

A data de vencimento da fatura (ex: '2005-09-18').

Estado da publicação
post_status True string

O status de postagem da fatura.

Data de publicação
post_date True date

A data de publicação da fatura (ex: '2005-09-18').

Montante
amount True decimal

O valor da fatura.

Description
description True string

A descrição da fatura.

Estado de aprovação
approval_status True string

O status de aprovação da fatura.

Conta de crédito
credit_account_number True string

O número da conta de crédito a ser usado ao gerar distribuições.

Distribuir descontos?
distribute_discounts boolean

Distribuir descontos para faturar contas de despesas?

Método de pagamento
payment_method True string

O método de pagamento da fatura.

Missão para
address_id True integer

O mandato a endereçar para a fatura.

Pago a partir de
paid_from string

O banco do qual a fatura é paga.

ID da conta do cartão
credit_card_account_id integer

O ID de registo do sistema da conta de cartão de crédito a partir da qual a fatura é paga.

Identificação do cartão
credit_card_id integer

O ID de registro do sistema do cartão de crédito a partir do qual a fatura é paga.

Atrasar o pagamento?
hold_payment boolean

Atrasar o pagamento nesta fatura?

Pagamento separado?
create_separate_payment boolean

Criar sempre um pagamento separado para esta fatura?

número da caixa
number True string

O número da caixa.

state
state string

O estado do número da caixa.

Montante
amount True decimal

O valor do número da caixa.

Devoluções

Fatura criada

Criar uma fatura (distribuição única)

Cria uma nova fatura com uma única distribuição.

Parâmetros

Name Chave Necessário Tipo Description
body
body True dynamic

A fatura a ser criada.

Devoluções

Fatura criada

Criar uma nota de encomenda

Cria uma nova ordem de compra.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
vendor_id True integer

O ID de registro do sistema do fornecedor.

Tipo
type True string

O tipo de ordem de compra.

Número da encomenda
order_number True integer

O número da ordem de compra.

Data da encomenda
order_date True date

A data do pedido (ex: '2005-09-18').

Situação
order_status True string

O status da ordem de compra.

Encomendar de
order_from_contact_id True integer

O identificador de contato do fornecedor para o ordenante da ordem de compra.

Envio via
ship_via True string

O método de envio da ordem de compra.

FOB
fob string

O frete a bordo da ordem de compra.

Terms
terms True string

O prazo da ordem de compra.

Comprador
buyer string

O comprador da ordem de compra.

Departamento
department string

O departamento da ordem de compra.

Confirmar para
ordered_by string

O ordenante da ordem de compra.

Enviar para
ship_to_address_id integer

O identificador do envio para o endereço da ordem de compra.

Expira
expiration_date date-time

A data de validade da ordem de compra (necessária para ordens de compra Blanket).

Atenção
attention string

O membro da equipe para atenção da ordem de compra.

Comments
comments string

Os comentários da ordem de compra.

Devoluções

Ordem de compra criada

Criar uma nota de fornecedor

Cria uma nova nota de fornecedor.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
vendor_id True integer

O ID de registro do sistema do fornecedor.

Tipo
type True string

O tipo de nota.

Date
date True date

A data da nota (ex: «2005-09-18»).

Description
description string

A descrição da nota. Limite de caracteres: 255.

Observação
content string

O texto da nota.

Devoluções

Nota do fornecedor criada

Excluir um ajuste de fatura

Exclui um ajuste de fatura.

Parâmetros

Name Chave Necessário Tipo Description
ID da fatura
invoice_id True integer

O ID de registro do sistema da fatura.

ID de ajuste
adjustment_id True integer

O ID de registro do sistema do ajuste da fatura a ser excluído.

Excluir um anexo de fornecedor

Exclui um anexo de fornecedor.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
vendor_id True integer

O ID de registro do sistema do fornecedor.

ID do anexo
attachment_id True integer

O ID de registro do sistema do anexo do fornecedor a ser excluído.

Excluir um endereço de fornecedor

Exclui um endereço de fornecedor.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
vendor_id True integer

O ID de registro do sistema do fornecedor.

ID do endereço
address_id True integer

O ID de registro do sistema do endereço do fornecedor a ser excluído.

Excluir uma nota de crédito

Exclui uma nota de crédito.

Parâmetros

Name Chave Necessário Tipo Description
ID da nota de crédito
credit_memo_id True integer

O ID de registro do sistema da nota de crédito.

Listar ajustes de fatura

Lista os ajustes de uma fatura.

Parâmetros

Name Chave Necessário Tipo Description
ID da fatura
invoice_id True integer

O ID de registro do sistema da fatura.

Devoluções

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Listar anexos de fornecedor

Lista os anexos de um fornecedor.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
vendor_id True integer

O ID de registro do sistema do fornecedor.

Devoluções

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Listar contatos do fornecedor

Lista os contatos de um fornecedor.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
vendor_id True integer

O ID de registro do sistema do fornecedor.

Devoluções

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Listar distribuições padrão do fornecedor

Lista as distribuições padrão para um fornecedor.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
vendor_id True integer

O ID de registro do sistema do fornecedor.

Limite
limit integer

Representa o número de registros a serem retornados. O padrão é 100. O máximo é 500.

Compensação
offset integer

Representa o número de registros a serem ignorados. Para utilização com paginação.

Devoluções

Distribuições

Listar endereços de fornecedores

Lista os endereços de um fornecedor.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
vendor_id True integer

O ID de registro do sistema do fornecedor.

Devoluções

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Listar faturas

Lista as faturas disponíveis.

Parâmetros

Name Chave Necessário Tipo Description
A partir da data
from_date date-time

Filtre os resultados para faturas datadas na data especificada ou após ela.

Até à data
to_date date-time

Filtre os resultados para faturas datadas na data especificada ou antes dela.

Nome do fornecedor
vendor_name string

Texto de pesquisa para corresponder ao nome do fornecedor.

Situação
invoice_status string

O status da fatura.

Estado da publicação
post_status string

O status de lançamento da fatura.

Método de pagamento
payment_method string

O método de pagamento da fatura.

Pesquisar texto
search_text string

Pesquise texto para corresponder ao nome do fornecedor, número da fatura, descrição ou número da ordem de compra.

Limite
limit integer

Representa o número de registros a serem retornados. O padrão é 100. O máximo é 500.

Compensação
offset integer

Representa o número de registros a serem ignorados. Para utilização com paginação.

Adicionado em ou após
date_added date-time

Filtre os resultados para faturas adicionadas na data especificada ou após ela.

Adicionado(a) por
added_by string

Filtre os resultados para faturas adicionadas pelo usuário especificado.

Modificado em ou após
last_modified date-time

Filtre os resultados para faturas modificadas na data especificada ou após ela.

Modificado por
last_modified_by string

Filtre os resultados para faturas modificadas pela última vez pelo usuário especificado.

Devoluções

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Listar fornecedores

Lista os fornecedores disponíveis.

Parâmetros

Name Chave Necessário Tipo Description
Situação
status string

O status do fornecedor.

Nome do fornecedor
vendor_name string

Texto de pesquisa para corresponder ao nome do fornecedor.

ID do fornecedor
ui_vendor_id string

O identificador visível pelo usuário para o fornecedor.

Número de cliente
customer_number string

O número de cliente do fornecedor.

Limite
limit integer

Representa o número de registros a serem retornados. O padrão é 100. O máximo é 500.

Compensação
offset integer

Representa o número de registros a serem ignorados. Para utilização com paginação.

Adicionado em ou após
date_added date-time

Filtre os resultados para fornecedores adicionados na data especificada ou após ela.

Adicionado(a) por
added_by string

Filtre os resultados para fornecedores adicionados pelo usuário especificado.

Modificado em ou após
last_modified date-time

Filtre os resultados para fornecedores modificados na data especificada ou após ela.

Modificado por
last_modified_by string

Filtre os resultados para fornecedores modificados pela última vez pelo usuário especificado.

Devoluções

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Listar itens de linha da ordem de compra

Lista os itens de linha de uma ordem de compra.

Parâmetros

Name Chave Necessário Tipo Description
ID da ordem de compra
purchase_order_id True integer

O ID de registro do sistema da ordem de compra.

Limite
limit integer

Representa o número de registros a serem retornados. O padrão é 100. O máximo é 500.

Compensação
offset integer

Representa o número de registros a serem ignorados. Para utilização com paginação.

Devoluções

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Listar métodos de contato de endereço do fornecedor

Lista os métodos de contato para um endereço de fornecedor.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
vendor_id True integer

O ID de registro do sistema do fornecedor.

ID do endereço
address_id True integer

O ID de registro do sistema do endereço do fornecedor.

Devoluções

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Listar notas e ações do fornecedor

Lista as anotações e ações de um fornecedor.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
vendor_id True integer

O ID de registro do sistema do fornecedor.

Devoluções

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Listar números de caixa da fatura 1099

Lista os números de caixa 1099 de uma fatura.

Parâmetros

Name Chave Necessário Tipo Description
ID da fatura
invoice_id True integer

O ID de registro do sistema da fatura.

Devoluções

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Listar ordens de compra

Lista as ordens de compra disponíveis.

Parâmetros

Name Chave Necessário Tipo Description
A partir da data
from_date date-time

Filtre os resultados para ordens de compra datadas na data especificada ou após ela.

Até à data
to_date date-time

Filtre os resultados para ordens de compra datadas na data especificada ou antes dela.

Tipo
type string

O tipo de ordem de compra.

Pesquisar texto
search_text string

Pesquise texto para corresponder ao nome do fornecedor ou ao número da ordem de compra.

Limite
limit integer

Representa o número de registros a serem retornados. O padrão é 100. O máximo é 500.

Compensação
offset integer

Representa o número de registros a serem ignorados. Para utilização com paginação.

Devoluções

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Listar recibos

Lista os recibos disponíveis.

Parâmetros

Name Chave Necessário Tipo Description
ID da ordem de compra
purchase_order_id integer

Filtre os resultados para recibos associados à ordem de compra especificada.

Recebido por
received_by string

Filtre os resultados para recibos recebidos pelo usuário especificado.

A partir da data
from_date date-time

Filtre os resultados para recibos datados na data especificada ou após ela.

Até à data
to_date date-time

Filtre os resultados para recibos datados na data especificada ou antes dela.

Nome do fornecedor
vendor_name string

Texto de pesquisa para corresponder ao nome do fornecedor.

Pesquisar texto
search_text string

Pesquise o texto correspondente à descrição do recibo, número do recibo, data do recibo, número da ordem de compra ou número da fatura.

Limite
limit integer

Representa o número de registros a serem retornados. O padrão é 100. O máximo é 500.

Compensação
offset integer

Representa o número de registros a serem ignorados. Para utilização com paginação.

Devoluções

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Obter informações da fatura 1099

Devolve as informações 1099 de uma fatura.

Parâmetros

Name Chave Necessário Tipo Description
ID da fatura
invoice_id True integer

O ID de registro do sistema da fatura.

Devoluções

Formulário 1099

Obter informações do fornecedor 1099

Obtenha as informações 1099 para um fornecedor.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
vendor_id True integer

O ID de registro do sistema do fornecedor.

Devoluções

Informação do 1099

Obter um ajuste de fatura

Retorna informações sobre um ajuste de fatura.

Parâmetros

Name Chave Necessário Tipo Description
ID da fatura
invoice_id True integer

O ID de registro do sistema da fatura.

ID de ajuste
adjustment_id True integer

O ID de registro do sistema do ajuste da fatura.

Devoluções

Ajuste de fatura

Obter um fornecedor

Retorna informações sobre um fornecedor.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
vendor_id True integer

O ID de registro do sistema do fornecedor.

Devoluções

Fornecedor

Obter um item de linha de ordem de compra

Retorna informações sobre um item de linha de ordem de compra.

Parâmetros

Name Chave Necessário Tipo Description
ID da ordem de compra
purchase_order_id True integer

O ID de registro do sistema da ordem de compra.

ID do item de linha
line_item_id True integer

A ID de registro do sistema do item de linha.

Devoluções

Item

Obter um recibo

Retorna informações sobre um recibo.

Parâmetros

Name Chave Necessário Tipo Description
ID do recibo
receipt_id True integer

O ID de registro do sistema do recibo.

Devoluções

Receipt

Obter uma fatura

Retorna informações sobre uma fatura.

Parâmetros

Name Chave Necessário Tipo Description
ID da fatura
invoice_id True integer

O ID de registro do sistema da fatura.

Devoluções

Invoice

Obter uma ordem de compra

Retorna informações sobre uma ordem de compra.

Parâmetros

Name Chave Necessário Tipo Description
ID do fornecedor
purchase_order_id True integer

O ID de registro do sistema da ordem de compra.

Devoluções

Ordem de compra

Definições

APApi.AddressContactMethod

Método de contato de endereço

Name Caminho Tipo Description
ID
contact_method_id integer

O ID de registro do sistema do método de contato de endereço.

tipo
contact_type string

O tipo de método de contato.

Informação
contact_info string

As informações do método de contato.

APApi.AttachmentSummary

Attachment

Name Caminho Tipo Description
ID
id integer

O ID de registro do sistema do anexo.

Tipo
type string

O tipo de anexo.

Nome
name string

O nome do anexo.

URL
url string

O URL do anexo. Aplicável apenas para anexos de links.

Tipo de anexo
media_type string

Categoria deste anexo definida pelo utilizador.

date_attached
date_attached date-time

A data em que o anexo foi adicionado.

APApi.AttachmentSummaryCollection

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação.

valor
value array of APApi.AttachmentSummary

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

APApi.CreatedInvoice

Fatura criada

Name Caminho Tipo Description
ID
record_id integer

A ID da fatura recém-criada.

APApi.CreatedInvoiceAttachment

Anexo de fatura criado

Name Caminho Tipo Description
ID
record_id integer

A ID do anexo recém-criado.

APApi.CreatedPurchaseOrder

Ordem de compra criada

Name Caminho Tipo Description
ID
record_id integer

A ID da ordem de compra recém-criada.

APApi.CreatedVendor

Fornecedor criado

Name Caminho Tipo Description
ID
record_id integer

A ID do fornecedor recém-criado.

APApi.CreatedVendorAction

Ação do fornecedor criada

Name Caminho Tipo Description
ID
record_id integer

A ID da ação de fornecedor recém-criada.

APApi.CreatedVendorAddress

Endereço do fornecedor criado

Name Caminho Tipo Description
ID
record_id integer

A ID do endereço do fornecedor recém-criado.

APApi.CreatedVendorAddressContactMethod

Método de contato de endereço do fornecedor criado

Name Caminho Tipo Description
ID
record_id integer

A ID do método de contato de endereço do fornecedor recém-criado.

APApi.CreatedVendorAttachment

Anexo de fornecedor criado

Name Caminho Tipo Description
ID
record_id integer

A ID do anexo recém-criado.

APApi.CreatedVendorNote

Nota do fornecedor criada

Name Caminho Tipo Description
ID
record_id integer

A ID da nota de fornecedor recém-criada.

APApi.CustomField

Um objeto que contém os detalhes do campo personalizado.

Name Caminho Tipo Description
nome
field_name string

O nome do campo personalizado.

tipo
type string

O tipo de dados que o campo personalizado representa.

valor
value string

O valor do campo personalizado.

é obrigatório?
is_required boolean

O campo personalizado é obrigatório?

date
date date-time

A data no campo personalizado.

comentário
comments string

O comentário no campo personalizado.

APApi.DefaultDistribution

Distribuição

Name Caminho Tipo Description
ID
distribution_id integer

O identificador de distribuição.

Tipo
type_code string

O tipo de transação de entrada de diário para a distribuição.

Número de conta
account_number string

O número da conta para a distribuição.

Percentagem
percent decimal

A porcentagem do valor de entrada do diário de distribuição.

Split
default_distribution_splits array of APApi.DefaultDistributionSplit

A lista de divisões para a distribuição padrão.

Campo personalizado
custom_fields array of APApi.CustomField

A lista de campos personalizados para a distribuição.

APApi.DefaultDistributionCollection

Distribuições

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação.

valor
value array of APApi.DefaultDistribution

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

APApi.DefaultDistributionSplit

Split

Name Caminho Tipo Description
ID
distribution_split_id integer

O identificador de divisão de distribuição.

percent
percent decimal

A porcentagem do valor de entrada do diário de distribuição.

projecto
ui_project_id string

O identificador visível pelo usuário do projeto para a divisão de distribuição.

Class
account_class string

A classe de conta para a divisão de distribuição.

transaction_code_values
transaction_code_values array of APApi.TransactionCodeValue

Os valores do código de transação de distribuição.

APApi.Distribuição

Um objeto que contém os detalhes da distribuição.

Name Caminho Tipo Description
ID
distribution_id integer

O identificador de distribuição.

tipo
type_code string

O tipo de transação de entrada de diário para a distribuição.

número de conta
account_number string

O número da conta para a distribuição.

Montante
amount decimal

O valor da entrada do diário de distribuição.

descrição
description string

A descrição para a distribuição.

dividir
distribution_splits array of APApi.DistributionSplit

A lista de divisões para a distribuição.

campo personalizado
custom_fields array of APApi.CustomField

A lista de campos personalizados para a distribuição.

APApi.DistributionSplit

dividir

Name Caminho Tipo Description
ID
distribution_split_id integer

O identificador de divisão de distribuição.

Montante
amount decimal

O valor da entrada do diário de distribuição.

projecto
ui_project_id string

O identificador visível pelo usuário do projeto para a divisão de distribuição.

classe
account_class string

A classe de conta para a divisão de distribuição.

transaction_code_values
transaction_code_values array of APApi.TransactionCodeValue

Os valores do código de transação de distribuição.

APApi.Form1099

Formulário 1099

Name Caminho Tipo Description
Montante
amount decimal

O montante distribuído para 1099.

Montante excluído
excluded_amount decimal

O montante excluído de 1099.

APApi.InvoiceAdjustmentDetail

Ajuste de fatura

Name Caminho Tipo Description
ID
adjustment_id integer

O identificador de ajuste de fatura.

Date
adjustment_date date-time

A data do ajuste da fatura.

Estado da publicação
post_status string

O status de lançamento para o ajuste da fatura.

Data de publicação
post_date date-time

A data de publicação para o ajuste da fatura.

Reason
reason string

O motivo do ajuste da fatura.

Observações
notes string

As notas para o ajuste da fatura.

count
adjustment_distributions.count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação.

valor
adjustment_distributions.value array of APApi.Distribution

A lista de distribuições para o ajuste da fatura.

APApi.InvoiceAdjustmentSummary

Ajuste de fatura

Name Caminho Tipo Description
ID
adjustment_id integer

O identificador de ajuste de fatura.

Date
adjustment_date date-time

A data do ajuste da fatura.

Estado da publicação
post_status string

O status de lançamento para o ajuste da fatura.

Data de publicação
post_date date-time

A data de publicação para o ajuste da fatura.

Reason
reason string

O motivo do ajuste da fatura.

Observações
notes string

As notas para o ajuste da fatura.

APApi.InvoiceAdjustmentSummaryCollection

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação.

valor
value array of APApi.InvoiceAdjustmentSummary

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

APApi.InvoiceDetail

Invoice

Name Caminho Tipo Description
ID
invoice_id integer

O ID de registro do sistema da fatura.

ID do fornecedor
vendor_id integer

O ID de registro do sistema do fornecedor.

Nome
vendor_name string

O nome do fornecedor.

Número da fatura
invoice_number string

O número da fatura.

Data da fatura
invoice_date date-time

A data da fatura.

Data de vencimento
due_date date

A data de vencimento da fatura (ex: '2005-09-18').

Estado da publicação
post_status string

O status de lançamento da fatura.

Data de publicação
post_date date

A data de publicação da fatura (ex: '2005-09-18').

Montante
amount decimal

O valor da fatura.

Total pago
total_paid decimal

O valor total pago na fatura.

Equilíbrio
balance decimal

O saldo atual na fatura.

Valor da fatura antes de impostos
invoice_amount_before_tax decimal

O valor da fatura antes de impostos (aplicável apenas para as versões CA e AU).

Incluir imposto?
include_tax boolean

Incluir imposto nesta fatura (aplicável apenas para versões CA e AU)?

Valor do imposto
tax_amount decimal

O valor do imposto para a fatura (aplicável apenas para as versões CA e AU).

Distribuição de impostos
tax_distribution array of APApi.RebateDistribution

A distribuição de impostos para a fatura (aplicável apenas para versões AU).

ID do tipo de imposto GST
gst_tax_type_id integer

O identificador de tipo de imposto GST para a fatura (aplicável apenas para as versões CA e AU).

Valor do desconto do ICMS
gst_rebate_amount decimal

O valor do desconto do GST para a fatura (aplicável apenas para versões CA).

Distribuição de descontos de GST
gst_rebate_distribution array of APApi.RebateDistribution

A distribuição de descontos de GST para a fatura (aplicável apenas para versões CA).

ID do código de atividade PSB
psb_activity_code_id integer

O identificador do código de atividade PSB para a fatura (aplicável apenas para versões CA).

Montante do desconto PST
pst_rebate_amount decimal

O valor do desconto PST para a fatura (aplicável apenas para versões CA).

Distribuição de descontos PST
pst_rebate_distribution array of APApi.RebateDistribution

A distribuição de descontos PST para a fatura (aplicável apenas para versões CA).

Description
description string

A descrição da fatura.

Estado de aprovação
status string

O status de aprovação da fatura.

Distribuir descontos?
distribute_discounts boolean

Distribuir descontos para faturar contas de despesas?

Número da ordem de compra
purchase_order_number string

O número da ordem de compra associado à fatura.

Método de pagamento
invoice_payment_detail.payment_method string

O método de pagamento da fatura.

ID do endereço
invoice_payment_detail.remit_to.address_id integer

O ID de registo do sistema do remetente a endereçar para a fatura.

descrição
invoice_payment_detail.remit_to.description string

A descrição do endereço.

country
invoice_payment_detail.remit_to.country string

O país do endereço.

linhas de endereço
invoice_payment_detail.remit_to.address_line string

As linhas de rua/endereço para o endereço.

city
invoice_payment_detail.remit_to.city string

A cidade do endereço.

state
invoice_payment_detail.remit_to.state string

O estado ou província (ou subúrbio na Nova Zelândia) para o endereço.

código postal
invoice_payment_detail.remit_to.postal string

O código postal ou CEP do endereço.

concelho
invoice_payment_detail.remit_to.county string

O município do endereço.

Nome do contato
invoice_payment_detail.remit_to.contact_name string

O nome completo do contato para o endereço.

Pago a partir de
invoice_payment_detail.paid_from string

O banco do qual a fatura é paga.

ID da conta do cartão
invoice_payment_detail.credit_card_account_id integer

O ID de registo do sistema da conta de cartão de crédito a partir da qual a fatura é paga.

Nome da conta do cartão
invoice_payment_detail.credit_card_account_name string

O nome da conta de cartão de crédito a partir da qual a fatura é paga.

Identificação do cartão
invoice_payment_detail.credit_card_id integer

O ID de registro do sistema do cartão de crédito a partir do qual a fatura é paga.

Nome do cartão
invoice_payment_detail.credit_card_name string

O nome do cartão de crédito a partir do qual a fatura foi paga.

Atrasar o pagamento?
invoice_payment_detail.hold_payment boolean

Atrasar o pagamento nesta fatura?

Pagamento separado?
invoice_payment_detail.create_separate_payment boolean

Criar sempre um pagamento separado para esta fatura?

Pagamento
invoice_payment_detail.payments array of APApi.InvoicePaymentSummary

A lista de pagamentos na fatura.

Distribuição
distributions array of APApi.Distribution

A lista de distribuições para a fatura.

Campo personalizado
custom_fields array of APApi.CustomField

A lista de campos personalizados para a fatura.

Data de adição
date_added date-time

A data em que a fatura foi criada.

Adicionado(a) por
added_by string

O nome do usuário que criou a fatura.

Data de modificação
date_modified date-time

A data em que a fatura foi modificada pela última vez.

Modificado por
modified_by string

O nome do usuário que modificou a fatura pela última vez.

APApi.InvoicePaymentSummary

Um objeto que contém informações resumidas sobre um pagamento para a fatura.

Name Caminho Tipo Description
ID da transação
br_transaction_id integer

O ID da transação para o pagamento.

número da transação
transaction_number string

O número da transação para este pagamento.

date
payment_date date-time

A data para este pagamento (ex: '2005-09-18').

estado
payment_status string

O status do pagamento.

Montante
amount decimal

O valor do pagamento.

verifica o identificador
checks_7_id integer

O identificador de verificações do Financial Edge 7.

APApi.InvoiceSummary

Invoice

Name Caminho Tipo Description
ID
invoice_id integer

O ID de registro do sistema da fatura.

ID do fornecedor
vendor_id integer

O ID de registro do sistema do fornecedor.

Nome
vendor_name string

O nome do fornecedor.

Status do fornecedor
vendor_status string

O status do fornecedor.

Número da fatura
invoice_number string

O número da fatura.

Data da fatura
invoice_date date-time

A data da fatura.

Description
description string

A descrição da fatura.

Montante
amount decimal

O valor da fatura.

Montante devido
amount_due decimal

O valor ainda devido na fatura.

Equilíbrio
balance decimal

O saldo atual na fatura.

Situação
status string

O status da fatura.

Estado da publicação
post_status string

O status de lançamento da fatura.

Método de pagamento
payment_method string

O método de pagamento da fatura.

Idade
age string

A idade da fatura.

Está vencido?
is_past_due boolean

A fatura está vencida?

Número da ordem de compra
purchase_order_number string

O número da ordem de compra associado à fatura.

Tipo de imposto GST
gst_tax_type string

O tipo de imposto para a fatura (aplicável apenas para as versões CA e AU).

Data de adição
date_added date-time

A data em que a fatura foi criada.

Adicionado(a) por
added_by string

O nome do usuário que criou a fatura.

Data de modificação
date_modified date-time

A data em que a fatura foi modificada pela última vez.

Modificado por
modified_by string

O nome do usuário que modificou a fatura pela última vez.

APApi.InvoiceSummaryCollection

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação.

valor
value array of APApi.InvoiceSummary

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

APApi.Invoice1099BoxNumber

Número da casa

Name Caminho Tipo Description
Número da casa
number string

O número da caixa.

Estado
state string

O estado do número da caixa.

Percentagem
percent decimal

A percentagem do número da caixa.

Montante
amount decimal

O valor do número da caixa.

APApi.Invoice1099BoxNumberCollection

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação.

results
results array of APApi.Invoice1099BoxNumber

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

APApi.LineItemDetail

Item

Name Caminho Tipo Description
ID do fornecedor
vendor_id integer

O identificador de fornecedor para o item de linha da ordem de compra.

Nome do fornecedor
vendor_name string

O nome do fornecedor para o item de linha da ordem de compra.

Número da encomenda
order_number integer

O número da ordem de compra.

ID
line_item_id integer

O identificador de item de linha.

Número da linha
line_number integer

O número do item de linha.

Tipo
type string

O tipo de item de linha.

ID do produto
product_id integer

O identificador de produto do item de linha.

Código do produto
product_code string

O código do produto do item de linha.

Número de peça do fornecedor
vendor_part_number string

O número de peça do fornecedor do item de linha.

Description
description string

A descrição do item de linha.

Unidade de medida
unit_of_measure string

A unidade de medida do item de linha.

Quantidade encomendada
quantity_ordered decimal

A quantidade encomendada do item de linha.

Quantidade recebida
quantity_received decimal

A quantidade recebida do item de linha.

Quantidade rejeitada
quantity_rejected decimal

A quantidade rejeitada do item de linha.

Quantidade anulada
quantity_cancelled decimal

A quantidade cancelada do item de linha.

Custo unitário
unit_cost decimal

A unidade de custo do item de linha.

Custo alargado
extended_cost decimal

O custo estendido do item de linha.

Estado da publicação
post_status string

O status de postagem do item de linha.

Data de publicação
post_date date-time

A data de postagem do item de linha.

Comments
comments string

Os comentários do item de linha.

Situação
status string

O status de recebimento do item de linha.

Departamento
department string

O departamento do item de linha.

Entregue em
deliver_to string

O membro da equipe para entregar para o item de linha.

Distribuição
distributions array of APApi.Distribution

A lista de distribuições para o item de linha.

Data de adição
date_added date-time

A data em que o item de linha foi adicionado.

Adicionado(a) por
added_by string

O nome do usuário que adicionou o item de linha.

Data de modificação
date_modified date-time

A data em que o item de linha foi modificado pela última vez.

Modificado por
modified_by string

O nome do usuário que modificou o item de linha pela última vez.

APApi.LineItemSummary

Item

Name Caminho Tipo Description
ID
line_item_id integer

O identificador de item de linha.

Número da linha
line_number integer

O número do item de linha.

Tipo
type string

O tipo de item de linha.

ID do produto
product_id integer

O identificador de produto do item de linha.

Código do produto
product_code string

O código do produto do item de linha.

Número de peça do fornecedor
vendor_part_number string

O número de peça do fornecedor do item de linha.

Description
description string

A descrição do item de linha.

Unidade de medida
unit_of_measure string

A unidade de medida do item de linha.

Quantidade encomendada
quantity_ordered decimal

A quantidade encomendada do item de linha.

Quantidade recebida
quantity_received decimal

A quantidade recebida do item de linha.

Quantidade rejeitada
quantity_rejected decimal

A quantidade rejeitada do item de linha.

Quantidade anulada
quantity_cancelled decimal

A quantidade cancelada do item de linha.

Custo unitário
unit_cost decimal

A unidade de custo do item de linha.

Custo alargado
extended_cost decimal

O custo estendido do item de linha.

Estado da publicação
post_status string

O status de postagem do item de linha.

Data de publicação
post_date date-time

A data de postagem do item de linha.

Comments
comments string

Os comentários do item de linha.

Situação
status string

O status de recebimento do item de linha.

Departamento
department string

O departamento do item de linha.

Entregue em
deliver_to string

O membro da equipe para entregar para o item de linha.

Data de adição
date_added date-time

A data em que o item de linha foi adicionado.

Adicionado(a) por
added_by string

O nome do usuário que adicionou o item de linha.

Data de modificação
date_modified date-time

A data em que o item de linha foi modificado pela última vez.

Modificado por
modified_by string

O nome do usuário que modificou o item de linha pela última vez.

APApi.LineItemSummaryCollection

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação.

valor
value array of APApi.LineItemSummary

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

APApi.PurchaseOrderDetail

Ordem de compra

Name Caminho Tipo Description
ID
purchase_order_id integer

O ID de registro do sistema da ordem de compra.

ID do fornecedor
vendor_id integer

O ID de registro do sistema do fornecedor.

Nome
vendor_name string

O nome do fornecedor.

Tipo
type string

O tipo de ordem de compra.

Número da encomenda
order_number integer

O número da ordem de compra.

Data da encomenda
order_date date-time

A data da ordem de compra.

Situação
order_status string

O status da ordem de compra.

Encomendar a partir do ID de contacto
ordered_from_contact_id integer

O identificador de contato do ordenante da ordem de compra.

Envio via
ship_via string

O método de envio da ordem de compra.

FOB
fob string

O frete a bordo da ordem de compra.

Terms
terms string

Os termos da ordem de compra.

Comprador
buyer string

O comprador da ordem de compra.

Departamento
department string

O departamento da ordem de compra.

Confirmar para
ordered_by string

O ordenante da ordem de compra.

Enviar para
ship_to_address string

O endereço de envio da ordem de compra.

Atenção
attention string

O membro da equipe para atenção da ordem de compra.

Comments
comments string

Os comentários da ordem de compra.

Total
order_total decimal

O total da ordem de compra.

Total recebido
receipted_total decimal

O total recebido da ordem de compra.

Data de adição
date_added date-time

A data em que a ordem de compra foi criada.

Campo personalizado
custom_fields array of APApi.CustomField

A lista de campos personalizados para a ordem de compra.

Adicionado(a) por
added_by string

O nome do usuário que criou a ordem de compra.

Data de modificação
date_modified date-time

A data em que a ordem de compra foi modificada pela última vez.

Modificado por
modified_by string

O nome do usuário que modificou a ordem de compra pela última vez.

APApi.PurchaseOrderSummary

Ordem de compra

Name Caminho Tipo Description
ID
purchase_order_id integer

O ID de registro do sistema da ordem de compra.

ID do fornecedor
vendor_id integer

O ID de registro do sistema do fornecedor.

Nome
vendor_name string

O nome do fornecedor.

Tipo
type string

O tipo de ordem de compra.

Número da encomenda
order_number integer

O número da ordem de compra.

Data da encomenda
order_date date-time

A data da ordem de compra.

Situação
order_status string

O status da ordem de compra.

Total
order_total decimal

O total da ordem de compra.

Total recebido
receipted_total decimal

O total recebido da ordem de compra.

Terms
terms string

Os termos da ordem de compra.

Data de adição
date_added date-time

A data em que a ordem de compra foi criada.

Adicionado(a) por
added_by string

O nome do usuário que criou a ordem de compra.

Data de modificação
date_modified date-time

A data em que a ordem de compra foi modificada pela última vez.

Modificado por
modified_by string

O nome do usuário que modificou a ordem de compra pela última vez.

APApi.PurchaseOrderSummaryCollection

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação.

valor
value array of APApi.PurchaseOrderSummary

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

APApi.RebateDistribution

Um objeto que contém os detalhes da distribuição.

Name Caminho Tipo Description
ID
distribution_id integer

O identificador de distribuição.

ID da entidade fiscal
tax_entity_id string

O identificador da entidade fiscal.

tipo
type_code string

O tipo de transação de entrada de diário para a distribuição.

número de conta
account_number string

O número da conta para a distribuição.

Montante
amount decimal

O valor da entrada do diário de distribuição.

descrição
description string

A descrição para a distribuição.

dividir
distribution_splits array of APApi.DistributionSplit

A lista de divisões para a distribuição.

campo personalizado
custom_fields array of APApi.CustomField

A lista de campos personalizados para a distribuição.

APApi.ReceiptDetail

Receipt

Name Caminho Tipo Description
ID
receipt_id integer

O ID de registro do sistema do recibo.

Número do recibo
receipt_number integer

O número do recibo.

Recebido por
received_by string

O destinatário do recibo.

Data do recibo
receipt_date date-time

A data do recebimento.

Description
description string

A descrição do recibo.

Total de recibos
receipt_total decimal

O valor total do recibo.

ID do fornecedor
vendor_id integer

O ID de registro do sistema do fornecedor.

Nome
vendor_name string

O nome do fornecedor.

ID da ordem de compra
purchase_order_id integer

O ID de registro do sistema da ordem de compra associada ao recibo.

Número da ordem de compra
purchase_order_number string

O número da ordem de compra associado ao recibo.

ID da fatura
invoice_id integer

O ID de registro do sistema da fatura associada ao recibo.

Número da fatura
invoice_number string

O número da fatura associado ao recibo.

Data de adição
date_added date-time

A data em que o recibo foi criado.

Adicionado(a) por
added_by string

O nome do usuário que criou o recibo.

Data de modificação
date_modified date-time

A data em que o recibo foi modificado pela última vez.

Modificado por
modified_by string

O nome do usuário que modificou o recibo pela última vez.

APApi.ReceiptSummary

Receipt

Name Caminho Tipo Description
ID
receipt_id integer

O ID de registro do sistema do recibo.

Número do recibo
receipt_number integer

O número do recibo.

Recebido por
received_by string

O destinatário do recibo.

Data do recibo
receipt_date date-time

A data do recebimento.

Description
description string

A descrição do recibo.

Total de recibos
receipt_total decimal

O valor total do recibo.

ID do fornecedor
vendor_id integer

O ID de registro do sistema do fornecedor.

Nome
vendor_name string

O nome do fornecedor.

ID da ordem de compra
purchase_order_id integer

O ID de registro do sistema da ordem de compra associada ao recibo.

Número da ordem de compra
purchase_order_number string

O número da ordem de compra associado ao recibo.

ID da fatura
invoice_id integer

O ID de registro do sistema da fatura associada ao recibo.

Número da fatura
invoice_number string

O número da fatura associado ao recibo.

Data de adição
date_added date-time

A data em que o recibo foi criado.

Adicionado(a) por
added_by string

O nome do usuário que criou o recibo.

Data de modificação
date_modified date-time

A data em que o recibo foi modificado pela última vez.

Modificado por
modified_by string

O nome do usuário que modificou o recibo pela última vez.

APApi.ReceiptSummaryCollection

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação.

valor
value array of APApi.ReceiptSummary

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

APApi.TransactionCodeValue

Valor do código de transação

Name Caminho Tipo Description
ID
id integer

O ID do valor do código de transação.

Valor
name string

O nome do código da transação.

Valor
value string

O valor do código de transação.

Inativo?
inactive boolean

O valor do código de transação está inativo?

APApi.Vendor1099Informação

Informação do 1099

Name Caminho Tipo Description
default_box_numbers
default_box_numbers array of APApi.VendorDefaultBoxNumber

Os números de caixa padrão para o fornecedor.

APApi.VendorAddress

Endereço do fornecedor

Name Caminho Tipo Description
ID
address_id integer

O identificador de endereço.

Description
description string

A descrição do endereço.

Country
country string

O país do endereço.

Linhas de endereço
address_line string

As linhas de rua/endereço para o endereço.

City
city string

A cidade do endereço.

Estado
state string

O estado ou província (ou subúrbio na Nova Zelândia) para o endereço.

Código postal
postal string

O código postal ou CEP do endereço.

Condado
county string

O município do endereço.

É primário?
is_primary boolean

Este é o endereço principal do fornecedor?

Enviar faturas?
is_invoices boolean

Enviar faturas para este endereço?

Enviar OPs?
is_pos boolean

Enviar ordens de compra para este endereço?

Enviar 1099s?
is_1099 boolean

Enviar 1099s para este endereço?

Nome do beneficiário
payee_name string

O nome do beneficiário.

Título do contacto
title string

O título do contato principal.

Nome próprio do contacto
first_name string

O primeiro nome do contato principal.

Nome do meio de contato
middle_name string

A inicial do meio ou o nome do contato principal.

Sobrenome do contato
last_name string

O sobrenome do contato principal.

Sufixo de contato
suffix string

O sufixo do contato primário.

Posição de contacto
position string

A posição do contato principal.

Método de contacto
address_contact_methods array of APApi.AddressContactMethod

A lista de métodos de contato para o endereço.

APApi.VendorAddressCollection

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação.

results
results array of APApi.VendorAddress

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

APApi.VendorAddressContactMethod

Método de contato de endereço do fornecedor

Name Caminho Tipo Description
ID
contact_method_id integer

O identificador do método de contato de endereço.

Tipo de contacto
contact_type string

O tipo de contato.

Informações de contacto
contact_info string

As informações de contato.

APApi.VendorAddressContactMethodCollection

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação.

results
results array of APApi.VendorAddressContactMethod

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

APApi.VendorContact

Contato

Name Caminho Tipo Description
ID
vendor_contact_id integer

O ID de registro do sistema do contato.

Nome
contact_display_name string

O nome para exibição do contato.

Descrição do endereço
address_description string

A descrição do endereço do contato.

Address
address_line string

As linhas de endereço para o contato.

APApi.VendorContactCollection

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação.

valor
value array of APApi.VendorContact

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

APApi.VendorDefaultBoxNumber

Número da casa

Name Caminho Tipo Description
Número da casa
number string

O número da caixa.

Estado de relatório
state string

O estado de relatório para o número da caixa.

Percentagem
percent decimal

A percentagem para o número da caixa.

APApi.VendorDetail

Fornecedor

Name Caminho Tipo Description
ID
vendor_id integer

O ID de registro do sistema do fornecedor.

ID do fornecedor
ui_defined_id string

O identificador definido pelo usuário para o fornecedor.

Número de identificação fiscal
tax_id_number string

O número de identificação fiscal do fornecedor.

ID do código de atividade PSB
psb_activity_code_id integer

O ID do código de atividade PSB para o fornecedor (aplicável apenas para versões de CA).

Código de atividade PSB
psb_activity_code string

O código de atividade PSB para o fornecedor (aplicável apenas para versões de autoridade de certificação).

Descrição do código de atividade PSB
psb_activity_code_desc string

A descrição do código de atividade PSB para o fornecedor (aplicável apenas para versões de CA).

Tipo de imposto GST
gst_tax_type string

O tipo de imposto GST para o fornecedor (aplicável apenas para as versões CA e AU).

Descrição do tipo de imposto GST
gst_tax_type_desc string

A descrição do tipo de imposto GST para o fornecedor (aplicável apenas para as versões CA e AU).

Sucursal do ICMS
gst_branch string

A ramificação para o fornecedor (aplicável apenas para versões AU).

Nome
vendor_name string

O nome do fornecedor.

Tipo
vendor_type string

O tipo de fornecedor.

Número de cliente
customer_number string

O número de cliente do fornecedor.

Situação
vendor_status string

O status do fornecedor.

Emitir 1099 declaração?
issue_1099s boolean

Emitir uma declaração 1099 para o fornecedor?

Saldo devedor
balance_due decimal

O saldo devido pelo fornecedor.

Address
addresses array of APApi.VendorAddress

A lista de endereços do fornecedor.

Campo personalizado
custom_fields array of APApi.CustomField

A lista de campos personalizados para o fornecedor.

Incumprimento do pagamento
vendor_payment_default APApi.VendorPaymentDefault

O pagamento do fornecedor é inadimplente.

Data de adição
date_added date-time

A data em que o fornecedor foi criado.

Adicionado(a) por
added_by string

O nome do usuário que criou o fornecedor.

Data de modificação
date_modified date-time

A data em que o fornecedor foi modificado pela última vez.

Modificado por
modified_by string

O nome do usuário que modificou o fornecedor pela última vez.

APApi.VendorNoteAction

Nota/ação

Name Caminho Tipo Description
ID
note_action_id integer

O ID de registro do sistema da nota ou ação.

Tipo de registo
note_type string

O tipo de registro (nota ou ação).

Tipo
type string

O tipo de nota ou ação.

Date
date date-time

A data da nota ou ação.

Description
description string

A nota ou descrição da ação.

Observação
content string

O conteúdo da nota.

Atribuído a
assign_to string

O usuário ao qual a ação é atribuída.

Está completo?
is_complete boolean

A ação está concluída?

Concluído a
completed_date date-time

Data de conclusão da ação.

APApi.VendorNoteActionCollection

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação.

results
results array of APApi.VendorNoteAction

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

APApi.VendorPaymentDefault

O pagamento do fornecedor é inadimplente.

Name Caminho Tipo Description
limite de crédito?
has_credit_limit boolean

A inadimplência tem limite de crédito?

Valor do limite de crédito
credit_limit decimal

O limite de crédito padrão de pagamento.

termos
payment_terms string

As condições de pagamento (NET).

Nome da conta
account_name string

A conta a partir da qual pagar faturas.

método
payment_method string

O método de pagamento.

option
payment_option string

A opção de pagamento.

APApi.VendorSummary

Fornecedor

Name Caminho Tipo Description
ID
vendor_id integer

O ID de registro do sistema do fornecedor.

ID do fornecedor
ui_defined_id string

O identificador definido pelo usuário para o fornecedor.

Nome
vendor_name string

O nome do fornecedor.

Número de cliente
customer_number string

O número de cliente do fornecedor.

Situação
vendor_status string

O status do fornecedor.

Emitir 1099 declaração?
issue_1099s boolean

Emitir uma declaração 1099 para o fornecedor?

Saldo devedor
balance_due decimal

O saldo devido pelo fornecedor.

Método de pagamento
payment_method string

O método de pagamento padrão para o fornecedor.

ID
primary_address.address_id integer

O ID de registro do sistema do endereço.

descrição
primary_address.description string

A descrição do endereço.

country
primary_address.country string

O país do endereço.

linhas
primary_address.address_line string

As linhas de rua/endereço para o endereço.

city
primary_address.city string

A cidade do endereço.

state
primary_address.state string

O estado ou província (ou subúrbio na Nova Zelândia) para o endereço.

código postal
primary_address.postal string

O código postal ou CEP do endereço.

concelho
primary_address.county string

O município do endereço.

é primário?
primary_address.is_primary boolean

Este é o endereço principal do fornecedor?

enviar faturas?
primary_address.is_invoices boolean

Enviar faturas para este endereço?

enviar OP?
primary_address.is_pos boolean

Enviar ordens de compra para este endereço?

enviar 1099s?
primary_address.is_1099 boolean

Enviar 1099s para este endereço?

Título do contato
primary_address.title string

O título do contato principal.

Nome próprio do contato
primary_address.first_name string

O primeiro nome do contato principal.

Nome do meio do contato
primary_address.middle_name string

A inicial do meio ou o nome do contato principal.

Sobrenome do contato
primary_address.last_name string

O sobrenome do contato principal.

sufixo de contato
primary_address.suffix string

O sufixo do contato primário.

Posição de contato
primary_address.position string

A posição do contato principal.

address_contact_methods
primary_address.address_contact_methods array of APApi.AddressContactMethod

A lista de métodos de contato para o endereço.

Incumprimento do pagamento
payment_defaults APApi.VendorPaymentDefault

O pagamento do fornecedor é inadimplente.

Data de adição
date_added date-time

A data em que o fornecedor foi criado.

Adicionado(a) por
added_by string

O nome do usuário que criou o fornecedor.

Data de modificação
date_modified date-time

A data em que o fornecedor foi modificado pela última vez.

Modificado por
modified_by string

O nome do usuário que modificou o fornecedor pela última vez.

APApi.VendorSummaryCollection

Buscar dados de uma só vez rapidamente se torna incontrolável. A entidade de coleta ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar os dados.

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação.

valor
value array of APApi.VendorSummary

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.