Marketing API
Graph API Version

Extended Credit Owning Credit Allocation Configs

Represents a credit line's credit allocation configurations. A new credit allocation configuration is created when you share and attach your credit line to a client's WhatsApp Business Account (WABA).

To find the extended credit ID, call https://graph.facebook.com/v25.0/{business_id}/extendedcredits?fields=id,legal_entity_name.

Reading

Used to retrieve all active credit sharing records for the inputted credit line ID, which includes, if applicable: the business that received credit, the ID of the credit line resulting from the credit sharing, and the amount of credit allocated to that business.

Example

Requirements

  • whatsapp_business_management permission

  • business_management permission

  • whatsapp_business_messaging permission

  • public_profile permission

  • EXTENDED CREDIT ID

  • USER ACCESS TOKEN

Request

curl -i -X GET \
 "https://graph.facebook.com/LATEST-VERSION/EXTENDED-CREDIT-ID/owning_credit_allocation_configs?
 access_token={USER-ACCESS-TOKEN}"
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{EXTENDED-CREDIT-ID}/owning_credit_allocation_configs",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{EXTENDED-CREDIT-ID}/owning_credit_allocation_configs"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

Response

{
  "data": [
  ]
}

Parameters

ParameterDescription
receiving_business_id
numeric string or integer

ID of the receiving business of the credit allocation config

Fields

Reading from this edge will return a JSON formatted result:

{
    "data": []
}

data

A list of ExtendedCreditAllocationConfig nodes.

Error Codes

ErrorDescription
100Invalid parameter
104Incorrect signature

Creating

You can make a POST request to owning_credit_allocation_configs edge from the following paths:
When posting to this edge, an ExtendedCreditAllocationConfig will be created.

Parameters

ParameterDescription
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

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

ErrorDescription
4000A credit allocation already exists between your business and the designated business.
200Permissions error
100Invalid parameter

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.