Accounting Export Reports that can be consumed by 3rd Party accounting systems
API Support Group api@yellowdogsoftware.com
curl -i -X GET \ 'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/interfaces/thirdPartyCodes?Filter=string&OrderBy=string&PageNumber=0&PageSize=0' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
OK
A unique identifier for the TPCode Record
This is autogenerated by Yellow Dog on creation of the record.
The Type of code being entered. This should be titled specifically for the third party integrator in Pascal case.
A common way to type specifically is to prepend the Type with the name of the integration.
This will be displayed in the Interfaces tab under the Accounting/Other section as "Integration Name Tax Grouping"
Identifier used by the Integrator to match certain behavior on their side of the integration.
User friendly description that will be displayed to the user as part of a drop down box titled by the type
[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "string", "code": "string", "description": "string", "store": { … } } ]
Third Party Codes are configuration options exposed to the Yellow Dog Inventory user that allow for behavior changes for an item or a setting. A common use case is for managing what the tax code might be for a particular item so that the integration is able to associate the proper tax rate on sale of the item.
[ { "type": "IntegrationNameTaxGrouping", // This will be displayed in the Interfaces tab under the Accounting/Other section as "Integration Name Tax Grouping" "code": "1", // Identifier used by the Integrator to match certain behavior on their side of the integration. "description": "local tax" // User friendly description that will be displayed to the user as part of a drop down box titled by the `type` "store": { "id": "123e4567-e89b-12d3-a456-426655440000" // Id of the store this Code should be active for. If this code should be active for all stores use an id value of "00000000-0000-0000-0000-000000000000" } } ]
If the third party integrator would like to allow enabling of true/false values for allowing Yellow Dog clients to enable item behavior in the integration, we recommend that this be accomplished by the following example.
[ { "type": "IntegrationNameIsModifier", "code": "true", "description": "Is a Modifier" "store": { "id": "123e4567-e89b-12d3-a456-426655440000" } }, { "type": "IntegrationNameIsModifier", "code": "false", "description": "Is not a modifier" "store": { "id": "123e4567-e89b-12d3-a456-426655440000" } } ]
A unique identifier for the TPCode Record
This is autogenerated by Yellow Dog on creation of the record.
The Type of code being entered. This should be titled specifically for the third party integrator in Pascal case.
A common way to type specifically is to prepend the Type with the name of the integration.
This will be displayed in the Interfaces tab under the Accounting/Other section as "Integration Name Tax Grouping"
Identifier used by the Integrator to match certain behavior on their side of the integration.
User friendly description that will be displayed to the user as part of a drop down box titled by the type
curl -i -X POST \ 'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/interfaces/thirdPartyCodes?suppressOutput=true' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json-patch+json' \ -d '[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "string", "code": "string", "description": "string", "store": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } } ]'
[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "string", "code": "string", "description": "string", "store": { … } } ]
A unique identifier for the TPCode Record
This is autogenerated by Yellow Dog on creation of the record.
The Type of code being entered. This should be titled specifically for the third party integrator in Pascal case.
A common way to type specifically is to prepend the Type with the name of the integration.
This will be displayed in the Interfaces tab under the Accounting/Other section as "Integration Name Tax Grouping"
Identifier used by the Integrator to match certain behavior on their side of the integration.
User friendly description that will be displayed to the user as part of a drop down box titled by the type
curl -i -X PUT \ 'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/interfaces/thirdPartyCodes?suppressOutput=true' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json-patch+json' \ -d '[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "string", "code": "string", "description": "string", "store": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } } ]'
Returns the updated ThirdPartyCodes, if suppressOutput parameter is set to false.
A unique identifier for the TPCode Record
This is autogenerated by Yellow Dog on creation of the record.
The Type of code being entered. This should be titled specifically for the third party integrator in Pascal case.
A common way to type specifically is to prepend the Type with the name of the integration.
This will be displayed in the Interfaces tab under the Accounting/Other section as "Integration Name Tax Grouping"
Identifier used by the Integrator to match certain behavior on their side of the integration.
User friendly description that will be displayed to the user as part of a drop down box titled by the type
[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "string", "code": "string", "description": "string", "store": { … } } ]
curl -i -X DELETE \ 'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/interfaces/thirdPartyCodes?suppressOutput=true' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json-patch+json' \ -d '[ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ]'
Rate limiting quota exceeded
Apply pause on further requests to the api using a wait method for the amount of seconds presented in the Response Header Key 'Retry-After'.
To prevent running into further instances of this rate limiting, use the Response Headers returned back from all other requests to ensure there is enough buffer.
For further information see Rate Limiting Section of Getting Started of api documentation site.
No response example
curl -i -X GET \ 'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/interfaces/thirdPartyCodes/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
OK
A unique identifier for the TPCode Record
This is autogenerated by Yellow Dog on creation of the record.
The Type of code being entered. This should be titled specifically for the third party integrator in Pascal case.
A common way to type specifically is to prepend the Type with the name of the integration.
This will be displayed in the Interfaces tab under the Accounting/Other section as "Integration Name Tax Grouping"
Identifier used by the Integrator to match certain behavior on their side of the integration.
User friendly description that will be displayed to the user as part of a drop down box titled by the type
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "string", "code": "string", "description": "string", "store": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "code": "string", "name": "string" } }
curl -i -X DELETE \ 'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/interfaces/thirdPartyCodes/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Rate limiting quota exceeded
Apply pause on further requests to the api using a wait method for the amount of seconds presented in the Response Header Key 'Retry-After'.
To prevent running into further instances of this rate limiting, use the Response Headers returned back from all other requests to ensure there is enough buffer.
For further information see Rate Limiting Section of Getting Started of api documentation site.
No response example