Coupa (Editora Independente) (Pré-visualização)
Fornece acesso robusto para ler, editar ou integrar seus dados com a plataforma Coupa.
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 | NovaGL |
| URL | https://www.coupa.com |
| gl1@live.om |
| Metadados do conector | |
|---|---|
| Editora | NovaGL |
| Sítio Web | https://www.coupa.com |
| Política de privacidade | https://www.coupa.com/privacy-policy |
| Categorias | Commerce |
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Nome da instância do Coupa | cadeia (de caracteres) | Insira o nome da instância Coupa excluindo coupahost.com | Verdade |
| Âmbito Coupa | cadeia (de caracteres) | Insira escopos Coupa Oidc sem vírgulas | Verdade |
| ID do cliente Coupa | cadeia (de caracteres) | Insira o ID do cliente Coupa | Verdade |
| Segredo do Cliente Coupa | securestring | Insira o segredo do cliente Coupa | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
Anexos - Adicionar anexo (URL) a um comentário
Adicionar um anexo (URL) a um comentário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do comentário
|
id | True | string |
ID do comentário |
|
id
|
id | integer |
id |
|
|
tipo
|
type | string |
tipo |
|
|
Intenção
|
intent | string |
intenção |
|
|
URL
|
url | string |
URL |
Devoluções
- Body
- Attachments
Anexos - Adicionar anexo (URL) a uma ordem de compra
Adicionar anexo (URL) a uma ordem de compra
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
id
|
id | integer |
id |
|
|
tipo
|
type | string |
tipo |
|
|
Intenção
|
intent | string |
intenção |
|
|
URL
|
url | string |
URL |
Devoluções
- Body
- Attachments
Anexos - Obter anexos de uma ordem de compra
Obter anexos de uma ordem de compra
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
Devoluções
- response
- array of Attachments
Comentários - Adicionar comentário de ordem de compra
POST um comentário sobre Ordem de Compra
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
po_id
|
po_id | True | string |
ID da Ordem de Compra |
|
comentário-id
|
commentable-id | integer |
comentário-id |
|
|
comments
|
comments | string |
comments |
Devoluções
- Body
- Comments
Contratos - Adicionar uma cláusula contratual
Adicionar uma cláusula contratual
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
tipo contrato-termo
|
contract-term-type | string |
Tipo de Termo do Contrato |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
Nível-1-Disco-PCT
|
tier-1-disc-pct | string |
tier_1_disc_pct |
|
|
Limite superior da camada 1
|
tier-1-upper-bound | string |
tier_1_upper_bound |
|
|
Nível 2-Disco-PCT
|
tier-2-disc-pct | string |
tier_2_disc_pct |
|
|
Nível 2 - limite superior
|
tier-2-upper-bound | string |
tier_2_upper_bound |
|
|
Nível 3-Disco-PCT
|
tier-3-disc-pct | string |
tier_3_disc_pct |
|
|
Limite superior do nível 3
|
tier-3-upper-bound | string |
tier_3_upper_bound |
|
|
tipo
|
type | string |
tipo |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
uso-pct-descontos
|
use-pct-discounts | string |
use_pct_discounts |
Devoluções
- Body
- ContractTerm
Contratos - Criar um contrato
Criar contrato
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
tipo contrato-termo
|
contract-term-type | string |
Tipo de Termo do Contrato |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
Nível-1-Disco-PCT
|
tier-1-disc-pct | string |
tier_1_disc_pct |
|
|
Limite superior da camada 1
|
tier-1-upper-bound | string |
tier_1_upper_bound |
|
|
Nível 2-Disco-PCT
|
tier-2-disc-pct | string |
tier_2_disc_pct |
|
|
Nível 2 - limite superior
|
tier-2-upper-bound | string |
tier_2_upper_bound |
|
|
Nível 3-Disco-PCT
|
tier-3-disc-pct | string |
tier_3_disc_pct |
|
|
Limite superior do nível 3
|
tier-3-upper-bound | string |
tier_3_upper_bound |
|
|
tipo
|
type | string |
tipo |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
uso-pct-descontos
|
use-pct-discounts | string |
use_pct_discounts |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
descrição
|
description | string |
Notas descritivas sobre o contrato |
|
|
data-limite
|
end-date | string |
Data de Expiração |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
valor-máximo
|
maximum-value | string |
Valor Máximo de Compromisso |
|
|
valor-mínimo
|
minimum-value | string |
Valor Mínimo de Compromisso |
|
|
nome
|
name | string |
Nome do contrato |
|
|
número
|
number | string |
Número do contrato |
|
|
data de início
|
start-date | string |
Data de início |
|
|
estado
|
status | string |
Situação do contrato |
|
|
número da conta
|
account-number | string |
Número de conta |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
nome de exibição
|
display-name | string |
display_name |
|
|
id
|
id | integer |
ID Interno Coupa |
|
|
nome
|
name | string |
Nome do fornecedor |
|
|
número
|
number | string |
Número do fornecedor |
|
|
estado
|
status | string |
Estado do fornecedor |
|
|
conta-fornecedor
|
supplier-account | string |
Número de conta do fornecedor |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
versão
|
version | integer |
versão |
|
|
return_object
|
return_object | string |
return_object |
|
|
filtro
|
filter | string |
filtro |
Devoluções
- Body
- Contract
Contratos - Obter Contrato por ID
Obter contrato por ID
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
offset
|
offset | integer |
Compensação |
|
|
return_object
|
return_object | string |
return_object |
|
|
dir
|
dir | string |
dir |
Devoluções
- Body
- Contract
Contratos - Obter Contratos
Obter contratos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
offset
|
offset | integer |
Compensação |
|
|
limit
|
limit | integer |
Limite |
|
|
return_object
|
return_object | string |
return_object |
|
|
filtro
|
filter | string |
filtro |
|
|
dir
|
dir | string |
dir |
Devoluções
- response
- array of Contract
Endereços - Atualizar endereço existente
Atualizar endereço existente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
nome
|
name | string |
nome |
|
|
Código de Localização
|
location-code | string |
código de localização |
|
|
rua1
|
street1 | string |
rua1 |
|
|
rua2
|
street2 | string |
rua2 |
|
|
city
|
city | string |
city |
|
|
Estado
|
state | string |
state |
|
|
Código postal
|
postal-code | string |
código postal |
|
|
código
|
code | True | string |
código |
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
ID
|
id | integer |
id |
Devoluções
- Body
- Address
Endereços - Criar Endereço
Criar endereço
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
nome
|
name | string |
nome |
|
|
Código de Localização
|
location-code | string |
código de localização |
|
|
rua1
|
street1 | string |
rua1 |
|
|
rua2
|
street2 | string |
rua2 |
|
|
city
|
city | string |
city |
|
|
Estado
|
state | string |
state |
|
|
Código postal
|
postal-code | string |
código postal |
|
|
código
|
code | True | string |
código |
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
ID
|
id | integer |
id |
Devoluções
- Body
- Address
Endereços - Endereços de consulta
Endereço de consulta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
Devoluções
- response
- array of Address
Endereços - Obter endereço por ID
Obter endereço
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
Devoluções
- Body
- Address
Fatura - Obter faturas
Obter faturas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
dir
|
dir | string |
dir |
|
|
Data da fatura inferior a
|
invoice_date[lt] | date-time |
Data da fatura < |
|
|
return_object
|
return_object | string |
return_object |
|
|
limit
|
limit | string |
limit |
|
|
offset
|
offset | string |
offset |
|
|
estado
|
status | string |
estado |
|
|
filtro
|
filter | string |
filtro |
Devoluções
- response
- array of Invoices
Faturas - anular uma fatura
Anular uma fatura
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
ID da fatura |
Devoluções
- Body
- Invoices
Faturas - Atualizar fatura
Atualizar fatura
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
ID da fatura |
|
data da fatura
|
invoice-date | string |
data da fatura |
|
|
número da fatura
|
invoice-number | string |
número da fatura |
|
|
tributação ao nível da linha
|
line-level-taxation | boolean |
tributação ao nível da linha |
|
|
total com impostos
|
total-with-taxes | string |
total com impostos |
|
|
tipo de documento
|
document-type | string |
tipo de documento |
|
|
login
|
login | string |
login |
|
|
active
|
active | boolean |
Um valor falso inativará o COA |
|
|
código
|
code | string | ||
|
enabled
|
enabled | string |
Ativado(a) |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
código
|
code | string |
código |
|
|
número da conta
|
account-number | string |
Número de conta |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
nome de exibição
|
display-name | string |
display_name |
|
|
id
|
id | integer |
ID Interno Coupa |
|
|
nome
|
name | string |
Nome do fornecedor |
|
|
número
|
number | string |
Número do fornecedor |
|
|
estado
|
status | string |
Estado do fornecedor |
|
|
código de localização
|
ship-to-address | string |
código de localização |
|
|
active
|
active | boolean |
Um valor falso inativará o COA |
|
|
código
|
code | string | ||
|
enabled
|
enabled | string |
Ativado(a) |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
ID do tipo de conta
|
account-type-id | integer |
ID do tipo de conta |
|
|
active
|
active | boolean |
Sinalizador Ativo\Inativo |
|
|
código
|
code | string |
Todos os segmentos concatenados com um hífen ( - ) |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
active
|
active | boolean |
Active |
|
|
pode aprovar
|
can-approve | boolean |
O grupo de usuários tem a capacidade de ser um aprovador |
|
|
descrição
|
description | string |
descrição |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | True | string |
nome |
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
descrição
|
description | string |
Description |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
tipo de segurança de grupo empresarial
|
business-group-security-type | integer |
business_group_security_type |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
e-mail
|
string |
|
||
|
login
|
login | string |
número de funcionário |
|
|
nome completo
|
fullname | string |
nome completo |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
Este é o apelido da conta. |
|
|
segmento-1
|
segment-1 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-2
|
segment-2 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-3
|
segment-3 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-4
|
segment-4 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-5
|
segment-5 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-6
|
segment-6 | string |
Cada segmento representa o segmento do código da conta |
|
|
contabilística-total
|
accounting-total | string |
contabilística-total |
|
|
descrição
|
description | string |
descrição |
|
|
núm-linha
|
line-num | integer |
núm-linha |
|
|
linha-ID
|
id | integer |
ID da linha de ordem interna Coupa |
|
|
order-header-num
|
order-header-num | integer |
order-header-num |
|
|
Número PO
|
po-number | string |
Número PO |
|
|
ordem-linha-num
|
order-line-num | string |
ordem-linha-num |
|
|
Preço
|
price | string |
Preço |
|
|
quantidade
|
quantity | string |
quantidade |
|
|
total
|
total | string |
total |
|
|
tipo
|
type | string |
tipo |
|
|
tipo contrato-termo
|
contract-term-type | string |
Tipo de Termo do Contrato |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
Nível-1-Disco-PCT
|
tier-1-disc-pct | string |
tier_1_disc_pct |
|
|
Limite superior da camada 1
|
tier-1-upper-bound | string |
tier_1_upper_bound |
|
|
Nível 2-Disco-PCT
|
tier-2-disc-pct | string |
tier_2_disc_pct |
|
|
Nível 2 - limite superior
|
tier-2-upper-bound | string |
tier_2_upper_bound |
|
|
Nível 3-Disco-PCT
|
tier-3-disc-pct | string |
tier_3_disc_pct |
|
|
Limite superior do nível 3
|
tier-3-upper-bound | string |
tier_3_upper_bound |
|
|
tipo
|
type | string |
tipo |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
uso-pct-descontos
|
use-pct-discounts | string |
use_pct_discounts |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
descrição
|
description | string |
Notas descritivas sobre o contrato |
|
|
data-limite
|
end-date | string |
Data de Expiração |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
valor-máximo
|
maximum-value | string |
Valor Máximo de Compromisso |
|
|
valor-mínimo
|
minimum-value | string |
Valor Mínimo de Compromisso |
|
|
nome
|
name | string |
Nome do contrato |
|
|
número
|
number | string |
Número do contrato |
|
|
data de início
|
start-date | string |
Data de início |
|
|
estado
|
status | string |
Situação do contrato |
|
|
número da conta
|
account-number | string |
Número de conta |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
nome de exibição
|
display-name | string |
display_name |
|
|
id
|
id | integer |
ID Interno Coupa |
|
|
nome
|
name | string |
Nome do fornecedor |
|
|
número
|
number | string |
Número do fornecedor |
|
|
estado
|
status | string |
Estado do fornecedor |
|
|
conta-fornecedor
|
supplier-account | string |
Número de conta do fornecedor |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
versão
|
version | integer |
versão |
|
|
código
|
code | string | ||
|
enabled
|
enabled | string |
Ativado(a) |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
nome
|
name | string |
nome |
|
|
código
|
code | string |
código |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
id
|
id | integer |
Identificador único Coupa |
Devoluções
- Body
- Invoices
Faturas - Criar fatura
Criar fatura
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
data da fatura
|
invoice-date | string |
data da fatura |
|
|
número da fatura
|
invoice-number | string |
número da fatura |
|
|
tributação ao nível da linha
|
line-level-taxation | boolean |
tributação ao nível da linha |
|
|
total com impostos
|
total-with-taxes | string |
total com impostos |
|
|
tipo de documento
|
document-type | string |
tipo de documento |
|
|
login
|
login | string |
login |
|
|
active
|
active | boolean |
Um valor falso inativará o COA |
|
|
código
|
code | string | ||
|
enabled
|
enabled | string |
Ativado(a) |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
código
|
code | string |
código |
|
|
número da conta
|
account-number | string |
Número de conta |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
nome de exibição
|
display-name | string |
display_name |
|
|
id
|
id | integer |
ID Interno Coupa |
|
|
nome
|
name | string |
Nome do fornecedor |
|
|
número
|
number | string |
Número do fornecedor |
|
|
estado
|
status | string |
Estado do fornecedor |
|
|
código de localização
|
ship-to-address | string |
código de localização |
|
|
active
|
active | boolean |
Um valor falso inativará o COA |
|
|
código
|
code | string | ||
|
enabled
|
enabled | string |
Ativado(a) |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
ID do tipo de conta
|
account-type-id | integer |
ID do tipo de conta |
|
|
active
|
active | boolean |
Sinalizador Ativo\Inativo |
|
|
código
|
code | string |
Todos os segmentos concatenados com um hífen ( - ) |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
active
|
active | boolean |
Active |
|
|
pode aprovar
|
can-approve | boolean |
O grupo de usuários tem a capacidade de ser um aprovador |
|
|
descrição
|
description | string |
descrição |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | True | string |
nome |
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
descrição
|
description | string |
Description |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
tipo de segurança de grupo empresarial
|
business-group-security-type | integer |
business_group_security_type |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
e-mail
|
string |
|
||
|
login
|
login | string |
número de funcionário |
|
|
nome completo
|
fullname | string |
nome completo |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
Este é o apelido da conta. |
|
|
segmento-1
|
segment-1 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-2
|
segment-2 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-3
|
segment-3 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-4
|
segment-4 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-5
|
segment-5 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-6
|
segment-6 | string |
Cada segmento representa o segmento do código da conta |
|
|
contabilística-total
|
accounting-total | string |
contabilística-total |
|
|
descrição
|
description | string |
descrição |
|
|
núm-linha
|
line-num | integer |
núm-linha |
|
|
linha-ID
|
id | integer |
ID da linha de ordem interna Coupa |
|
|
order-header-num
|
order-header-num | integer |
order-header-num |
|
|
Número PO
|
po-number | string |
Número PO |
|
|
ordem-linha-num
|
order-line-num | string |
ordem-linha-num |
|
|
Preço
|
price | string |
Preço |
|
|
quantidade
|
quantity | string |
quantidade |
|
|
total
|
total | string |
total |
|
|
tipo
|
type | string |
tipo |
|
|
tipo contrato-termo
|
contract-term-type | string |
Tipo de Termo do Contrato |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
Nível-1-Disco-PCT
|
tier-1-disc-pct | string |
tier_1_disc_pct |
|
|
Limite superior da camada 1
|
tier-1-upper-bound | string |
tier_1_upper_bound |
|
|
Nível 2-Disco-PCT
|
tier-2-disc-pct | string |
tier_2_disc_pct |
|
|
Nível 2 - limite superior
|
tier-2-upper-bound | string |
tier_2_upper_bound |
|
|
Nível 3-Disco-PCT
|
tier-3-disc-pct | string |
tier_3_disc_pct |
|
|
Limite superior do nível 3
|
tier-3-upper-bound | string |
tier_3_upper_bound |
|
|
tipo
|
type | string |
tipo |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
uso-pct-descontos
|
use-pct-discounts | string |
use_pct_discounts |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
descrição
|
description | string |
Notas descritivas sobre o contrato |
|
|
data-limite
|
end-date | string |
Data de Expiração |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
valor-máximo
|
maximum-value | string |
Valor Máximo de Compromisso |
|
|
valor-mínimo
|
minimum-value | string |
Valor Mínimo de Compromisso |
|
|
nome
|
name | string |
Nome do contrato |
|
|
número
|
number | string |
Número do contrato |
|
|
data de início
|
start-date | string |
Data de início |
|
|
estado
|
status | string |
Situação do contrato |
|
|
número da conta
|
account-number | string |
Número de conta |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
nome de exibição
|
display-name | string |
display_name |
|
|
id
|
id | integer |
ID Interno Coupa |
|
|
nome
|
name | string |
Nome do fornecedor |
|
|
número
|
number | string |
Número do fornecedor |
|
|
estado
|
status | string |
Estado do fornecedor |
|
|
conta-fornecedor
|
supplier-account | string |
Número de conta do fornecedor |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
versão
|
version | integer |
versão |
|
|
código
|
code | string | ||
|
enabled
|
enabled | string |
Ativado(a) |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
nome
|
name | string |
nome |
|
|
código
|
code | string |
código |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
id
|
id | integer |
Identificador único Coupa |
Devoluções
- Body
- Invoices
Faturas - Excluir fatura por ID
Excluir faturas por ID
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
ID da fatura |
Faturas - Obter fatura por ID
Obter faturas por ID
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | integer |
id |
Devoluções
- Body
- Invoices
Fornecedores - Consulta de fornecedores
Consultar fornecedores
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
ordenar por
|
order_by | string |
ordenar por |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filtro
|
filter | string |
filtro |
Devoluções
- response
- array of Supplier
Integração - Mostrar erros de integração
Mostrar erros de integração
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
ordenar por
|
order_by | string |
ordenar por |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filtro
|
filter | string |
filtro |
Devoluções
- response
- array of IntegrationError
Integrações - Integrações de consulta
Integrações de consulta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
ordenar por
|
order_by | string |
ordenar por |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filtro
|
filter | string |
filtro |
Devoluções
- response
- array of Integration
Integrações - Mostrar execução de integração
A integração de consultas é executada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
ordenar por
|
order_by | string |
ordenar por |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filtro
|
filter | string |
filtro |
Devoluções
- response
- array of IntegrationRun
Integrações - Mostrar execução de integração
Mostrar execução de integração
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | integer |
id |
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
ordenar por
|
order_by | string |
ordenar por |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filtro
|
filter | string |
filtro |
Devoluções
- Body
- IntegrationRun
Itens - Criar Item
Criar Item
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
nome
|
name | string |
Nome do item |
|
|
descrição
|
description | string |
Discipção do item |
|
|
número-artigo
|
item-number | string |
Número de item exclusivo |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | True | string |
nome |
|
atualizado-em
|
updated-at | date-time |
atualizado-em |
|
|
nome
|
name | string |
nome |
|
|
código
|
code | string |
código |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
imagem-url
|
image-url | string |
URL para a imagem do item (será copiado para o Coupa na criação/atualização do item) |
Devoluções
- Body
- Item
Itens - Itens de consulta
Itens de consulta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
ordenar por
|
order_by | string |
ordenar por |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filtro
|
filter | string |
filtro |
Devoluções
- response
- array of Item
Itens - Obter Item de Fornecedor por ID
Obter itens de fornecedor por ID
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
offset
|
offset | integer |
Compensação |
|
|
return_object
|
return_object | string |
return_object |
|
|
dir
|
dir | string |
dir |
Devoluções
- Body
- SupplierItem
Itens - Obter Item por ID
Obter Item por ID
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
return_object
|
return_object | string |
return_object |
Devoluções
- Body
- Item
Listas de Encomendas - Obter Lista de Encomendas por ID
Mostrar lista de pedidos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | integer |
id |
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
ordenar por
|
order_by | string |
ordenar por |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filtro
|
filter | string |
filtro |
Devoluções
- Body
- OrderPad
Listas de Pedidos - Consultar Listas de Ordens
Listas de Ordem de Consulta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
ordenar por
|
order_by | string |
ordenar por |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filtro
|
filter | string |
filtro |
Devoluções
- response
- array of OrderPad
Listas de Pedidos - Criar Lista de Pedidos
Criar Lista de Pedidos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
adicionar todos os itens
|
add-all-items | string |
Sinalizador indicando para adicionar todos os itens |
|
|
qualquer fornecedor
|
any-supplier | string |
any_supplier |
|
|
valor-base
|
base-value |
base_value |
||
|
código
|
code | string | ||
|
enabled
|
enabled | string |
Ativado(a) |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | True | string |
nome |
|
nome
|
name | string |
Nome do item |
|
|
descrição
|
description | string |
Discipção do item |
|
|
número-artigo
|
item-number | string |
Número de item exclusivo |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | True | string |
nome |
|
atualizado-em
|
updated-at | date-time |
atualizado-em |
|
|
nome
|
name | string |
nome |
|
|
código
|
code | string |
código |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
imagem-url
|
image-url | string |
URL para a imagem do item (será copiado para o Coupa na criação/atualização do item) |
|
|
método ordem-montante-
|
order-amount-method | True | string |
order_amount_method |
|
ID do fornecedor
|
supplier-id | True | integer |
supplier_id |
|
par-nível
|
par-level | number |
par_level |
|
|
Montante
|
amount | number |
Montante |
|
|
id
|
id | integer |
Identificador único Coupa |
Devoluções
- Body
- OrderPad
Ordens de Compra - Cancelar Ordem de Compra
Ordens de Compra - Cancelar Ordem de Compra
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
Devoluções
- Body
- PurchaseOrder
Ordens de Compra - Fechar Ordem de Compra
Ordens de Compra - Fechar Ordem de Compra
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
Devoluções
- Body
- PurchaseOrder
Ordens de Compra - Obter Ordem de Compra por ID
Obter Ordem de Compra por ID
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
filtro
|
filter | string |
filtro |
|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
ordenar por
|
order_by | string |
ordenar por |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
Devoluções
- Body
- PurchaseOrder
Ordens de Compra - Obter Ordens de Compra
Obter ordens de compra
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
filtro
|
filter | string |
filtro |
|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
ordenar por
|
order_by | string |
ordenar por |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
Devoluções
- response
- array of PurchaseOrder
Ordens de compra - Reabrir ordem de compra
Ordens de compra - Reabrir ordem de compra
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
reason_insight_code
|
reason_insight_code | string |
Código da razão |
|
|
razão-insight-evento-comentário
|
reason-insight-event-comment | string |
Razão Comentário |
Devoluções
- Body
- PurchaseOrder
Pesquisa - Consultar valores de pesquisa
Valores de pesquisa de consulta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da pesquisa
|
lookup[name] | string |
Nome da pesquisa |
|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
ordenar por
|
order_by | string |
ordenar por |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filtro
|
filter | string |
filtro |
Devoluções
- response
- array of LookupValue
Pesquisa - Pesquisas de consulta
Pesquisas de consulta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da pesquisa
|
name | string |
Nome da pesquisa |
|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
ordenar por
|
order_by | string |
ordenar por |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filtro
|
filter | string |
filtro |
Devoluções
- response
- array of Lookup
Recibos - Anular um recibo
Anular recibos por ID
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
campos
|
fields | string |
campos |
Devoluções
- Body
- InventoryTransaction
Recibos - Criar ou anular parcialmente uma entrada de mercadorias
Criar uma nova entrada de mercadorias
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
quantidade
|
quantity | integer |
quantidade |
|
|
tipo
|
type | string |
tipo |
|
|
ID de transação original
|
original-transaction-id | number |
ID da transação de recibo a anular |
|
|
ID da Linha Interal Coupa
|
id | integer |
ID da linha de encomenda |
Devoluções
- Body
- InventoryTransaction
Requisições - Adicionar ao Carrinho (Texto Livre)
Adicionar uma exigência de texto livre ao carrinho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | integer |
id |
|
|
tipo
|
type | string |
tipo |
|
|
Intenção
|
intent | string |
intenção |
|
|
URL
|
url | string |
URL |
|
|
exportado
|
exported | boolean |
Indica se a transação foi exportada |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
Justificação
|
justification | string |
Comentários da Justificação da Requisição |
|
|
necessidade-a-data
|
need-by-date | date-time |
Necessidade do item por data |
|
|
req-título
|
req-title | string |
Título opcional da Requisição |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
active
|
active | boolean |
Active |
|
|
pode aprovar
|
can-approve | boolean |
O grupo de usuários tem a capacidade de ser um aprovador |
|
|
descrição
|
description | string |
descrição |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | True | string |
nome |
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
descrição
|
description | string |
Description |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
tipo de segurança de grupo empresarial
|
business-group-security-type | integer |
business_group_security_type |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
e-mail
|
string |
|
||
|
login
|
login | string |
número de funcionário |
|
|
nome completo
|
fullname | string |
nome completo |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
active
|
active | boolean |
Active |
|
|
pode aprovar
|
can-approve | boolean |
O grupo de usuários tem a capacidade de ser um aprovador |
|
|
descrição
|
description | string |
descrição |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | True | string |
nome |
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
descrição
|
description | string |
Description |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
tipo de segurança de grupo empresarial
|
business-group-security-type | integer |
business_group_security_type |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
e-mail
|
string |
|
||
|
login
|
login | string |
número de funcionário |
|
|
nome completo
|
fullname | string |
nome completo |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Um valor falso inativará o COA |
|
|
código
|
code | string | ||
|
enabled
|
enabled | string |
Ativado(a) |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
ID do tipo de conta
|
account-type-id | integer |
ID do tipo de conta |
|
|
active
|
active | boolean |
Sinalizador Ativo\Inativo |
|
|
código
|
code | string |
Todos os segmentos concatenados com um hífen ( - ) |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
active
|
active | boolean |
Active |
|
|
pode aprovar
|
can-approve | boolean |
O grupo de usuários tem a capacidade de ser um aprovador |
|
|
descrição
|
description | string |
descrição |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | True | string |
nome |
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
descrição
|
description | string |
Description |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
tipo de segurança de grupo empresarial
|
business-group-security-type | integer |
business_group_security_type |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
e-mail
|
string |
|
||
|
login
|
login | string |
número de funcionário |
|
|
nome completo
|
fullname | string |
nome completo |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
Este é o apelido da conta. |
|
|
segmento-1
|
segment-1 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-2
|
segment-2 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-3
|
segment-3 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-4
|
segment-4 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-5
|
segment-5 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-6
|
segment-6 | string |
Cada segmento representa o segmento do código da conta |
|
|
id
|
id | integer |
id |
|
|
tipo
|
type | string |
tipo |
|
|
Intenção
|
intent | string |
intenção |
|
|
URL
|
url | string |
URL |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | True | string |
nome |
|
atualizado-em
|
updated-at | date-time |
atualizado-em |
|
|
tipo contrato-termo
|
contract-term-type | string |
Tipo de Termo do Contrato |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
Nível-1-Disco-PCT
|
tier-1-disc-pct | string |
tier_1_disc_pct |
|
|
Limite superior da camada 1
|
tier-1-upper-bound | string |
tier_1_upper_bound |
|
|
Nível 2-Disco-PCT
|
tier-2-disc-pct | string |
tier_2_disc_pct |
|
|
Nível 2 - limite superior
|
tier-2-upper-bound | string |
tier_2_upper_bound |
|
|
Nível 3-Disco-PCT
|
tier-3-disc-pct | string |
tier_3_disc_pct |
|
|
Limite superior do nível 3
|
tier-3-upper-bound | string |
tier_3_upper_bound |
|
|
tipo
|
type | string |
tipo |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
uso-pct-descontos
|
use-pct-discounts | string |
use_pct_discounts |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
descrição
|
description | string |
Notas descritivas sobre o contrato |
|
|
data-limite
|
end-date | string |
Data de Expiração |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
valor-máximo
|
maximum-value | string |
Valor Máximo de Compromisso |
|
|
valor-mínimo
|
minimum-value | string |
Valor Mínimo de Compromisso |
|
|
nome
|
name | string |
Nome do contrato |
|
|
número
|
number | string |
Número do contrato |
|
|
data de início
|
start-date | string |
Data de início |
|
|
estado
|
status | string |
Situação do contrato |
|
|
número da conta
|
account-number | string |
Número de conta |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
nome de exibição
|
display-name | string |
display_name |
|
|
id
|
id | integer |
ID Interno Coupa |
|
|
nome
|
name | string |
Nome do fornecedor |
|
|
número
|
number | string |
Número do fornecedor |
|
|
estado
|
status | string |
Estado do fornecedor |
|
|
conta-fornecedor
|
supplier-account | string |
Número de conta do fornecedor |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
versão
|
version | integer |
versão |
|
|
descrição
|
description | True | string |
descrição |
|
id
|
id | integer |
Identificador único Coupa |
|
|
atualizado-em
|
updated-at | date-time |
Criado automaticamente por Coupa no formato AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
imagem-url
|
image-url | string |
URL da imagem |
|
|
nome
|
name | string |
Nome do item |
|
|
descrição
|
description | string |
Discipção do item |
|
|
número-artigo
|
item-number | string |
Número de item exclusivo |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
nome
|
name | string |
nome |
|
|
código
|
code | string |
código |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
imagem-url
|
image-url | string |
URL para a imagem do item (será copiado para o Coupa na criação/atualização do item) |
|
|
núm-linha
|
line-num | integer |
line_num |
|
|
tipo de linha
|
line-type | string |
tipo de linha |
|
|
ID da linha de ordem
|
order-line-id | integer |
order_line_id |
|
|
estado
|
status | string |
Status da transação |
|
|
total
|
total | number |
total |
|
|
transmissão-e-mails
|
transmission-emails | string |
Transmissão de e-mails |
|
|
Substituição do método de transmissão
|
transmission-method-override | string |
Substituição do método de transmissão |
|
|
preço-unitário
|
unit-price | number |
preço do item de linha |
|
|
nome
|
name | string |
nome |
|
|
Código de Localização
|
location-code | string |
código de localização |
|
|
rua1
|
street1 | string |
rua1 |
|
|
rua2
|
street2 | string |
rua2 |
|
|
city
|
city | string |
city |
|
|
Estado
|
state | string |
state |
|
|
Código postal
|
postal-code | string |
código postal |
|
|
código
|
code | True | string |
código |
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
ID
|
id | integer |
id |
|
|
ship-to-attention
|
ship-to-attention | string |
Enviar para endereçar a atenção |
|
|
estado
|
status | True | string |
Status da transação |
Devoluções
- Body
- RequisitionHeader
Requisições - Criar Requisição
Criar requisição
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | integer |
id |
|
|
tipo
|
type | string |
tipo |
|
|
Intenção
|
intent | string |
intenção |
|
|
URL
|
url | string |
URL |
|
|
exportado
|
exported | boolean |
Indica se a transação foi exportada |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
Justificação
|
justification | string |
Comentários da Justificação da Requisição |
|
|
necessidade-a-data
|
need-by-date | date-time |
Necessidade do item por data |
|
|
req-título
|
req-title | string |
Título opcional da Requisição |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
active
|
active | boolean |
Active |
|
|
pode aprovar
|
can-approve | boolean |
O grupo de usuários tem a capacidade de ser um aprovador |
|
|
descrição
|
description | string |
descrição |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | True | string |
nome |
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
descrição
|
description | string |
Description |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
tipo de segurança de grupo empresarial
|
business-group-security-type | integer |
business_group_security_type |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
e-mail
|
string |
|
||
|
login
|
login | string |
número de funcionário |
|
|
nome completo
|
fullname | string |
nome completo |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
active
|
active | boolean |
Active |
|
|
pode aprovar
|
can-approve | boolean |
O grupo de usuários tem a capacidade de ser um aprovador |
|
|
descrição
|
description | string |
descrição |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | True | string |
nome |
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
descrição
|
description | string |
Description |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
tipo de segurança de grupo empresarial
|
business-group-security-type | integer |
business_group_security_type |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
e-mail
|
string |
|
||
|
login
|
login | string |
número de funcionário |
|
|
nome completo
|
fullname | string |
nome completo |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Um valor falso inativará o COA |
|
|
código
|
code | string | ||
|
enabled
|
enabled | string |
Ativado(a) |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
ID do tipo de conta
|
account-type-id | integer |
ID do tipo de conta |
|
|
active
|
active | boolean |
Sinalizador Ativo\Inativo |
|
|
código
|
code | string |
Todos os segmentos concatenados com um hífen ( - ) |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
active
|
active | boolean |
Active |
|
|
pode aprovar
|
can-approve | boolean |
O grupo de usuários tem a capacidade de ser um aprovador |
|
|
descrição
|
description | string |
descrição |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | True | string |
nome |
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
descrição
|
description | string |
Description |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
tipo de segurança de grupo empresarial
|
business-group-security-type | integer |
business_group_security_type |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
e-mail
|
string |
|
||
|
login
|
login | string |
número de funcionário |
|
|
nome completo
|
fullname | string |
nome completo |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
Este é o apelido da conta. |
|
|
segmento-1
|
segment-1 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-2
|
segment-2 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-3
|
segment-3 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-4
|
segment-4 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-5
|
segment-5 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-6
|
segment-6 | string |
Cada segmento representa o segmento do código da conta |
|
|
id
|
id | integer |
id |
|
|
tipo
|
type | string |
tipo |
|
|
Intenção
|
intent | string |
intenção |
|
|
URL
|
url | string |
URL |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | True | string |
nome |
|
atualizado-em
|
updated-at | date-time |
atualizado-em |
|
|
tipo contrato-termo
|
contract-term-type | string |
Tipo de Termo do Contrato |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
Nível-1-Disco-PCT
|
tier-1-disc-pct | string |
tier_1_disc_pct |
|
|
Limite superior da camada 1
|
tier-1-upper-bound | string |
tier_1_upper_bound |
|
|
Nível 2-Disco-PCT
|
tier-2-disc-pct | string |
tier_2_disc_pct |
|
|
Nível 2 - limite superior
|
tier-2-upper-bound | string |
tier_2_upper_bound |
|
|
Nível 3-Disco-PCT
|
tier-3-disc-pct | string |
tier_3_disc_pct |
|
|
Limite superior do nível 3
|
tier-3-upper-bound | string |
tier_3_upper_bound |
|
|
tipo
|
type | string |
tipo |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
uso-pct-descontos
|
use-pct-discounts | string |
use_pct_discounts |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
descrição
|
description | string |
Notas descritivas sobre o contrato |
|
|
data-limite
|
end-date | string |
Data de Expiração |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
valor-máximo
|
maximum-value | string |
Valor Máximo de Compromisso |
|
|
valor-mínimo
|
minimum-value | string |
Valor Mínimo de Compromisso |
|
|
nome
|
name | string |
Nome do contrato |
|
|
número
|
number | string |
Número do contrato |
|
|
data de início
|
start-date | string |
Data de início |
|
|
estado
|
status | string |
Situação do contrato |
|
|
número da conta
|
account-number | string |
Número de conta |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
nome de exibição
|
display-name | string |
display_name |
|
|
id
|
id | integer |
ID Interno Coupa |
|
|
nome
|
name | string |
Nome do fornecedor |
|
|
número
|
number | string |
Número do fornecedor |
|
|
estado
|
status | string |
Estado do fornecedor |
|
|
conta-fornecedor
|
supplier-account | string |
Número de conta do fornecedor |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
versão
|
version | integer |
versão |
|
|
descrição
|
description | True | string |
descrição |
|
id
|
id | integer |
Identificador único Coupa |
|
|
atualizado-em
|
updated-at | date-time |
Criado automaticamente por Coupa no formato AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
imagem-url
|
image-url | string |
URL da imagem |
|
|
nome
|
name | string |
Nome do item |
|
|
descrição
|
description | string |
Discipção do item |
|
|
número-artigo
|
item-number | string |
Número de item exclusivo |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
nome
|
name | string |
nome |
|
|
código
|
code | string |
código |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
imagem-url
|
image-url | string |
URL para a imagem do item (será copiado para o Coupa na criação/atualização do item) |
|
|
núm-linha
|
line-num | integer |
line_num |
|
|
tipo de linha
|
line-type | string |
tipo de linha |
|
|
ID da linha de ordem
|
order-line-id | integer |
order_line_id |
|
|
estado
|
status | string |
Status da transação |
|
|
total
|
total | number |
total |
|
|
transmissão-e-mails
|
transmission-emails | string |
Transmissão de e-mails |
|
|
Substituição do método de transmissão
|
transmission-method-override | string |
Substituição do método de transmissão |
|
|
preço-unitário
|
unit-price | number |
preço do item de linha |
|
|
nome
|
name | string |
nome |
|
|
Código de Localização
|
location-code | string |
código de localização |
|
|
rua1
|
street1 | string |
rua1 |
|
|
rua2
|
street2 | string |
rua2 |
|
|
city
|
city | string |
city |
|
|
Estado
|
state | string |
state |
|
|
Código postal
|
postal-code | string |
código postal |
|
|
código
|
code | True | string |
código |
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
ID
|
id | integer |
id |
|
|
ship-to-attention
|
ship-to-attention | string |
Enviar para endereçar a atenção |
|
|
estado
|
status | True | string |
Status da transação |
Devoluções
- Body
- RequisitionHeader
Requisições - Obter Requisição por ID
Obter requisição por ID
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
Devoluções
- Body
- RequisitionHeader
Requisições - Obter Requisições
Obter Requisições
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
limit
|
limit | string |
limit |
|
|
offset
|
offset | string |
offset |
Devoluções
- response
- array of RequisitionHeader
Requisições - Requisição de atualização
Requisição de atualização
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
id |
|
id
|
id | integer |
id |
|
|
tipo
|
type | string |
tipo |
|
|
Intenção
|
intent | string |
intenção |
|
|
URL
|
url | string |
URL |
|
|
exportado
|
exported | boolean |
Indica se a transação foi exportada |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
Justificação
|
justification | string |
Comentários da Justificação da Requisição |
|
|
necessidade-a-data
|
need-by-date | date-time |
Necessidade do item por data |
|
|
req-título
|
req-title | string |
Título opcional da Requisição |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
active
|
active | boolean |
Active |
|
|
pode aprovar
|
can-approve | boolean |
O grupo de usuários tem a capacidade de ser um aprovador |
|
|
descrição
|
description | string |
descrição |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | True | string |
nome |
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
descrição
|
description | string |
Description |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
tipo de segurança de grupo empresarial
|
business-group-security-type | integer |
business_group_security_type |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
e-mail
|
string |
|
||
|
login
|
login | string |
número de funcionário |
|
|
nome completo
|
fullname | string |
nome completo |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
active
|
active | boolean |
Active |
|
|
pode aprovar
|
can-approve | boolean |
O grupo de usuários tem a capacidade de ser um aprovador |
|
|
descrição
|
description | string |
descrição |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | True | string |
nome |
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
descrição
|
description | string |
Description |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
tipo de segurança de grupo empresarial
|
business-group-security-type | integer |
business_group_security_type |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
e-mail
|
string |
|
||
|
login
|
login | string |
número de funcionário |
|
|
nome completo
|
fullname | string |
nome completo |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Um valor falso inativará o COA |
|
|
código
|
code | string | ||
|
enabled
|
enabled | string |
Ativado(a) |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
ID do tipo de conta
|
account-type-id | integer |
ID do tipo de conta |
|
|
active
|
active | boolean |
Sinalizador Ativo\Inativo |
|
|
código
|
code | string |
Todos os segmentos concatenados com um hífen ( - ) |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
active
|
active | boolean |
Active |
|
|
pode aprovar
|
can-approve | boolean |
O grupo de usuários tem a capacidade de ser um aprovador |
|
|
descrição
|
description | string |
descrição |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | True | string |
nome |
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
descrição
|
description | string |
Description |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
tipo de segurança de grupo empresarial
|
business-group-security-type | integer |
business_group_security_type |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
e-mail
|
string |
|
||
|
login
|
login | string |
número de funcionário |
|
|
nome completo
|
fullname | string |
nome completo |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
Este é o apelido da conta. |
|
|
segmento-1
|
segment-1 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-2
|
segment-2 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-3
|
segment-3 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-4
|
segment-4 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-5
|
segment-5 | string |
Cada segmento representa o segmento do código da conta |
|
|
segmento-6
|
segment-6 | string |
Cada segmento representa o segmento do código da conta |
|
|
id
|
id | integer |
id |
|
|
tipo
|
type | string |
tipo |
|
|
Intenção
|
intent | string |
intenção |
|
|
URL
|
url | string |
URL |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | True | string |
nome |
|
atualizado-em
|
updated-at | date-time |
atualizado-em |
|
|
tipo contrato-termo
|
contract-term-type | string |
Tipo de Termo do Contrato |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
Nível-1-Disco-PCT
|
tier-1-disc-pct | string |
tier_1_disc_pct |
|
|
Limite superior da camada 1
|
tier-1-upper-bound | string |
tier_1_upper_bound |
|
|
Nível 2-Disco-PCT
|
tier-2-disc-pct | string |
tier_2_disc_pct |
|
|
Nível 2 - limite superior
|
tier-2-upper-bound | string |
tier_2_upper_bound |
|
|
Nível 3-Disco-PCT
|
tier-3-disc-pct | string |
tier_3_disc_pct |
|
|
Limite superior do nível 3
|
tier-3-upper-bound | string |
tier_3_upper_bound |
|
|
tipo
|
type | string |
tipo |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
uso-pct-descontos
|
use-pct-discounts | string |
use_pct_discounts |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
descrição
|
description | string |
Notas descritivas sobre o contrato |
|
|
data-limite
|
end-date | string |
Data de Expiração |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
valor-máximo
|
maximum-value | string |
Valor Máximo de Compromisso |
|
|
valor-mínimo
|
minimum-value | string |
Valor Mínimo de Compromisso |
|
|
nome
|
name | string |
Nome do contrato |
|
|
número
|
number | string |
Número do contrato |
|
|
data de início
|
start-date | string |
Data de início |
|
|
estado
|
status | string |
Situação do contrato |
|
|
número da conta
|
account-number | string |
Número de conta |
|
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
nome de exibição
|
display-name | string |
display_name |
|
|
id
|
id | integer |
ID Interno Coupa |
|
|
nome
|
name | string |
Nome do fornecedor |
|
|
número
|
number | string |
Número do fornecedor |
|
|
estado
|
status | string |
Estado do fornecedor |
|
|
conta-fornecedor
|
supplier-account | string |
Número de conta do fornecedor |
|
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
versão
|
version | integer |
versão |
|
|
descrição
|
description | True | string |
descrição |
|
id
|
id | integer |
Identificador único Coupa |
|
|
atualizado-em
|
updated-at | date-time |
Criado automaticamente por Coupa no formato AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
imagem-url
|
image-url | string |
URL da imagem |
|
|
nome
|
name | string |
Nome do item |
|
|
descrição
|
description | string |
Discipção do item |
|
|
número-artigo
|
item-number | string |
Número de item exclusivo |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
nome
|
name | string |
nome |
|
|
código
|
code | string |
código |
|
|
active
|
active | boolean |
Ativo\Inativo |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
id
|
id | integer |
Identificador único Coupa |
|
|
imagem-url
|
image-url | string |
URL para a imagem do item (será copiado para o Coupa na criação/atualização do item) |
|
|
núm-linha
|
line-num | integer |
line_num |
|
|
tipo de linha
|
line-type | string |
tipo de linha |
|
|
ID da linha de ordem
|
order-line-id | integer |
order_line_id |
|
|
estado
|
status | string |
Status da transação |
|
|
total
|
total | number |
total |
|
|
transmissão-e-mails
|
transmission-emails | string |
Transmissão de e-mails |
|
|
Substituição do método de transmissão
|
transmission-method-override | string |
Substituição do método de transmissão |
|
|
preço-unitário
|
unit-price | number |
preço do item de linha |
|
|
nome
|
name | string |
nome |
|
|
Código de Localização
|
location-code | string |
código de localização |
|
|
rua1
|
street1 | string |
rua1 |
|
|
rua2
|
street2 | string |
rua2 |
|
|
city
|
city | string |
city |
|
|
Estado
|
state | string |
state |
|
|
Código postal
|
postal-code | string |
código postal |
|
|
código
|
code | True | string |
código |
|
id
|
id | integer |
Identificador único Coupa |
|
|
nome
|
name | string |
nome |
|
|
ID
|
id | integer |
id |
|
|
ship-to-attention
|
ship-to-attention | string |
Enviar para endereçar a atenção |
|
|
estado
|
status | True | string |
Status da transação |
Devoluções
- Body
- RequisitionHeader
Usuários - Consultar usuários
Consultar usuários
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
login
|
login | string |
login |
|
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
ordenar por
|
order_by | string |
ordenar por |
|
|
dir
|
dir | string |
dir |
|
|
return_object
|
return_object | string |
return_object |
|
|
filtro
|
filter | string |
filtro |
Devoluções
- response
- array of UserSimple
Definições
RequisitionHeader
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
attachments
|
attachments | array of Attachments | |
|
exportado
|
exported | boolean |
Indica se a transação foi exportada |
|
id
|
id | integer |
Identificador único Coupa |
|
Justificação
|
justification | string |
Comentários da Justificação da Requisição |
|
necessidade-a-data
|
need-by-date | date-time |
Necessidade do item por data |
|
req-título
|
req-title | string |
Título opcional da Requisição |
|
solicitante
|
requester | UserSimple | |
|
criado por
|
created-by | UserSimple | |
|
linhas de requisição
|
requisition-lines | array of RequisitionLine | |
|
ship-to-address
|
ship-to-address | Address | |
|
ship-to-attention
|
ship-to-attention | string |
Enviar para endereçar a atenção |
|
estado
|
status | string |
Status da transação |
RequisitionLine
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
conta
|
account | Account | |
|
attachments
|
attachments | array of Attachments | |
|
Mercadoria
|
commodity | Commodity | |
|
contrato
|
contract | Contract | |
|
moeda
|
currency | Currency | |
|
descrição
|
description | string |
descrição |
|
forma-resposta
|
form-response | FormResponse | |
|
id
|
id | integer |
Identificador único Coupa |
|
imagem-url
|
image-url | string |
URL da imagem |
|
item
|
item | Item | |
|
núm-linha
|
line-num | integer |
line_num |
|
proprietário da linha
|
line-owner | UserSimple | |
|
tipo de linha
|
line-type | string |
tipo de linha |
|
ID da linha de ordem
|
order-line-id | integer |
order_line_id |
|
estado
|
status | string |
Status da transação |
|
fornecedor
|
supplier | Supplier | |
|
total
|
total | number |
total |
|
transmissão-e-mails
|
transmission-emails | string |
Transmissão de e-mails |
|
Substituição do método de transmissão
|
transmission-method-override | string |
Substituição do método de transmissão |
|
preço-unitário
|
unit-price | number |
preço do item de linha |
|
UOM
|
uom | Uom |
Invoices
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
data da fatura
|
invoice-date | string |
data da fatura |
|
número da fatura
|
invoice-number | string |
número da fatura |
|
tributação ao nível da linha
|
line-level-taxation | boolean |
tributação ao nível da linha |
|
total com impostos
|
total-with-taxes | string |
total com impostos |
|
tipo de documento
|
document-type | string |
tipo de documento |
|
login
|
requested-by.login | string |
login |
|
tipo de conta
|
account-type | AccountType | |
|
código
|
currency.code | string |
código |
|
fornecedor
|
supplier | Supplier | |
|
código de localização
|
ship-to-address | string |
código de localização |
|
Linhas de fatura
|
invoice-lines | array of object | |
|
conta
|
invoice-lines.account | Account | |
|
contabilística-total
|
invoice-lines.accounting-total | string |
contabilística-total |
|
descrição
|
invoice-lines.description | string |
descrição |
|
núm-linha
|
invoice-lines.line-num | integer |
núm-linha |
|
linha-ID
|
invoice-lines.id | integer |
ID da linha de ordem interna Coupa |
|
order-header-num
|
invoice-lines.order-header-num | integer |
order-header-num |
|
Número PO
|
invoice-lines.po-number | string |
Número PO |
|
ordem-linha-num
|
invoice-lines.order-line-num | string |
ordem-linha-num |
|
Preço
|
invoice-lines.price | string |
Preço |
|
quantidade
|
invoice-lines.quantity | string |
quantidade |
|
total
|
invoice-lines.total | string |
total |
|
tipo
|
invoice-lines.type | string |
tipo |
|
contrato
|
invoice-lines.contract | Contract | |
|
moeda
|
invoice-lines.currency | Currency | |
|
UOM
|
invoice-lines.uom | Uom |
PurchaseOrder
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
id |
|
criado-AT
|
created-at | string |
criado-AT |
|
estado
|
status | string |
estado |
|
ship-to-attention
|
ship-to-attention | string |
ship-to-attention |
|
id
|
ship-to-address.id | integer |
id |
|
nome
|
ship-to-address.name | string |
nome |
|
linhas de ordem
|
order-lines | array of OrderLine |
Attachments
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
id |
|
tipo
|
type | string |
tipo |
|
Intenção
|
intent | string |
intenção |
|
URL
|
url | string |
URL |
Address
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
nome |
|
Código de Localização
|
location-code | string |
código de localização |
|
rua1
|
street1 | string |
rua1 |
|
rua2
|
street2 | string |
rua2 |
|
city
|
city | string |
city |
|
Estado
|
state | string |
state |
|
Código postal
|
postal-code | string |
código postal |
|
country
|
country | Country | |
|
ID
|
id | integer |
id |
Country
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
code | string |
código |
|
id
|
id | integer |
Identificador único Coupa |
|
nome
|
name | string |
nome |
OrderPad
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
adicionar todos os itens
|
add-all-items | string |
Sinalizador indicando para adicionar todos os itens |
|
qualquer fornecedor
|
any-supplier | string |
any_supplier |
|
valor-base
|
base-value |
base_value |
|
|
valor-base-moeda
|
base-value-currency | Currency | |
|
id
|
id | integer |
Identificador único Coupa |
|
nome
|
name | string |
nome |
|
linhas do bloco de pedidos
|
order-pad-lines | array of OrderPadLine |
OrderPadLine
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
item
|
item | Item | |
|
método ordem-montante-
|
order-amount-method | string |
order_amount_method |
|
ID do fornecedor
|
supplier-id | integer |
supplier_id |
|
par-nível
|
par-level | number |
par_level |
|
Montante
|
amount | number |
Montante |
|
id
|
id | integer |
Identificador único Coupa |
Comments
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
comentário-id
|
commentable-id | integer |
comentário-id |
|
comments
|
comments | string |
comments |
Moeda
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
code | string | |
|
enabled
|
enabled | string |
Ativado(a) |
|
id
|
id | integer |
Identificador único Coupa |
|
nome
|
name | string |
nome |
Contrato
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
cláusulas contratuais
|
contract-terms | array of ContractTerm | |
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
descrição
|
description | string |
Notas descritivas sobre o contrato |
|
data-limite
|
end-date | string |
Data de Expiração |
|
id
|
id | integer |
Identificador único Coupa |
|
valor-máximo
|
maximum-value | string |
Valor Máximo de Compromisso |
|
valor-mínimo
|
minimum-value | string |
Valor Mínimo de Compromisso |
|
nome
|
name | string |
Nome do contrato |
|
número
|
number | string |
Número do contrato |
|
data de início
|
start-date | string |
Data de início |
|
estado
|
status | string |
Situação do contrato |
|
fornecedor
|
supplier | Supplier | |
|
conta-fornecedor
|
supplier-account | string |
Número de conta do fornecedor |
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
versão
|
version | integer |
versão |
ContratoTermo
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo contrato-termo
|
contract-term-type | string |
Tipo de Termo do Contrato |
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
id
|
id | integer |
Identificador único Coupa |
|
nome
|
name | string |
nome |
|
Nível-1-Disco-PCT
|
tier-1-disc-pct | string |
tier_1_disc_pct |
|
Limite superior da camada 1
|
tier-1-upper-bound | string |
tier_1_upper_bound |
|
Nível 2-Disco-PCT
|
tier-2-disc-pct | string |
tier_2_disc_pct |
|
Nível 2 - limite superior
|
tier-2-upper-bound | string |
tier_2_upper_bound |
|
Nível 3-Disco-PCT
|
tier-3-disc-pct | string |
tier_3_disc_pct |
|
Limite superior do nível 3
|
tier-3-upper-bound | string |
tier_3_upper_bound |
|
tipo
|
type | string |
tipo |
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
uso-pct-descontos
|
use-pct-discounts | string |
use_pct_discounts |
Fornecedor
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
número da conta
|
account-number | string |
Número de conta |
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
nome de exibição
|
display-name | string |
display_name |
|
id
|
id | integer |
ID Interno Coupa |
|
nome
|
name | string |
Nome do fornecedor |
|
número
|
number | string |
Número do fornecedor |
|
estado
|
status | string |
Estado do fornecedor |
UsuárioSimples
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
active
|
active | boolean |
Ativo\Inativo |
|
grupos de aprovação
|
approval-groups | array of UserGroup | |
|
tipo de segurança de grupo empresarial
|
business-group-security-type | integer |
business_group_security_type |
|
grupos de conteúdo
|
content-groups | array of BusinessGroup | |
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
e-mail
|
string |
|
|
|
login
|
login | string |
número de funcionário |
|
nome completo
|
fullname | string |
nome completo |
|
id
|
id | integer |
Identificador único Coupa |
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
grupos-utilizadores
|
user-groups | array of UserGroup |
Grupo de usuários
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
active
|
active | boolean |
Active |
|
pode aprovar
|
can-approve | boolean |
O grupo de usuários tem a capacidade de ser um aprovador |
|
grupos de conteúdo
|
content-groups | array of BusinessGroup | |
|
descrição
|
description | string |
Description |
|
id
|
id | integer |
Identificador único Coupa |
Grupo Empresarial
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
descrição
|
description | string |
descrição |
|
id
|
id | integer |
Identificador único Coupa |
|
nome
|
name | string |
nome |
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
Mercadoria
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
active
|
active | boolean |
Ativo\Inativo |
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
id
|
id | integer |
Identificador único Coupa |
|
nome
|
name | string |
nome |
|
atualizado-em
|
updated-at | date-time |
atualizado-em |
Item
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome do item |
|
descrição
|
description | string |
Discipção do item |
|
número-artigo
|
item-number | string |
Número de item exclusivo |
|
active
|
active | boolean |
Ativo\Inativo |
|
Mercadoria
|
commodity | Commodity | |
|
UOM
|
uom | Uom | |
|
id
|
id | integer |
Identificador único Coupa |
|
imagem-url
|
image-url | string |
URL para a imagem do item (será copiado para o Coupa na criação/atualização do item) |
Uom
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
nome |
|
código
|
code | string |
código |
|
active
|
active | boolean |
Ativo\Inativo |
|
id
|
id | integer |
Identificador único Coupa |
FornecedorItem
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Preço
|
price | string |
Preço |
|
moeda
|
currency | Currency | |
|
contrato
|
contract | Contract | |
|
Vigência do contrato
|
contract-term | ContractTerm | |
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
item
|
item | Item | |
|
id
|
id | integer |
Identificador único Coupa |
|
prazo de execução
|
lead-time | integer |
lead_time |
|
fabricante
|
manufacturer | string |
fabricante |
|
quantidade mínima de encomenda
|
minimum-order-quantity | string |
minimum_order_quantity |
|
incremento de ordem
|
order-increment | string |
order_increment |
|
preço-nível-1
|
price-tier-1 | string |
price_tier_1 |
|
preço-nível-2
|
price-tier-2 | string |
price_tier_2 |
|
preço-nível-3
|
price-tier-3 | string |
price_tier_3 |
|
fornecedor
|
supplier | Supplier | |
|
preferido
|
preferred | boolean |
Indica o fornecedor preferido para este item |
|
fornecedor-aux-part-num
|
supplier-aux-part-num | string |
supplier_aux_part_num |
|
fornecedor-part-num
|
supplier-part-num | string |
supplier_part_num |
|
Código UNSPSC
|
unspsc-code | string |
Código UNSPSC |
IntegrationRun
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
Identificador único Coupa |
|
Integração
|
integration | Integration | |
|
Erros de integração
|
integration-errors | array of IntegrationError | |
|
Registos processados
|
records-processed | integer |
records_processed |
|
hora de início
|
start-time | string |
hora_de_início |
|
estado
|
status | string |
Status da transação |
|
Registos totais
|
total-records | integer |
total_records |
|
atualizado-em
|
updated-at | date-time |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
IntegrationError
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
contato-alerta-tipo
|
contact-alert-type | string |
contact_alert_type |
|
criado por
|
created-by | UserSimple | |
|
método de criação
|
creation-method | string |
creation_method |
|
ID do documento
|
document-id | integer |
document_id |
|
estado-documento
|
document-status | string |
document_status |
|
tipo de documento
|
document-type | string |
document_type |
|
id
|
id | integer |
Identificador único Coupa |
|
integração-nome do ficheiro
|
integration-filename | string |
nome do arquivo associado ao erro de integração |
|
estado
|
status | string |
Status da transação |
|
atualizado-em
|
updated-at | date-time |
Criado automaticamente por Coupa |
|
atualizado-por
|
updated-by | UserSimple |
Integration
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
objeto de negócio
|
business-object | string |
Objeto de Negócio |
|
código
|
code | string |
Código de integração único |
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
direção
|
direction | string |
Direction |
|
sistema-final
|
end-system | string |
Sistema Final |
|
tipo de sistema final
|
end-system-type | string |
Tipo de sistema final |
|
id
|
id | integer |
Identificador único Coupa |
|
nome
|
name | string |
Nome da integração |
|
norma
|
standard | boolean |
Standard |
Linha de Encomenda
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
conta
|
account | Account | |
|
contabilística-total
|
accounting-total | number |
accounting_total |
|
attachments
|
attachments | array of Attachments | |
|
Mercadoria
|
commodity | Commodity | |
|
contrato
|
contract | Contract | |
|
descrição
|
description | string |
descrição |
|
id
|
id | integer |
Identificador único Coupa |
|
faturado
|
invoiced | number |
faturado |
|
item
|
item | Item | |
|
núm-linha
|
line-num | string |
line_num |
|
ordem-cabeçalho-id
|
order-header-id | integer |
order_header_id |
|
Preço
|
price | number |
Preço |
|
quantidade
|
quantity | number |
quantidade |
|
recebido
|
received | string |
Quantidade/Montante recebido |
|
solicitante
|
requester | UserSimple | |
|
fonte-part-num
|
source-part-num | string |
source_part_num |
|
estado
|
status | string |
Status da transação |
|
fornecedor
|
supplier | Supplier | |
|
total
|
total | number |
total |
|
tipo
|
type | string |
tipo |
|
UOM
|
uom | Uom |
InventárioTransação
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
conta
|
account | Account | |
|
attachments
|
attachments | array of Attachments | |
|
id
|
id | integer |
ID da Transação de Inventário Interno da Coupa |
|
item
|
item | Item | |
|
linha de ordem
|
order-line | OrderLine | |
|
Preço
|
price | number |
Preço do Item |
|
quantidade
|
quantity | number |
Quantidade do recibo |
|
recibo
|
receipt | Receipt | |
|
solicitante
|
requester | UserSimple | |
|
estado
|
status | string |
Status da transação de estoque |
|
total
|
total | number |
Total de Recibos |
|
data da transação
|
transaction-date | date-time |
Data real da transação |
|
tipo
|
type | string |
Tipo de transação de inventário |
|
UOM
|
uom | Uom | |
|
atualizado-em
|
updated-at | date-time |
Tempo de Atualização da Transação de Inventário |
Account
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo de conta
|
account-type | AccountType | |
|
ID do tipo de conta
|
account-type-id | integer |
ID do tipo de conta |
|
active
|
active | boolean |
Sinalizador Ativo\Inativo |
|
código
|
code | string |
Todos os segmentos concatenados com um hífen ( - ) |
|
criado-AT
|
created-at | string |
AAAA-MM-DDTHH:MM:SS+HH:MMZ |
|
criado por
|
created-by | UserSimple | |
|
id
|
id | integer |
Identificador único Coupa |
|
nome
|
name | string |
Este é o apelido da conta. |
|
segmento-1
|
segment-1 | string |
Cada segmento representa o segmento do código da conta |
|
segmento-2
|
segment-2 | string |
Cada segmento representa o segmento do código da conta |
|
segmento-3
|
segment-3 | string |
Cada segmento representa o segmento do código da conta |
|
segmento-4
|
segment-4 | string |
Cada segmento representa o segmento do código da conta |
|
segmento-5
|
segment-5 | string |
Cada segmento representa o segmento do código da conta |
|
segmento-6
|
segment-6 | string |
Cada segmento representa o segmento do código da conta |
|
atualizado-por
|
updated-by | UserSimple |
Tipo de Conta
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
active
|
active | boolean |
Um valor falso inativará o COA |
|
moeda
|
currency | Currency | |
|
id
|
id | integer |
Identificador único Coupa |
|
nome
|
name | string |
nome |
Receipt
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
criado-AT
|
created-at | string |
Criado automaticamente por Coupa no formato |
|
id
|
id | integer |
Identificador único Coupa |
|
quantidade
|
quantity | number |
quantidade |
|
data de receção
|
receipt-date | date-time |
receipt_date |
|
total
|
total | number |
total |
|
preço-unitário
|
unit-price | number |
preço do item de linha |
|
UOM
|
uom | Uom | |
|
atualizado-em
|
updated-at | date-time |
Criado automaticamente por Coupa no formato |
LookupValue
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
active
|
active | boolean |
Ativo\Inativo |
|
nome
|
name | string |
Nome do valor de pesquisa |
|
descrição
|
description | string |
Descrição do valor de pesquisa |
|
núm-ref-externo
|
external-ref-num | string |
Ref Num externo (valor real da conta quando utilizado na contabilidade) |
|
id
|
id | integer |
Identificador único Coupa |
|
é-padrão
|
is-default | boolean |
is_default |
|
procura
|
lookup | Lookup | |
|
ID de pesquisa
|
lookup-id | integer |
lookup_id |
Busca
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
active
|
active | boolean |
Sinalizador Ativo\Inativo |
|
descrição
|
description | string |
descrição |
|
id
|
id | integer |
Identificador único Coupa |
|
nome de nível 1
|
level-1-name | string |
level_1_name |
|
nome de nível 2
|
level-2-name | string |
level_2_name |
|
nome de nível 3
|
level-3-name | string |
level_3_name |
|
nome de nível 4
|
level-4-name | string |
level_4_name |
|
nome
|
name | string |
nome |
FormResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
Identificador único Coupa |
|
atualizado-em
|
updated-at | date-time |
Criado automaticamente por Coupa no formato AAAA-MM-DDTHH:MM:SS+HH:MMZ |