Blackbaud FENXT Payable (versão prévia)
O Blackbaud Financial Edge NXT é uma solução abrangente de software contábil baseada em nuvem criada especificamente para organizações sem fins lucrativos. Use o conector payables para gerenciar faturas, fornecedores, pedidos de compra e entidades relacionadas encontradas no NXT do Financial Edge.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte do Blackbaud |
| URL | https://www.blackbaud.com/support |
| skyapi@blackbaud.com |
| Metadados do conector | |
|---|---|
| Publicador | Blackbaud, Inc. |
| Site da 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 contábil baseada em nuvem criada especificamente para organizações sem fins lucrativos.
Esse conector é baseado na API SKY da Blackbaud e fornece operações para ajudar a gerenciar faturas, fornecedores, pedidos de compra e entidades relacionadas encontradas no NXT do Financial Edge.
Para obter mais informações, veja a documentação.
Pré-requisitos
Para usar esse conector, você deve ter uma conta de ID do Blackbaud com acesso a um ou mais ambientes Blackbaud.
Além disso, o administrador da sua organização também deve executar uma ação no nível do 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 instalação inicial .
Como obter credenciais?
O administrador da sua organização enviará um convite para o ambiente do Financial Edge NXT da organização e configurará suas permissões de conta de usuário dentro do ambiente. Não são necessárias credenciais adicionais para usar esse conector.
Problemas e limitações conhecidos
O conector funcionará no contexto da sua conta de usuário e, portanto, estará sujeito às permissões do usuário dentro do ambiente.
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar um endereço do 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 de pedido de compra |
Cria um novo item de linha de pedido de compra. |
| Criar um método de contato de endereço do fornecedor |
Cria um novo método de contato para um endereço de fornecedor. |
| Criar uma anotação de fornecedor |
Cria uma nova anotação de fornecedor. |
| Criar uma ação do 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 ordem de compra |
Cria uma nova ordem de compra. |
| Excluir um ajuste de fatura |
Exclui um ajuste de fatura. |
| Excluir um anexo do fornecedor |
Exclui um anexo do fornecedor. |
| Excluir um endereço do fornecedor |
Exclui um endereço do fornecedor. |
| Excluir um memorando de crédito |
Exclui um memorando de crédito. |
| Listar ajustes de fatura |
Lista os ajustes de uma fatura. |
| Listar anexos do fornecedor |
Lista os anexos de um fornecedor. |
| Listar anotações e ações do fornecedor |
Lista as anotações e as ações 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 do fornecedor |
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 de pedido de compra |
Lista os itens de linha para um pedido 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 números de caixa da fatura 1099 |
Lista os números da caixa 1099 para uma fatura. |
| Listar pedidos de compra |
Lista os pedidos de compra disponíveis. |
| Listar recibos |
Lista os recibos disponíveis. |
| Obter informações da fatura 1099 |
Retorna as informações de 1099 para uma fatura. |
| Obter informações do fornecedor 1099 |
Obtenha as informações de 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 pedido de compra |
Retorna informações sobre um item de linha de pedido de compra. |
| Obter um pedido de compra |
Retorna informações sobre um pedido de compra. |
| Obter um recibo |
Retorna informações sobre um recibo. |
| Obter uma fatura |
Retorna informações sobre uma fatura. |
Atualizar um endereço do fornecedor
Atualiza um endereço de fornecedor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
vendor_id | True | integer |
A ID do registro do sistema do fornecedor. |
|
ID do endereço
|
address_id | True | integer |
A ID do registro do sistema do endereço do fornecedor a ser atualizado. |
|
Description
|
description | string |
A descrição do endereço. |
|
|
País
|
country | string |
O país do endereço. |
|
|
Linhas de endereço
|
address_line | string |
As linhas de rua/endereço do 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 em NZ) para o endereço. |
|
|
CEP
|
postal | string |
O cep ou ZIP do endereço. Limite de caracteres: 12. |
|
|
Município
|
county | string |
O condado do endereço. |
|
|
É primário?
|
is_primary | boolean |
Esse é o endereço principal do fornecedor? |
|
|
Enviar faturas?
|
is_invoices | boolean |
Enviar faturas para esse endereço? |
|
|
Enviar POs?
|
is_pos | boolean |
Enviar ordens de compra para esse endereço? |
|
|
Enviar 1099s?
|
issue_1099s | boolean |
Enviar 1099s para esse endereço? |
|
|
Título do contato
|
title | string |
O título do contato primário. |
|
|
Nome do contato
|
first_name | string |
O primeiro nome do contato primário. |
|
|
Nome do meio de contato
|
middle_name | string |
A inicialização intermediária ou o nome do contato primário. |
|
|
Sobrenome do contato
|
last_name | string |
O sobrenome do contato primário. |
|
|
Sufixo de contato
|
suffix | string |
O sufixo do contato primário. |
|
|
Posição de contato
|
position | string |
A posição do contato primário. |
Retornos
Endereço do fornecedor criado
Atualizar um fornecedor
Atualiza um fornecedor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
vendor_id | True | integer |
A ID do 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 do cliente
|
customer_number | string |
O número do cliente do fornecedor. |
|
|
Situação
|
vendor_status | string |
O status do fornecedor. |
|
|
Emissão da instrução 1099?
|
issue_1099s | boolean |
Emitir uma instrução 1099 para o fornecedor? |
|
|
Limite de crédito?
|
has_credit_limit | boolean |
O padrão de pagamento tem um 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 |
Os termos do pagamento (NET). |
|
|
Conta de pagamento
|
account_name | string |
A conta da qual pagar faturas. |
|
|
Método de pagamento
|
payment_method | string |
A forma de pagamento. |
|
|
Opção de pagamento
|
payment_option | string |
A opção de pagamento. |
Retornos
Fornecedor criado
- Corpo
- APApi.CreatedVendor
Atualizar uma fatura
Atualiza uma fatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da fatura
|
invoice_id | True | integer |
A ID do 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 (por exemplo: '2005-09-18'). |
|
|
Data de conclusão
|
due_date | date |
A data de conclusão da fatura (por exemplo: '2005-09-18'). |
|
|
Status da postagem
|
post_status | string |
O status da postagem da fatura. |
|
|
Data da postagem
|
post_date | date |
A data de postagem da fatura (por exemplo: '2005-09-18'). |
|
|
Quantidade
|
amount | decimal |
O valor da fatura. |
|
|
Description
|
description | string |
A descrição da fatura. |
|
|
Status de aprovação
|
status | string |
O status de aprovação da fatura. |
|
|
Distribuir descontos?
|
distribute_discounts | boolean |
Distribuir descontos para contas de despesas de fatura? |
|
|
Método de pagamento
|
payment_method | string |
A forma de pagamento da fatura. |
|
|
Remitir para
|
address_id | integer |
O endereço a ser endereçado para a fatura. |
|
|
Pago de
|
paid_from | string |
O banco do qual a fatura é paga. |
|
|
ID da conta de cartão
|
credit_card_account_id | integer |
A ID do registro do sistema da conta de cartão de crédito da qual a fatura é paga. |
|
|
ID do cartão
|
credit_card_id | integer |
A ID do registro do sistema do cartão de crédito do qual a fatura é paga. |
|
|
Manter o pagamento?
|
hold_payment | boolean |
Manter o pagamento nesta fatura? |
|
|
Pagamento separado?
|
create_separate_payment | boolean |
Sempre criar um pagamento separado para essa fatura? |
Retornos
Fatura criada
- Corpo
- APApi.CreatedInvoice
Criar um anexo de fatura
Cria um novo anexo de fatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da fatura
|
parent_id | True | integer |
A ID do 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 definida pelo usuário deste anexo. Os valores disponíveis são as entradas na tabela Tipo de Mídia para o registro pai. Usar os tipos de valor definidos em /mediaTypes |
|
URL
|
url | string |
A URL do anexo. Isso é necessário para anexos de link e ignorado para anexos físicos. |
|
|
Conteúdo do arquivo
|
file | binary |
O conteúdo binário do anexo de arquivo. Isso é necessário para anexos físicos e ignorado para anexos de link. |
|
|
Nome do arquivo
|
file_name | string |
O nome do arquivo para o anexo. Isso é necessário para anexos físicos e ignorado para anexos de link. |
Retornos
Anexo de fatura criado
Criar um anexo de fornecedor
Cria um novo anexo de fornecedor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
parent_id | True | integer |
A ID do 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 definida pelo usuário deste anexo. Os valores disponíveis são as entradas na tabela Tipo de Mídia para o registro pai. Usar os tipos de valor definidos em /mediaTypes |
|
URL
|
url | string |
A URL do anexo. Isso é necessário para anexos de link e ignorado para anexos físicos. |
|
|
Conteúdo do arquivo
|
file | binary |
O conteúdo binário do anexo de arquivo. Isso é necessário para anexos físicos e ignorado para anexos de link. |
|
|
Nome do arquivo
|
file_name | string |
O nome do arquivo para o anexo. Isso é necessário para anexos físicos e ignorado para anexos de link. |
Retornos
Anexo do fornecedor criado
Criar um endereço de fornecedor
Cria um novo endereço de fornecedor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
vendor_id | True | integer |
A ID do registro do sistema do fornecedor. |
|
Description
|
description | True | string |
A descrição do endereço. |
|
País
|
country | string |
O país do endereço. |
|
|
Linhas de endereço
|
address_line | string |
As linhas de rua/endereço do 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 em NZ) para o endereço. |
|
|
CEP
|
postal | string |
O cep ou ZIP do endereço. Limite de caracteres: 12. |
|
|
Município
|
county | string |
O condado do endereço. |
|
|
É primário?
|
is_primary | boolean |
Esse é o endereço principal do fornecedor? |
|
|
Enviar faturas?
|
is_invoices | boolean |
Enviar faturas para esse endereço? |
|
|
Enviar POs?
|
is_pos | boolean |
Enviar ordens de compra para esse endereço? |
|
|
Enviar 1099s?
|
issue_1099s | boolean |
Enviar 1099s para esse endereço? |
|
|
Título do contato
|
title | string |
O título do contato primário. |
|
|
Nome do contato
|
first_name | string |
O primeiro nome do contato primário. |
|
|
Nome do meio de contato
|
middle_name | string |
A inicialização intermediária ou o nome do contato primário. |
|
|
Sobrenome do contato
|
last_name | string |
O sobrenome do contato primário. |
|
|
Sufixo de contato
|
suffix | string |
O sufixo do contato primário. |
|
|
Posição de contato
|
position | string |
A posição do contato primário. |
Retornos
Endereço do fornecedor criado
Criar um fornecedor
Cria um novo fornecedor.
Parâmetros
| Nome | Chave | Obrigató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 da ID do imposto
|
tax_id_number | string |
O número da ID do imposto do fornecedor. |
|
|
Número do cliente
|
customer_number | string |
O número do cliente do fornecedor. |
|
|
Situação
|
vendor_status | string |
O status do fornecedor. |
|
|
Emissão da instrução 1099?
|
issue_1099s | boolean |
Emitir uma instruçã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 do 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 em NZ) para o endereço. |
|
|
Endereço postal code
|
postal | string |
O cep ou ZIP do endereço. Limite de caracteres: 12. |
|
|
Condado de endereço
|
county | string |
O condado do endereço. |
|
|
O endereço é primário?
|
is_primary | boolean |
Esse é o endereço principal do fornecedor? |
|
|
Enviar faturas?
|
is_invoices | boolean |
Enviar faturas para esse endereço? |
|
|
Enviar POs?
|
is_pos | boolean |
Enviar ordens de compra para esse endereço? |
|
|
Enviar 1099s?
|
is_1099 | boolean |
Enviar 1099s para esse endereço? |
|
|
Título do contato
|
title | string |
O título do contato primário. |
|
|
Nome do contato
|
first_name | string |
O primeiro nome do contato primário. |
|
|
Nome do meio de contato
|
middle_name | string |
A inicialização intermediária ou o nome do contato primário. |
|
|
Sobrenome do contato
|
last_name | string |
O sobrenome do contato primário. |
|
|
Sufixo de contato
|
suffix | string |
O sufixo do contato primário. |
|
|
Posição de contato
|
position | string |
A posição do contato primário. |
|
|
Limite de crédito?
|
has_credit_limit | boolean |
O padrão de pagamento tem um 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 |
Os termos do pagamento (NET). |
|
|
Conta de pagamento
|
account_name | string |
A conta da qual pagar faturas. |
|
|
Método de pagamento
|
payment_method | string |
A forma de pagamento. |
|
|
Opção de pagamento
|
payment_option | string |
A opção de pagamento. |
|
|
Ramificação GST
|
gst_branch | string |
O identificador de branch GST para esse fornecedor (aplicável somente para versões de UA). |
|
|
ID do tipo de imposto GST
|
gst_tax_type_id | integer |
O identificador de tipo de imposto GST para o fornecedor (aplicável somente para versões de AC e AU). |
|
|
ID do código de atividade do PSB
|
psb_activity_code_id | integer |
O identificador de código de atividade PSB para o fornecedor (aplicável somente para versões de AC). |
Retornos
Fornecedor criado
- Corpo
- APApi.CreatedVendor
Criar um item de linha de pedido de compra
Cria um novo item de linha de pedido de compra.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do pedido de compra
|
purchase_order_id | True | integer |
A ID do registro do sistema da ordem de compra. |
|
Tipo
|
type | True | string |
O tipo do item de linha. Atualmente, há suporte apenas para itens de linha regulares. |
|
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 ordenada. |
|
Custo unitário
|
unit_cost | True | decimal |
O custo unitário do item de linha. |
|
Custo estendido
|
extended_cost | True | decimal |
O custo estendido do item de linha. |
|
Número da parte do fornecedor
|
vendor_part_number | string |
O número da parte 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 do item de linha. |
|
|
Solicitado por
|
requested_by | string |
O membro da equipe que solicitou o item de linha. |
|
|
Entregar para
|
deliver_to | string |
O membro da equipe a ser entregue para o item de linha. |
|
|
Status da postagem
|
post_status | True | string |
O status de postagem do item de linha. |
|
Data da postagem
|
post_date | date |
A data de postagem do item de linha (por exemplo: '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 do fornecedor
Cria um novo método de contato para um endereço de fornecedor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
vendor_id | True | integer |
A ID do registro do sistema do fornecedor. |
|
ID do endereço
|
address_id | True | integer |
A ID do registro do sistema do endereço do fornecedor. |
|
Tipo de contato
|
contact_type | string |
O tipo de método de contato. |
|
|
Informações de contato
|
contact_info | True | string |
As informações de contato (endereço de email, número de telefone etc.) para esse método. |
Retornos
Método de contato de endereço do fornecedor criado
Criar uma anotação de fornecedor
Cria uma nova anotação de fornecedor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
vendor_id | True | integer |
A ID do registro do sistema do fornecedor. |
|
Tipo
|
type | True | string |
O tipo de anotação. |
|
Date
|
date | True | date |
A data da anotação (por exemplo: '2005-09-18'). |
|
Description
|
description | string |
A descrição da anotação. Limite de caracteres: 255. |
|
|
Observação
|
content | string |
O texto da anotação. |
Retornos
Anotação de fornecedor criada
- Corpo
- APApi.CreatedVendorNote
Criar uma ação do fornecedor
Cria uma nova ação de fornecedor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
vendor_id | True | integer |
A ID do registro do sistema do fornecedor. |
|
Tipo
|
type | True | string |
O tipo de ação. |
|
Date
|
date | True | date |
A data da ação (por exemplo: '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 em
|
completed_date | date |
A data de conclusão da ação (por exemplo: '2005-09-18'). |
Retornos
Ação do fornecedor criado
Criar uma fatura
Cria uma nova fatura usando as distribuições padrão do fornecedor especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
vendor_id | True | integer |
A ID do 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 (por exemplo: '2005-09-18'). |
|
Data de conclusão
|
due_date | True | date |
A data de conclusão da fatura (por exemplo: '2005-09-18'). |
|
Status da postagem
|
post_status | True | string |
O status da postagem da fatura. |
|
Data da postagem
|
post_date | True | date |
A data de postagem da fatura (por exemplo: '2005-09-18'). |
|
Quantidade
|
amount | True | decimal |
O valor da fatura. |
|
Description
|
description | True | string |
A descrição da fatura. |
|
Status 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 contas de despesas de fatura? |
|
|
Método de pagamento
|
payment_method | True | string |
A forma de pagamento da fatura. |
|
Remitir para
|
address_id | True | integer |
O endereço a ser endereçado para a fatura. |
|
Pago de
|
paid_from | string |
O banco do qual a fatura é paga. |
|
|
ID da conta de cartão
|
credit_card_account_id | integer |
A ID do registro do sistema da conta de cartão de crédito da qual a fatura é paga. |
|
|
ID do cartão
|
credit_card_id | integer |
A ID do registro do sistema do cartão de crédito do qual a fatura é paga. |
|
|
Manter o pagamento?
|
hold_payment | boolean |
Manter o pagamento nesta fatura? |
|
|
Pagamento separado?
|
create_separate_payment | boolean |
Sempre criar um pagamento separado para essa fatura? |
|
|
número da caixa
|
number | True | string |
O número da caixa. |
|
estado
|
state | string |
O estado do número da caixa. |
|
|
quantidade
|
amount | True | decimal |
O valor do número da caixa. |
Retornos
Fatura criada
- Corpo
- APApi.CreatedInvoice
Criar uma fatura (distribuição única)
Cria uma nova fatura com uma única distribuição.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
A fatura a ser criada. |
Retornos
Fatura criada
- Corpo
- APApi.CreatedInvoice
Criar uma ordem de compra
Cria uma nova ordem de compra.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
vendor_id | True | integer |
A ID do registro do sistema do fornecedor. |
|
Tipo
|
type | True | string |
O tipo de pedido de compra. |
|
Número do pedido
|
order_number | True | integer |
O número do pedido de compra. |
|
Data do pedido
|
order_date | True | date |
A data do pedido (por exemplo: '2005-09-18'). |
|
Situação
|
order_status | True | string |
O status da ordem de compra. |
|
Ordem de
|
order_from_contact_id | True | integer |
O identificador de contato do fornecedor para o ordenador da ordem de compra. |
|
Enviar 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. |
|
|
Termos
|
terms | True | string |
O termo da ordem de compra. |
|
Comprador
|
buyer | string |
O comprador do pedido de compra. |
|
|
Departamento
|
department | string |
O departamento da ordem de compra. |
|
|
Confirmar para
|
ordered_by | string |
O ordenador da ordem de compra. |
|
|
Enviar para
|
ship_to_address_id | integer |
O identificador da nave para o endereço da ordem de compra. |
|
|
Expira
|
expiration_date | date-time |
A data de validade da ordem de compra (necessária para pedidos de compra do Cobertor). |
|
|
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. |
Retornos
Ordem de compra criada
Excluir um ajuste de fatura
Exclui um ajuste de fatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da fatura
|
invoice_id | True | integer |
A ID do registro do sistema da fatura. |
|
ID de ajuste
|
adjustment_id | True | integer |
A ID do registro do sistema do ajuste de fatura a ser excluído. |
Excluir um anexo do fornecedor
Exclui um anexo do fornecedor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
vendor_id | True | integer |
A ID do registro do sistema do fornecedor. |
|
ID do anexo
|
attachment_id | True | integer |
A ID do registro do sistema do anexo do fornecedor a ser excluído. |
Excluir um endereço do fornecedor
Exclui um endereço do fornecedor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
vendor_id | True | integer |
A ID do registro do sistema do fornecedor. |
|
ID do endereço
|
address_id | True | integer |
A ID do registro do sistema do endereço do fornecedor a ser excluído. |
Excluir um memorando de crédito
Exclui um memorando de crédito.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do memorando de crédito
|
credit_memo_id | True | integer |
A ID do registro do sistema do memorando de crédito. |
Listar ajustes de fatura
Lista os ajustes de uma fatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da fatura
|
invoice_id | True | integer |
A ID do registro do sistema da fatura. |
Retornos
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
Listar anexos do fornecedor
Lista os anexos de um fornecedor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
vendor_id | True | integer |
A ID do registro do sistema do fornecedor. |
Retornos
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
Listar anotações e ações do fornecedor
Lista as anotações e as ações de um fornecedor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
vendor_id | True | integer |
A ID do registro do sistema do fornecedor. |
Retornos
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
Listar contatos do fornecedor
Lista os contatos de um fornecedor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
vendor_id | True | integer |
A ID do registro do sistema do fornecedor. |
Retornos
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
Listar distribuições padrão do fornecedor
Lista as distribuições padrão para um fornecedor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
vendor_id | True | integer |
A ID do registro do sistema do fornecedor. |
|
Limit
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 100. O máximo é 500. |
|
|
Deslocamento
|
offset | integer |
Representa o número de registros a serem ignoradas. Para uso com paginação. |
Retornos
Distribuições
Listar endereços do fornecedor
Lista os endereços de um fornecedor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
vendor_id | True | integer |
A ID do registro do sistema do fornecedor. |
Retornos
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
Listar faturas
Lista as faturas disponíveis.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A partir da data
|
from_date | date-time |
Filtre os resultados para faturas datadas na data ou após a data especificada. |
|
|
Até a data
|
to_date | date-time |
Filtre os resultados para faturas datadas na data ou antes da data especificada. |
|
|
Nome do fornecedor
|
vendor_name | string |
Pesquisar texto para corresponder ao nome do fornecedor. |
|
|
Situação
|
invoice_status | string |
O status da fatura. |
|
|
Status da postagem
|
post_status | string |
O status da postagem da fatura. |
|
|
Método de pagamento
|
payment_method | string |
A forma de pagamento da fatura. |
|
|
Pesquisar texto
|
search_text | string |
Pesquisar texto para corresponder ao nome do fornecedor, número da fatura, descrição ou número do pedido de compra. |
|
|
Limit
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 100. O máximo é 500. |
|
|
Deslocamento
|
offset | integer |
Representa o número de registros a serem ignoradas. Para uso com paginação. |
|
|
Adicionado em ou após
|
date_added | date-time |
Filtre os resultados para faturas adicionadas na data especificada ou após a data especificada. |
|
|
Adicionado 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 a data especificada. |
|
|
Modificado por
|
last_modified_by | string |
Filtre os resultados para faturas modificadas pela última vez pelo usuário especificado. |
Retornos
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
Listar fornecedores
Lista os fornecedores disponíveis.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Situação
|
status | string |
O status do fornecedor. |
|
|
Nome do fornecedor
|
vendor_name | string |
Pesquisar texto para corresponder ao nome do fornecedor. |
|
|
ID do fornecedor
|
ui_vendor_id | string |
O identificador visível do usuário para o fornecedor. |
|
|
Número do cliente
|
customer_number | string |
O número do cliente do fornecedor. |
|
|
Limit
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 100. O máximo é 500. |
|
|
Deslocamento
|
offset | integer |
Representa o número de registros a serem ignoradas. Para uso com paginação. |
|
|
Adicionado em ou após
|
date_added | date-time |
Filtre os resultados aos fornecedores adicionados na data especificada ou após a data especificada. |
|
|
Adicionado por
|
added_by | string |
Filtre os resultados aos 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 a data especificada. |
|
|
Modificado por
|
last_modified_by | string |
Filtre os resultados para fornecedores modificados pela última vez pelo usuário especificado. |
Retornos
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
Listar itens de linha de pedido de compra
Lista os itens de linha para um pedido de compra.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do pedido de compra
|
purchase_order_id | True | integer |
A ID do registro do sistema da ordem de compra. |
|
Limit
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 100. O máximo é 500. |
|
|
Deslocamento
|
offset | integer |
Representa o número de registros a serem ignoradas. Para uso com paginação. |
Retornos
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
vendor_id | True | integer |
A ID do registro do sistema do fornecedor. |
|
ID do endereço
|
address_id | True | integer |
A ID do registro do sistema do endereço do fornecedor. |
Retornos
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
Listar números de caixa da fatura 1099
Lista os números da caixa 1099 para uma fatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da fatura
|
invoice_id | True | integer |
A ID do registro do sistema da fatura. |
Retornos
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
Listar pedidos de compra
Lista os pedidos de compra disponíveis.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A partir da data
|
from_date | date-time |
Filtre os resultados para pedidos de compra datados na data ou após a data especificada. |
|
|
Até a data
|
to_date | date-time |
Filtre os resultados para pedidos de compra datados na data ou antes da data especificada. |
|
|
Tipo
|
type | string |
O tipo de pedido de compra. |
|
|
Pesquisar texto
|
search_text | string |
Pesquise o texto para corresponder ao nome do fornecedor ou ao número do pedido de compra. |
|
|
Limit
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 100. O máximo é 500. |
|
|
Deslocamento
|
offset | integer |
Representa o número de registros a serem ignoradas. Para uso com paginação. |
Retornos
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
Listar recibos
Lista os recibos disponíveis.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do pedido 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 os recibos recebidos pelo usuário especificado. |
|
|
A partir da data
|
from_date | date-time |
Filtre os resultados para recibos datados na data ou após a data especificada. |
|
|
Até a data
|
to_date | date-time |
Filtre os resultados para recibos datados na data ou antes da data especificada. |
|
|
Nome do fornecedor
|
vendor_name | string |
Pesquisar texto para corresponder ao nome do fornecedor. |
|
|
Pesquisar texto
|
search_text | string |
Pesquise texto para corresponder à descrição do recibo, número do recibo, data do recibo, número do pedido de compra ou número da fatura. |
|
|
Limit
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 100. O máximo é 500. |
|
|
Deslocamento
|
offset | integer |
Representa o número de registros a serem ignoradas. Para uso com paginação. |
Retornos
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
Obter informações da fatura 1099
Retorna as informações de 1099 para uma fatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da fatura
|
invoice_id | True | integer |
A ID do registro do sistema da fatura. |
Retornos
Formulário 1099
- Corpo
- APApi.Form1099
Obter informações do fornecedor 1099
Obtenha as informações de 1099 para um fornecedor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
vendor_id | True | integer |
A ID do registro do sistema do fornecedor. |
Retornos
Informações do 1099
Obter um ajuste de fatura
Retorna informações sobre um ajuste de fatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da fatura
|
invoice_id | True | integer |
A ID do registro do sistema da fatura. |
|
ID de ajuste
|
adjustment_id | True | integer |
A ID do registro do sistema do ajuste da fatura. |
Retornos
Ajuste de fatura
Obter um fornecedor
Retorna informações sobre um fornecedor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
vendor_id | True | integer |
A ID do registro do sistema do fornecedor. |
Retornos
Fornecedor
- Corpo
- APApi.VendorDetail
Obter um item de linha de pedido de compra
Retorna informações sobre um item de linha de pedido de compra.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do pedido de compra
|
purchase_order_id | True | integer |
A ID do registro do sistema da ordem de compra. |
|
ID do item de linha
|
line_item_id | True | integer |
A ID do registro do sistema do item de linha. |
Retornos
Item de linha
- Corpo
- APApi.LineItemDetail
Obter um pedido de compra
Retorna informações sobre um pedido de compra.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fornecedor
|
purchase_order_id | True | integer |
A ID do registro do sistema da ordem de compra. |
Retornos
Ordem de compra
Obter um recibo
Retorna informações sobre um recibo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do recibo
|
receipt_id | True | integer |
A ID do registro do sistema do recibo. |
Retornos
Recebimento
- Corpo
- APApi.ReceiptDetail
Obter uma fatura
Retorna informações sobre uma fatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da fatura
|
invoice_id | True | integer |
A ID do registro do sistema da fatura. |
Retornos
Invoice
- Corpo
- APApi.InvoiceDetail
Definições
APApi.AddressContactMethod
Método de contato de endereço
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
contact_method_id | integer |
A ID do registro do sistema do método de contato de endereço. |
|
tipo
|
contact_type | string |
O tipo de método de contato. |
|
informações
|
contact_info | string |
As informações do método de contato. |
APApi.AttachmentSummary
Anexo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
A ID do registro do sistema do anexo. |
|
Tipo
|
type | string |
O tipo de anexo. |
|
Nome
|
name | string |
O nome do anexo. |
|
URL
|
url | string |
A URL do anexo. Aplicável somente para anexos de link. |
|
Tipo de anexo
|
media_type | string |
Categoria definida pelo usuário deste anexo. |
|
date_attached
|
date_attached | date-time |
A data em que o anexo foi adicionado. |
APApi.AttachmentSummaryCollection
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. |
|
value
|
value | array of APApi.AttachmentSummary |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
APApi.CreatedInvoice
Fatura criada
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
record_id | integer |
A ID da fatura recém-criada. |
APApi.CreatedInvoiceAttachment
Anexo de fatura criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
record_id | integer |
A ID do anexo recém-criado. |
APApi.CreatedPurchaseOrder
Ordem de compra criada
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
record_id | integer |
A ID da ordem de compra recém-criada. |
APApi.CreatedVendor
Fornecedor criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
record_id | integer |
A ID do fornecedor recém-criado. |
APApi.CreatedVendorAction
Ação do fornecedor criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
record_id | integer |
A ID da ação de fornecedor recém-criada. |
APApi.CreatedVendorAddress
Endereço do fornecedor criado
| Nome | 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
| Nome | 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 do fornecedor criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
record_id | integer |
A ID do anexo recém-criado. |
APApi.CreatedVendorNote
Anotação de fornecedor criada
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
record_id | integer |
A ID da nota do fornecedor recém-criada. |
APApi.CustomField
Um objeto que contém os detalhes do campo personalizado.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
field_name | string |
O nome do campo personalizado. |
|
tipo
|
type | string |
O tipo de dados que o campo personalizado representa. |
|
value
|
value | string |
O valor do campo personalizado. |
|
é necessário?
|
is_required | boolean |
O campo personalizado é necessário? |
|
date
|
date | date-time |
A data no campo personalizado. |
|
comentário
|
comments | string |
O comentário no campo personalizado. |
APApi.DefaultDistribution
Distribuição
| Nome | 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 da Conta
|
account_number | string |
O número da conta da distribuição. |
|
Percent
|
percent | decimal |
O percentual de quantidade 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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. |
|
value
|
value | array of APApi.DefaultDistribution |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
APApi.DefaultDistributionSplit
Split
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
distribution_split_id | integer |
O identificador de divisão de distribuição. |
|
percent
|
percent | decimal |
O percentual de quantidade de entrada do diário de distribuição. |
|
projeto
|
ui_project_id | string |
O identificador visível do usuário do projeto para a divisão de distribuição. |
|
Class
|
account_class | string |
A classe de conta da divisão de distribuição. |
|
transaction_code_values
|
transaction_code_values | array of APApi.TransactionCodeValue |
Os valores do código da transação de distribuição. |
APApi.Distribution
Um objeto que contém os detalhes da distribuição.
| Nome | 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 da Conta
|
account_number | string |
O número da conta da distribuição. |
|
quantidade
|
amount | decimal |
O valor da entrada do diário de distribuição. |
|
descrição
|
description | string |
A descrição da 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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
distribution_split_id | integer |
O identificador de divisão de distribuição. |
|
quantidade
|
amount | decimal |
O valor da entrada do diário de distribuição. |
|
projeto
|
ui_project_id | string |
O identificador visível do usuário do projeto para a divisão de distribuição. |
|
classe
|
account_class | string |
A classe de conta da divisão de distribuição. |
|
transaction_code_values
|
transaction_code_values | array of APApi.TransactionCodeValue |
Os valores do código da transação de distribuição. |
APApi.Form1099
Formulário 1099
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Quantidade
|
amount | decimal |
O valor distribuído para 1099. |
|
Valor excluído
|
excluded_amount | decimal |
O valor excluído de 1099. |
APApi.InvoiceAdjustmentDetail
Ajuste de fatura
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
adjustment_id | integer |
O identificador de ajuste da fatura. |
|
Date
|
adjustment_date | date-time |
A data do ajuste da fatura. |
|
Status da postagem
|
post_status | string |
O status da postagem para o ajuste da fatura. |
|
Data da postagem
|
post_date | date-time |
A data de postagem do ajuste da fatura. |
|
Reason
|
reason | string |
O motivo do ajuste da fatura. |
|
Anotações
|
notes | string |
As anotações para o ajuste da fatura. |
|
count
|
adjustment_distributions.count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. |
|
value
|
adjustment_distributions.value | array of APApi.Distribution |
A lista de distribuições para o ajuste da fatura. |
APApi.InvoiceAdjustmentSummary
Ajuste de fatura
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
adjustment_id | integer |
O identificador de ajuste da fatura. |
|
Date
|
adjustment_date | date-time |
A data do ajuste da fatura. |
|
Status da postagem
|
post_status | string |
O status da postagem para o ajuste da fatura. |
|
Data da postagem
|
post_date | date-time |
A data de postagem do ajuste da fatura. |
|
Reason
|
reason | string |
O motivo do ajuste da fatura. |
|
Anotações
|
notes | string |
As anotações para o ajuste da fatura. |
APApi.InvoiceAdjustmentSummaryCollection
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. |
|
value
|
value | array of APApi.InvoiceAdjustmentSummary |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
APApi.InvoiceDetail
Invoice
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
invoice_id | integer |
A ID do registro do sistema da fatura. |
|
ID do fornecedor
|
vendor_id | integer |
A ID do 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 conclusão
|
due_date | date |
A data de conclusão da fatura (por exemplo: '2005-09-18'). |
|
Status da postagem
|
post_status | string |
O status da postagem da fatura. |
|
Data da postagem
|
post_date | date |
A data de postagem da fatura (por exemplo: '2005-09-18'). |
|
Quantidade
|
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 do imposto
|
invoice_amount_before_tax | decimal |
O valor da fatura antes do imposto (aplicável somente para versões de AC e UA). |
|
Incluir impostos?
|
include_tax | boolean |
Incluir imposto nesta fatura (aplicável somente para versões de AC e UA)? |
|
Valor do imposto
|
tax_amount | decimal |
O valor do imposto para a fatura (aplicável somente para versões de AC e UA). |
|
Distribuição de impostos
|
tax_distribution | array of APApi.RebateDistribution |
A distribuição de impostos para a fatura (aplicável somente para versões de UA). |
|
ID do tipo de imposto GST
|
gst_tax_type_id | integer |
O identificador de tipo de imposto GST para a fatura (aplicável somente para versões de AC e AU). |
|
Valor do desconto do GST
|
gst_rebate_amount | decimal |
O valor do desconto do GST para a fatura (aplicável somente para versões de AC). |
|
Distribuição de descontos do GST
|
gst_rebate_distribution | array of APApi.RebateDistribution |
A distribuição de descontos DO GST para a fatura (aplicável somente para versões de AC). |
|
ID do código de atividade do PSB
|
psb_activity_code_id | integer |
O identificador de código de atividade PSB para a fatura (aplicável somente para versões de AC). |
|
Valor do desconto do PST
|
pst_rebate_amount | decimal |
O valor de desconto PST para a fatura (aplicável somente para versões de AC). |
|
Distribuição de desconto do PST
|
pst_rebate_distribution | array of APApi.RebateDistribution |
A distribuição de desconto PST para a fatura (aplicável somente para versões de AC). |
|
Description
|
description | string |
A descrição da fatura. |
|
Status de aprovação
|
status | string |
O status de aprovação da fatura. |
|
Distribuir descontos?
|
distribute_discounts | boolean |
Distribuir descontos para contas de despesas de fatura? |
|
Número da ordem de compra
|
purchase_order_number | string |
O número do pedido de compra associado à fatura. |
|
Método de pagamento
|
invoice_payment_detail.payment_method | string |
A forma de pagamento da fatura. |
|
ID do endereço
|
invoice_payment_detail.remit_to.address_id | integer |
A ID do registro do sistema do endereço da 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 do endereço. |
|
city
|
invoice_payment_detail.remit_to.city | string |
A cidade do endereço. |
|
estado
|
invoice_payment_detail.remit_to.state | string |
O estado ou província (ou subúrbio em NZ) para o endereço. |
|
código postal
|
invoice_payment_detail.remit_to.postal | string |
O cep ou ZIP do endereço. |
|
condado
|
invoice_payment_detail.remit_to.county | string |
O condado do endereço. |
|
nome do contato
|
invoice_payment_detail.remit_to.contact_name | string |
O nome completo do contato para o endereço. |
|
Pago de
|
invoice_payment_detail.paid_from | string |
O banco do qual a fatura é paga. |
|
ID da conta de cartão
|
invoice_payment_detail.credit_card_account_id | integer |
A ID do registro do sistema da conta de cartão de crédito 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 da qual a fatura é paga. |
|
ID do cartão
|
invoice_payment_detail.credit_card_id | integer |
A ID do registro do sistema do cartão de crédito do qual a fatura é paga. |
|
Nome do cartão
|
invoice_payment_detail.credit_card_name | string |
O nome do cartão de crédito do qual a fatura foi paga. |
|
Manter o pagamento?
|
invoice_payment_detail.hold_payment | boolean |
Manter o pagamento nesta fatura? |
|
Pagamento separado?
|
invoice_payment_detail.create_separate_payment | boolean |
Sempre criar um pagamento separado para essa 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 da fatura. |
|
Campo personalizado
|
custom_fields | array of APApi.CustomField |
A lista de campos personalizados para a fatura. |
|
Data de inclusão
|
date_added | date-time |
A data em que a fatura foi criada. |
|
Adicionado por
|
added_by | string |
O nome do usuário que criou a fatura. |
|
Data modificada
|
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 da fatura.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da transação
|
br_transaction_id | integer |
A ID da transação do pagamento. |
|
número da transação
|
transaction_number | string |
O número da transação desse pagamento. |
|
date
|
payment_date | date-time |
A data para esse pagamento (por exemplo: '2005-09-18'). |
|
status
|
payment_status | string |
O status do pagamento. |
|
quantidade
|
amount | decimal |
O valor do pagamento. |
|
identificador de verificação
|
checks_7_id | integer |
O identificador de verificação do Financial Edge 7. |
APApi.InvoiceSummary
Invoice
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
invoice_id | integer |
A ID do registro do sistema da fatura. |
|
ID do fornecedor
|
vendor_id | integer |
A ID do 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. |
|
Quantidade
|
amount | decimal |
O valor da fatura. |
|
Valor devido
|
amount_due | decimal |
O valor ainda deve ser devido na fatura. |
|
Equilíbrio
|
balance | decimal |
O saldo atual na fatura. |
|
Situação
|
status | string |
O status da fatura. |
|
Status da postagem
|
post_status | string |
O status da postagem da fatura. |
|
Método de pagamento
|
payment_method | string |
A forma de pagamento da fatura. |
|
Idade
|
age | string |
A idade da fatura. |
|
Já está previsto?
|
is_past_due | boolean |
A fatura está vencida? |
|
Número da ordem de compra
|
purchase_order_number | string |
O número do pedido de compra associado à fatura. |
|
Tipo de imposto GST
|
gst_tax_type | string |
O tipo de imposto para a fatura (aplicável somente para versões de AC e UA). |
|
Data de inclusão
|
date_added | date-time |
A data em que a fatura foi criada. |
|
Adicionado por
|
added_by | string |
O nome do usuário que criou a fatura. |
|
Data modificada
|
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 torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. |
|
value
|
value | array of APApi.InvoiceSummary |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
APApi.Invoice1099BoxNumber
Número da caixa
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Número da caixa
|
number | string |
O número da caixa. |
|
Estado
|
state | string |
O estado do número da caixa. |
|
Percent
|
percent | decimal |
A porcentagem do número da caixa. |
|
Quantidade
|
amount | decimal |
O valor do número da caixa. |
APApi.Invoice1099BoxNumberCollection
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. |
|
results
|
results | array of APApi.Invoice1099BoxNumber |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
APApi.LineItemDetail
Item de linha
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do fornecedor
|
vendor_id | integer |
O identificador do fornecedor para o item de linha de pedido de compra. |
|
Nome do fornecedor
|
vendor_name | string |
O nome do fornecedor do item de linha de pedido de compra. |
|
Número do pedido
|
order_number | integer |
O número do pedido de compra. |
|
ID
|
line_item_id | integer |
O identificador do 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 do produto do item de linha. |
|
Código do produto
|
product_code | string |
O código do produto do item de linha. |
|
Número da parte do fornecedor
|
vendor_part_number | string |
O número da parte 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 ordenada
|
quantity_ordered | decimal |
A quantidade ordenada 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 cancelada
|
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 estendido
|
extended_cost | decimal |
O custo estendido do item de linha. |
|
Status da postagem
|
post_status | string |
O status da postagem do item de linha. |
|
Data da postagem
|
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. |
|
Entregar para
|
deliver_to | string |
O membro da equipe a ser entregue para o item de linha. |
|
Distribuição
|
distributions | array of APApi.Distribution |
A lista de distribuições para o item de linha. |
|
Data de inclusão
|
date_added | date-time |
A data em que o item de linha foi adicionado. |
|
Adicionado por
|
added_by | string |
O nome do usuário que adicionou o item de linha. |
|
Data modificada
|
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 de linha
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
line_item_id | integer |
O identificador do 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 do produto do item de linha. |
|
Código do produto
|
product_code | string |
O código do produto do item de linha. |
|
Número da parte do fornecedor
|
vendor_part_number | string |
O número da parte 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 ordenada
|
quantity_ordered | decimal |
A quantidade ordenada 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 cancelada
|
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 estendido
|
extended_cost | decimal |
O custo estendido do item de linha. |
|
Status da postagem
|
post_status | string |
O status da postagem do item de linha. |
|
Data da postagem
|
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. |
|
Entregar para
|
deliver_to | string |
O membro da equipe a ser entregue para o item de linha. |
|
Data de inclusão
|
date_added | date-time |
A data em que o item de linha foi adicionado. |
|
Adicionado por
|
added_by | string |
O nome do usuário que adicionou o item de linha. |
|
Data modificada
|
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 torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. |
|
value
|
value | array of APApi.LineItemSummary |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
APApi.PurchaseOrderDetail
Ordem de compra
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
purchase_order_id | integer |
A ID do registro do sistema da ordem de compra. |
|
ID do fornecedor
|
vendor_id | integer |
A ID do registro do sistema do fornecedor. |
|
Nome
|
vendor_name | string |
O nome do fornecedor. |
|
Tipo
|
type | string |
O tipo de pedido de compra. |
|
Número do pedido
|
order_number | integer |
O número do pedido de compra. |
|
Data do pedido
|
order_date | date-time |
A data do pedido de compra. |
|
Situação
|
order_status | string |
O status do pedido de compra. |
|
Solicitar a ID de contato
|
ordered_from_contact_id | integer |
O identificador de contato para o ordenador da ordem de compra. |
|
Enviar via
|
ship_via | string |
O método de envio da ordem de compra. |
|
FOB
|
fob | string |
O frete a bordo da ordem de compra. |
|
Termos
|
terms | string |
Os termos da ordem de compra. |
|
Comprador
|
buyer | string |
O comprador do pedido de compra. |
|
Departamento
|
department | string |
O departamento da ordem de compra. |
|
Confirmar para
|
ordered_by | string |
O ordenador da ordem de compra. |
|
Enviar para
|
ship_to_address | string |
A nave para o endereço 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 de recibos
|
receipted_total | decimal |
O total de recibos da ordem de compra. |
|
Data de inclusão
|
date_added | date-time |
A data em que o pedido de compra foi criado. |
|
Campo personalizado
|
custom_fields | array of APApi.CustomField |
A lista de campos personalizados para a ordem de compra. |
|
Adicionado por
|
added_by | string |
O nome do usuário que criou a ordem de compra. |
|
Data modificada
|
date_modified | date-time |
A data em que o pedido de compra foi modificado 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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
purchase_order_id | integer |
A ID do registro do sistema da ordem de compra. |
|
ID do fornecedor
|
vendor_id | integer |
A ID do registro do sistema do fornecedor. |
|
Nome
|
vendor_name | string |
O nome do fornecedor. |
|
Tipo
|
type | string |
O tipo de pedido de compra. |
|
Número do pedido
|
order_number | integer |
O número do pedido de compra. |
|
Data do pedido
|
order_date | date-time |
A data do pedido de compra. |
|
Situação
|
order_status | string |
O status do pedido de compra. |
|
Total
|
order_total | decimal |
O total da ordem de compra. |
|
Total de recibos
|
receipted_total | decimal |
O total de recibos da ordem de compra. |
|
Termos
|
terms | string |
Os termos da ordem de compra. |
|
Data de inclusão
|
date_added | date-time |
A data em que o pedido de compra foi criado. |
|
Adicionado por
|
added_by | string |
O nome do usuário que criou a ordem de compra. |
|
Data modificada
|
date_modified | date-time |
A data em que o pedido de compra foi modificado 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 torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. |
|
value
|
value | array of APApi.PurchaseOrderSummary |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
APApi.RebateDistribution
Um objeto que contém os detalhes da distribuição.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
distribution_id | integer |
O identificador de distribuição. |
|
ID da entidade fiscal
|
tax_entity_id | string |
O identificador de entidade fiscal. |
|
tipo
|
type_code | string |
O tipo de transação de entrada de diário para a distribuição. |
|
Número da Conta
|
account_number | string |
O número da conta da distribuição. |
|
quantidade
|
amount | decimal |
O valor da entrada do diário de distribuição. |
|
descrição
|
description | string |
A descrição da 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
Recebimento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
receipt_id | integer |
A ID do registro do sistema do recibo. |
|
Número do recibo
|
receipt_number | integer |
O número do recibo. |
|
Recebido por
|
received_by | string |
O receptor do recibo. |
|
Data de recebimento
|
receipt_date | date-time |
A data do recibo. |
|
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 |
A ID do registro do sistema do fornecedor. |
|
Nome
|
vendor_name | string |
O nome do fornecedor. |
|
ID do pedido de compra
|
purchase_order_id | integer |
A ID do registro do sistema da ordem de compra associada ao recibo. |
|
Número da ordem de compra
|
purchase_order_number | string |
O número do pedido de compra associado ao recibo. |
|
ID da fatura
|
invoice_id | integer |
A ID do 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 inclusão
|
date_added | date-time |
A data em que o recibo foi criado. |
|
Adicionado por
|
added_by | string |
O nome do usuário que criou o recibo. |
|
Data modificada
|
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
Recebimento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
receipt_id | integer |
A ID do registro do sistema do recibo. |
|
Número do recibo
|
receipt_number | integer |
O número do recibo. |
|
Recebido por
|
received_by | string |
O receptor do recibo. |
|
Data de recebimento
|
receipt_date | date-time |
A data do recibo. |
|
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 |
A ID do registro do sistema do fornecedor. |
|
Nome
|
vendor_name | string |
O nome do fornecedor. |
|
ID do pedido de compra
|
purchase_order_id | integer |
A ID do registro do sistema da ordem de compra associada ao recibo. |
|
Número da ordem de compra
|
purchase_order_number | string |
O número do pedido de compra associado ao recibo. |
|
ID da fatura
|
invoice_id | integer |
A ID do 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 inclusão
|
date_added | date-time |
A data em que o recibo foi criado. |
|
Adicionado por
|
added_by | string |
O nome do usuário que criou o recibo. |
|
Data modificada
|
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 torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. |
|
value
|
value | array of APApi.ReceiptSummary |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
APApi.TransactionCodeValue
Valor do código de transação
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
A ID do valor do código de transação. |
|
Value
|
name | string |
O nome do código da transação. |
|
Value
|
value | string |
O valor do código da transação. |
|
Inativo?
|
inactive | boolean |
O valor do código de transação está inativo? |
APApi.Vendor1099Information
Informações do 1099
| Nome | 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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
address_id | integer |
O identificador de endereço. |
|
Description
|
description | string |
A descrição do endereço. |
|
País
|
country | string |
O país do endereço. |
|
Linhas de endereço
|
address_line | string |
As linhas de rua/endereço do endereço. |
|
City
|
city | string |
A cidade do endereço. |
|
Estado
|
state | string |
O estado ou província (ou subúrbio em NZ) para o endereço. |
|
CEP
|
postal | string |
O cep ou ZIP do endereço. |
|
Município
|
county | string |
O condado do endereço. |
|
É primário?
|
is_primary | boolean |
Esse é o endereço principal do fornecedor? |
|
Enviar faturas?
|
is_invoices | boolean |
Enviar faturas para esse endereço? |
|
Enviar POs?
|
is_pos | boolean |
Enviar ordens de compra para esse endereço? |
|
Enviar 1099s?
|
is_1099 | boolean |
Enviar 1099s para esse endereço? |
|
Nome do destinatário
|
payee_name | string |
O nome do destinatário. |
|
Título do contato
|
title | string |
O título do contato primário. |
|
Nome do contato
|
first_name | string |
O primeiro nome do contato primário. |
|
Nome do meio de contato
|
middle_name | string |
A inicialização intermediária ou o nome do contato primário. |
|
Sobrenome do contato
|
last_name | string |
O sobrenome do contato primário. |
|
Sufixo de contato
|
suffix | string |
O sufixo do contato primário. |
|
Posição de contato
|
position | string |
A posição do contato primário. |
|
Método contact
|
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 torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. |
|
results
|
results | array of APApi.VendorAddress |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
APApi.VendorAddressContactMethod
Método de contato de endereço do fornecedor
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
contact_method_id | integer |
O identificador do método de contato de endereço. |
|
Tipo de contato
|
contact_type | string |
O tipo de contato. |
|
Informações de contato
|
contact_info | string |
As informações de contato. |
APApi.VendorAddressContactMethodCollection
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. |
|
results
|
results | array of APApi.VendorAddressContactMethod |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
APApi.VendorContact
Contato
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
vendor_contact_id | integer |
A ID do registro do sistema do contato. |
|
Nome
|
contact_display_name | string |
O nome de exibição do contato. |
|
Descrição do endereço
|
address_description | string |
A descrição do endereço do contato. |
|
Endereço
|
address_line | string |
As linhas de endereço do contato. |
APApi.VendorContactCollection
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. |
|
value
|
value | array of APApi.VendorContact |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
APApi.VendorDefaultBoxNumber
Número da caixa
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Número da caixa
|
number | string |
O número da caixa. |
|
Estado de relatório
|
state | string |
O estado de relatório do número da caixa. |
|
Percent
|
percent | decimal |
A porcentagem do número da caixa. |
APApi.VendorDetail
Fornecedor
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
vendor_id | integer |
A ID do registro do sistema do fornecedor. |
|
ID do fornecedor
|
ui_defined_id | string |
O identificador definido pelo usuário para o fornecedor. |
|
Número da ID do imposto
|
tax_id_number | string |
O número da ID do imposto do fornecedor. |
|
ID do código de atividade do PSB
|
psb_activity_code_id | integer |
A ID do código de atividade PSB para o fornecedor (aplicável somente para versões de AC). |
|
Código de atividade PSB
|
psb_activity_code | string |
O código de atividade PSB para o fornecedor (aplicável somente para versões de AC). |
|
Descrição do código de atividade do PSB
|
psb_activity_code_desc | string |
A descrição do código de atividade PSB para o fornecedor (aplicável somente para versões de AC). |
|
Tipo de imposto GST
|
gst_tax_type | string |
O tipo de imposto GST para o fornecedor (aplicável somente para versões de AC 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 somente para versões de AC e AU). |
|
Ramificação GST
|
gst_branch | string |
O branch para o fornecedor (aplicável somente para versões de UA). |
|
Nome
|
vendor_name | string |
O nome do fornecedor. |
|
Tipo
|
vendor_type | string |
O tipo de fornecedor. |
|
Número do cliente
|
customer_number | string |
O número do cliente do fornecedor. |
|
Situação
|
vendor_status | string |
O status do fornecedor. |
|
Emissão da instrução 1099?
|
issue_1099s | boolean |
Emitir uma instrução 1099 para o fornecedor? |
|
Saldo devido
|
balance_due | decimal |
O saldo devido para o fornecedor. |
|
Endereço
|
addresses | array of APApi.VendorAddress |
A lista de endereços para o fornecedor. |
|
Campo personalizado
|
custom_fields | array of APApi.CustomField |
A lista de campos personalizados para o fornecedor. |
|
Padrão de pagamento
|
vendor_payment_default | APApi.VendorPaymentDefault |
Os padrões de pagamento do fornecedor. |
|
Data de inclusão
|
date_added | date-time |
A data em que o fornecedor foi criado. |
|
Adicionado por
|
added_by | string |
O nome do usuário que criou o fornecedor. |
|
Data modificada
|
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
Observação/ação
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
note_action_id | integer |
A ID do registro do sistema da anotação ou ação. |
|
Tipo de registro
|
note_type | string |
O tipo de registro (anotação ou ação). |
|
Tipo
|
type | string |
O tipo de ação ou anotação. |
|
Date
|
date | date-time |
A data da anotação ou ação. |
|
Description
|
description | string |
A descrição da anotação ou da ação. |
|
Observação
|
content | string |
O conteúdo da anotação. |
|
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 em
|
completed_date | date-time |
A data de conclusão da ação. |
APApi.VendorNoteActionCollection
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. |
|
results
|
results | array of APApi.VendorNoteAction |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
APApi.VendorPaymentDefault
Os padrões de pagamento do fornecedor.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
limite de crédito?
|
has_credit_limit | boolean |
O padrão de pagamento tem um 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 |
Os termos do pagamento (NET). |
|
nome da conta
|
account_name | string |
A conta da qual pagar faturas. |
|
método
|
payment_method | string |
A forma de pagamento. |
|
Opção
|
payment_option | string |
A opção de pagamento. |
APApi.VendorSummary
Fornecedor
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
vendor_id | integer |
A ID do 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 do cliente
|
customer_number | string |
O número do cliente do fornecedor. |
|
Situação
|
vendor_status | string |
O status do fornecedor. |
|
Emissão da instrução 1099?
|
issue_1099s | boolean |
Emitir uma instrução 1099 para o fornecedor? |
|
Saldo devido
|
balance_due | decimal |
O saldo devido para o fornecedor. |
|
Método de pagamento
|
payment_method | string |
A forma de pagamento padrão para o fornecedor. |
|
ID
|
primary_address.address_id | integer |
A ID do 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 do endereço. |
|
city
|
primary_address.city | string |
A cidade do endereço. |
|
estado
|
primary_address.state | string |
O estado ou província (ou subúrbio em NZ) para o endereço. |
|
código postal
|
primary_address.postal | string |
O cep ou ZIP do endereço. |
|
condado
|
primary_address.county | string |
O condado do endereço. |
|
é primário?
|
primary_address.is_primary | boolean |
Esse é o endereço principal do fornecedor? |
|
enviar faturas?
|
primary_address.is_invoices | boolean |
Enviar faturas para esse endereço? |
|
enviar POs?
|
primary_address.is_pos | boolean |
Enviar ordens de compra para esse endereço? |
|
enviar 1099s?
|
primary_address.is_1099 | boolean |
Enviar 1099s para esse endereço? |
|
título do contato
|
primary_address.title | string |
O título do contato primário. |
|
nome do contato
|
primary_address.first_name | string |
O primeiro nome do contato primário. |
|
nome do meio do contato
|
primary_address.middle_name | string |
A inicialização intermediária ou o nome do contato primário. |
|
sobrenome do contato
|
primary_address.last_name | string |
O sobrenome do contato primário. |
|
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 primário. |
|
address_contact_methods
|
primary_address.address_contact_methods | array of APApi.AddressContactMethod |
A lista de métodos de contato para o endereço. |
|
Padrão de pagamento
|
payment_defaults | APApi.VendorPaymentDefault |
Os padrões de pagamento do fornecedor. |
|
Data de inclusão
|
date_added | date-time |
A data em que o fornecedor foi criado. |
|
Adicionado por
|
added_by | string |
O nome do usuário que criou o fornecedor. |
|
Data modificada
|
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 torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. |
|
value
|
value | array of APApi.VendorSummary |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |