Represents a relationship between two business portfolio for the purpose of sharing credit line between them.
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
}];
Field | Description |
---|---|
id numeric string | ID |
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 | The business owning the credential that credit is being requested from |
owning_credential | Extended credit object that will be providing credit |
partition_type enum | Fixed partition or unrestricted credit partition |
receiving_business | The business that will be receiving the allocation |
receiving_credential | 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 |
Error | Description |
---|---|
100 | Invalid parameter |
owning_credit_allocation_configs
edge from the following paths: Parameter | Description |
---|---|
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 Required |
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 |
id
in the return type.id
: numeric string, requires_additional_approval
: enum, Error | Description |
---|---|
4000 | A credit allocation already exists between your business and the designated business. |
200 | Permissions error |
100 | Invalid parameter |
whatsapp_credit_sharing_and_attach
edge from the following paths: Parameter | Description |
---|---|
waba_currency string | The ISO-4217-3 currency code Required |
waba_id numeric string or integer | Id of the WhatsApp Business Account you are sharing credit line with Required |
id
in the return type.allocation_config_id
: numeric string, waba_id
: numeric string, Error | Description |
---|---|
100 | Invalid parameter |
200 | Permissions error |
/{extended_credit_allocation_config_id}/ExtendedCreditOwningCreditAllocationConfigs
.success
: bool,