Versão Graph API

Extended Credit Allocation Config

Leitura

Represents a relationship between two business portfolio for the purpose of sharing credit line between them.

Exemplo

GET /v21.0/{extended-credit-allocation-config-id} HTTP/1.1
Host: graph.facebook.com

/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{extended-credit-allocation-config-id}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */

/* make the API call */
FB.api(
    "/{extended-credit-allocation-config-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{extended-credit-allocation-config-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{extended-credit-allocation-config-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

Se quiser saber como usar a Graph API, leia nosso guia sobre Como usar a Graph API.

Parâmetros

Este ponto de extremidade não tem nenhum parâmetro.

Campos

Campo	Descrição
`id` numeric string	ID Padrão
`currency_amount` CurrencyAmount	The currency amount this allocation is for. If amount is zero then this allocation could be inactive or simply an authorization. Default: 0
`liability_type` enum	The liability terms of this business relationship
`owning_business` Business	The business owning the credential that credit is being requested from
`owning_credential` ExtendedCredit	Extended credit object that will be providing credit
`partition_type` enum	Fixed partition or unrestricted credit partition
`receiving_business` Business	The business that will be receiving the allocation
`receiving_credential` ExtendedCredit	Extended credit object that will be receiving credit
`request_status` enum	If this allocation is pending acceptance from another party
`send_bill_to` enum	Determines where invoices are sent by default. This is an indication of who will receive invoices in this business relationship, but invoices can also be sent to separately configured email address. AGENCY will result in invoices sent to the receiving party while ADVERTISER will result in invoices sent to the owning party

Criando

You can make a POST request to owning_credit_allocation_configs edge from the following paths:

/{extended_credit_id}/owning_credit_allocation_configs

When posting to this edge, an ExtendedCreditAllocationConfig will be created.

Parâmetros

Parâmetro	Descrição
`amount` Positive float	The amount of this allocation. You should only set it if the credit allocation type is FIXED
`liability_type` enum {, Normal, Sequential, MSA}	The terms that will be applicable to ad account under the receiving party using this credit line. Sequential: https://www.facebook.com/legal/sequential_invoicing_terms, Normal: https://www.facebook.com/terms_ads_invoicing.php
`partition_type` enum {FIXED, AUTH, FIXED_WITHOUT_PARTITION}	Fixed partition or unrestricted credit partition
`receiving_business_id` numeric string or integer	The business that you are going to allocate credit to Obrigatório
`send_bill_to` enum {, Agency, Advertiser}	Whether invoices will by default go to the credit line owner or the receiving party. AGENCY will send to the receiving party, ADVERTISER to the owner

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.

Struct {

id: numeric string,

requires_additional_approval: enum,

}

Error Codes

Erro	Descrição
4000	A credit allocation already exists between your business and the designated business.
200	Permissions error
100	Invalid parameter

You can make a POST request to whatsapp_credit_sharing_and_attach edge from the following paths:

/{extended_credit_id}/whatsapp_credit_sharing_and_attach

When posting to this edge, an ExtendedCreditAllocationConfig will be created.

Parâmetros

Parâmetro Descrição

Parâmetro	Descrição
`waba_currency` string	The ISO-4217-3 currency code Obrigatório
`waba_id` numeric string or integer	Id of the WhatsApp Business Account you are sharing credit line with Obrigatório

waba_currency

string

The ISO-4217-3 currency code

Obrigatório

waba_id

numeric string or integer

Id of the WhatsApp Business Account you are sharing credit line with

Obrigatório

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.

Struct {

allocation_config_id: numeric string,

waba_id: numeric string,

}

Error Codes

Erro	Descrição
100	Invalid parameter
200	Permissions error
457	The session has an invalid origin

Atualizando

Não é possível executar esta operação neste ponto de extremidade.

Excluindo

You can dissociate an ExtendedCreditAllocationConfig from an ExtendedCreditAllocationConfig by making a DELETE request to /{extended_credit_allocation_config_id}/ExtendedCreditOwningCreditAllocationConfigs.

Parâmetros

Este ponto de extremidade não tem nenhum parâmetro.

Return Type

Struct {

success: bool,

}